Show
Ignore:
Timestamp:
02/23/06 20:09:13 (6 years ago)
Author:
john
Message:

added in phpDoc commenting tests docs - Walt

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/trax/vendor/trax/action_view/helpers/url_helper.php

    r117 r138  
    11<?php 
    2 # $Id$ 
    3 # 
    4 # Copyright (c) 2005 John Peterson 
    5 # 
    6 # Permission is hereby granted, free of charge, to any person obtaining 
    7 # a copy of this software and associated documentation files (the 
    8 # "Software"), to deal in the Software without restriction, including 
    9 # without limitation the rights to use, copy, modify, merge, publish, 
    10 # distribute, sublicense, and/or sell copies of the Software, and to 
    11 # permit persons to whom the Software is furnished to do so, subject to 
    12 # the following conditions: 
    13 # 
    14 # The above copyright notice and this permission notice shall be 
    15 # included in all copies or substantial portions of the Software. 
    16 # 
    17 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
    18 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
    19 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
    20 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
    21 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
    22 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
    23 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
     2/** 
     3 *  File containing the UrlHelper class and support functions 
     4 * 
     5 *  (PHP 5) 
     6 * 
     7 *  @package PHPonTrax 
     8 *  @version $Id$ 
     9 *  @copyright (c) 2005 John Peterson 
     10 * 
     11 *  Permission is hereby granted, free of charge, to any person obtaining 
     12 *  a copy of this software and associated documentation files (the 
     13 *  "Software"), to deal in the Software without restriction, including 
     14 *  without limitation the rights to use, copy, modify, merge, publish, 
     15 *  distribute, sublicense, and/or sell copies of the Software, and to 
     16 *  permit persons to whom the Software is furnished to do so, subject to 
     17 *  the following conditions: 
     18 * 
     19 *  The above copyright notice and this permission notice shall be 
     20 *  included in all copies or substantial portions of the Software. 
     21 * 
     22 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
     23 *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
     24 *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
     25 *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 
     26 *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 
     27 *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 
     28 *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
     29 */ 
    2430 
     31/** 
     32 *  @todo Document this class 
     33 *  @package PHPonTrax 
     34 */ 
    2535class UrlHelper extends Helpers { 
    2636 
    27     # Creates a link tag of the given +name+ using an URL created by the set of +options+. 
    28     # It's also possible to pass a string instead of an options hash to 
    29     # get a link tag that just points without consideration. If null is passed as a name, the link itself will become the name. 
    30     # The $html_options have a special feature for creating javascript confirm alerts where if you pass ":confirm" => 'Are you sure?', 
    31     # the link will be guarded with a JS popup asking that question. If the user accepts, the link is processed, otherwise not. 
    32     # 
    33     # Example: 
    34     #   link_to("Delete this page", array(":action" => "delete", ":id" => $page->id), array(":confirm" => "Are you sure?")) 
     37    /** 
     38     * Creates a link tag of the given +name+ using an URL created by the set of +options+. 
     39     * It's also possible to pass a string instead of an options hash to 
     40     * get a link tag that just points without consideration. If null is passed as a name, the link itself will become the name. 
     41     * The $html_options have a special feature for creating javascript confirm alerts where if you pass ":confirm" => 'Are you sure?', 
     42     * the link will be guarded with a JS popup asking that question. If the user accepts, the link is processed, otherwise not. 
     43     * 
     44     * Example: 
     45     *   link_to("Delete this page", array(":action" => "delete", ":id" => $page->id), array(":confirm" => "Are you sure?")) 
     46     */ 
    3547    function link_to($name, $options = array(), $html_options = array()) { 
    3648        $html_options = $this->convert_confirm_option_to_javascript($html_options); 
    … …  
    6274    } 
    6375 
     76    /** 
     77     *  @todo Document this method 
     78     */ 
    6479    function convert_confirm_option_to_javascript($html_options) { 
    6580        if($html_options['confirm']) { 
    … …  
    7085    } 
    7186 
     87    /** 
     88     *  @todo Document this method 
     89     */ 
    7290    function convert_boolean_attributes(&$html_options, $bool_attrs) { 
    7391        foreach($bool_attrs as $x) { 
    … …  
    8098    } 
    8199 
     100    /** 
     101     *  @todo Document this method 
     102     */ 
    82103    function button_to($name, $options = array(), $html_options = null) { 
    83104        $html_options = (!is_null($html_options) ? $html_options : array()); 
    … …  
    97118    } 
    98119 
    99     # This tag is deprecated. Combine the link_to and AssetTagHelper::image_tag yourself instead, like: 
    100     #   link_to(image_tag("rss", :size => "30x45", :border => 0), "http://www.example.com") 
     120    /** 
     121     * This tag is deprecated. Combine the link_to and AssetTagHelper::image_tag yourself instead, like: 
     122     *   link_to(image_tag("rss", :size => "30x45", :border => 0), "http://www.example.com") 
     123     */ 
    101124    function link_image_to($src, $options = array(), $html_options = array(), $parameters_for_method_reference = array()) { 
    102125        $image_options = array("src" => (ereg("/", $src) ? $src : "/images/$src")); 
    … …  
    131154} 
    132155 
    133 ################################################################################################ 
    134 ## Avialble functions for use in views 
    135 ################################################################################################ 
     156/** 
     157 *  Avialble functions for use in views 
     158 *  @todo Document this function 
     159 */ 
    136160function link_to($name, $options = array(), $html_options = array()) { 
    137161    $url_helper = new UrlHelper();