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.php

    r128 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 Helpers class and associated 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 * 
     33 *  @package PHPonTrax 
     34 */ 
    2535class Helpers { 
    2636 
     37    /** 
     38     * 
     39     */ 
    2740    function __construct() { 
    2841        $this->controller_name = $GLOBALS['current_controller_name']; 
    … …  
    3144    } 
    3245 
     46    /** 
     47     * 
     48     */ 
    3349    function tag_options($options) { 
    3450        if(count($options)) { 
    … …  
    4359    } 
    4460 
    45     # Example: tag("br"); 
    46     # Results: <br /> 
    47     # Example: tag("input", array("type" => "text")); 
    48     # <input type="text" /> 
     61    /** 
     62     *  Generate an HTML or XML tag with optional attributes 
     63     * 
     64     *  Example: tag("br"); 
     65     *   Results: <br /> 
     66     *  Example: tag("input", array("type" => "text")); 
     67     * <input type="text" /> 
     68     */ 
    4969    function tag($name, $options = array(), $open = false) { 
    5070        $html = "<$name "; 
    … …  
    5474    } 
    5575 
    56     # Example: content_tag("p", "Hello world!"); 
    57     # Result: <p>Hello world!</p> 
    58     # Example: content_tag("div", content_tag("p", "Hello world!"), array("class" => "strong")) => 
    59     # Result:<div class="strong"><p>Hello world!</p></div> 
     76    /** 
     77     *  Generate an open/close pair of tags with content between 
     78     * 
     79     *  Example: content_tag("p", "Hello world!"); 
     80     *  Result: <p>Hello world!</p> 
     81     *  Example: content_tag("div", content_tag("p", "Hello world!"), array("class" => "strong")) => 
     82     *  Result:<div class="strong"><p>Hello world!</p></div> 
     83     */ 
    6084    function content_tag($name, $content, $options = array()) { 
    6185        $html .= "<$name "; 
    … …  
    6589    } 
    6690 
    67     # Returns the URL for the set of $options provided. 
     91    /** 
     92     *  Return the URL for the set of $options provided. 
     93     */ 
    6894    function url_for($options = array()) { 
    6995        $url_base = null; 
    … …  
    132158} 
    133159 
    134  
    135 ################################################################################################ 
    136 ## Avialble functions for use in views 
    137 ################################################################################################ 
     160/** 
     161 *  Avialble functions for use in views 
     162 */ 
    138163function content_tag() { 
    139164    $helper = new Helpers(); 
    … …  
    142167} 
    143168 
     169/** 
     170 * 
     171 */ 
    144172function url_for($options = array()) { 
    145173    $helper = new Helpers();