Changeset 138 for trunk/trax/vendor/trax/action_view/helpers/form_helper.php

Timestamp:

02/23/06 20:09:13 (6 years ago)

Author:

john

Message:

added in phpDoc commenting tests docs - Walt

Files:

• trunk/trax/vendor/trax/action_view/helpers/form_helper.php (modified) (17 diffs)

trunk/trax/vendor/trax/action_view/helpers/form_helper.php

@@ -1 +1 @@
 <?php
-# $Id$
-#
-# Copyright (c) 2005 John Peterson
-#
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
+/**
+ *  File containing the FormHelper class
+ *
+ *  (PHP 5)
+ *
+ *  @package PHPonTrax
+ *  @version $Id$
+ *  @copyright (c) 2005 John Peterson
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining
+ *  a copy of this software and associated documentation files (the
+ *  "Software"), to deal in the Software without restriction, including
+ *  without limitation the rights to use, copy, modify, merge, publish,
+ *  distribute, sublicense, and/or sell copies of the Software, and to
+ *  permit persons to whom the Software is furnished to do so, subject to
+ *  the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+/**
+ *
+ *  @package PHPonTrax
+ */
 class FormHelper extends Helpers {
 
+    /**
+     *
+     */
     function __construct($object_name, $attribute_name) {
         parent::__construct();
@@ -35 +48 @@
     }
 
+    /**
+     *
+     */
     function value() {
         if(!$value = $_REQUEST[$this->object_name][$this->attribute_name]) {
@@ -45 +61 @@
     }
 
+    /**
+     *
+     */
     function object($object_name = null) {
         $object_name = $object_name ? $object_name : $this->object_name;
@@ -50 +69 @@
     }
 
+    /**
+     *
+     */
     function tag_name() {
         return "{$this->object_name}[{$this->attribute_name}]";
     }
 
+    /**
+     *
+     */
     function tag_name_with_index($index) {
         return "{$this->object_name}[{$index}][{$this->attribute_name}]";
     }
 
+    /**
+     *
+     */
     function tag_id() {
         return "{$this->object_name}_{$this->attribute_name}";
     }
 
+    /**
+     *
+     */
     function tag_id_with_index($index) {
         return "{$this->object_name}_{$index}_{$this->attribute_name}";
     }
 
+    /**
+     *
+     */
     function add_default_name_and_id($options) {
         if(array_key_exists("index", $options)) {
@@ -81 +115 @@
     }
 
+    /**
+     *
+     */
     function to_input_field_tag($field_type, $options = array()) {
         $default_size = $options["maxlength"] ? $options["maxlength"] : $this->default_field_options['size'];
@@ -96 +133 @@
     }
 
+    /**
+     *
+     */
     function to_radio_button_tag($tag_value, $options = array()) {
         $options = array_merge($this->default_radio_options, $options);
@@ -111 +151 @@
     }
 
+    /**
+     *
+     */
     function to_text_area_tag($options = array()) {
         if ($options["size"]) {
@@ -123 +166 @@
     }
 
+    /**
+     *
+     */
     function to_check_box_tag($options = array(), $checked_value = "1", $unchecked_value = "0") {
         $options["type"] = "checkbox";
@@ -153 +199 @@
     }
 
+    /**
+     *
+     */
     function to_boolean_select_tag($options = array()) {
         $options = $this->add_default_name_and_id($options);
@@ -179 +228 @@
 
 
-################################################################################################
-## Avialble functions for use in views
-################################################################################################
-# Example: text_field("post", "title");
-# Result: <input type="text" id="post_title" name="post[title]" value="$post->title" />
+/**
+ *  Avialble functions for use in views
+ *  Example: text_field("post", "title");
+ *  Result: <input type="text" id="post_title" name="post[title]" value="$post->title" />
+ */
 function text_field($object, $field, $options = array()) {
     $form = new FormHelper($object, $field);
@@ -189 +238 @@
 }
 
-# Works just like text_field, but returns a input tag of the "password" type instead.
-# Example: password_field("user", "password");
-# Result: <input type="password" id="user_password" name="user[password]" value="$user->password" />
+/**
+ *  Works just like text_field, but returns a input tag of the "password" type instead.
+ * Example: password_field("user", "password");
+ *  Result: <input type="password" id="user_password" name="user[password]" value="$user->password" />
+ */
 function password_field($object, $field, $options = array()) {
     $form = new FormHelper($object, $field);
@@ -197 +248 @@
 }
 
-# Works just like text_field, but returns a input tag of the "hidden" type instead.
-# Example: hidden_field("post", "title");
-# Result: <input type="hidden" id="post_title" name="post[title]" value="$post->title" />
+/**
+ *  Works just like text_field, but returns a input tag of the "hidden" type instead.
+ *  Example: hidden_field("post", "title");
+ *  Result: <input type="hidden" id="post_title" name="post[title]" value="$post->title" />
+ */
 function hidden_field($object, $field, $options = array()) {
     $form = new FormHelper($object, $field);
@@ -205 +258 @@
 }
 
-# Works just like text_field, but returns a input tag of the "file" type instead, which won't have any default value.
+/**
+ * Works just like text_field, but returns a input tag of the "file" type instead, which won't have any default value.
+ */
 function file_field($object, $field, $options = array()) {
     $form = new FormHelper($object, $field);
@@ -211 +266 @@
 }
 
-# Example: text_area("post", "body", array("cols" => 20, "rows" => 40));
-# Result: <textarea cols="20" rows="40" id="post_body" name="post[body]">$post->body</textarea>
+/**
+ *  Example: text_area("post", "body", array("cols" => 20, "rows" => 40));
+ *  Result: <textarea cols="20" rows="40" id="post_body" name="post[body]">$post->body</textarea>
+ */
 function text_area($object, $field, $options = array()) {
     $form = new FormHelper($object, $field);
@@ -218 +275 @@
 }
 
-# Returns a checkbox tag tailored for accessing a specified attribute (identified by $field) on an object
-# assigned to the template (identified by $object). It's intended that $field returns an integer and if that
-# integer is above zero, then the checkbox is checked. Additional $options on the input tag can be passed as an
-# array with $options. The $checked_value defaults to 1 while the default $unchecked_value
-# is set to 0 which is convenient for boolean values. Usually unchecked checkboxes don't post anything.
-# We work around this problem by adding a hidden value with the same name as the checkbox.
+/**
+ * Returns a checkbox tag tailored for accessing a specified attribute (identified by $field) on an object
+ * assigned to the template (identified by $object). It's intended that $field returns an integer and if that
+ * integer is above zero, then the checkbox is checked. Additional $options on the input tag can be passed as an
+ * array with $options. The $checked_value defaults to 1 while the default $unchecked_value
+ * is set to 0 which is convenient for boolean values. Usually unchecked checkboxes don't post anything.
+ * We work around this problem by adding a hidden value with the same name as the checkbox.
 #
-# Example: Imagine that $post->validated is 1:
-#   check_box("post", "validated");
-# Result:
-#   <input type="checkbox" id="post_validate" name="post[validated] value="1" checked="checked" />
-#   <input name="post[validated]" type="hidden" value="0" />
+ * Example: Imagine that $post->validated is 1:
+ *   check_box("post", "validated");
+ * Result:
+ *   <input type="checkbox" id="post_validate" name="post[validated] value="1" checked="checked" />
+ *   <input name="post[validated]" type="hidden" value="0" />
 #
-# Example: Imagine that $puppy->gooddog is no:
-#   check_box("puppy", "gooddog", array(), "yes", "no");
-# Result:
-#     <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog] value="yes" />
-#     <input name="puppy[gooddog]" type="hidden" value="no" />
+ * Example: Imagine that $puppy->gooddog is no:
+ *   check_box("puppy", "gooddog", array(), "yes", "no");
+ * Result:
+ *     <input type="checkbox" id="puppy_gooddog" name="puppy[gooddog] value="yes" />
+ *     <input name="puppy[gooddog]" type="hidden" value="no" />
+*/
 function check_box($object, $field, $options = array(), $checked_value = "1", $unchecked_value = "0") {
     $form = new FormHelper($object, $field);
@@ -241 +300 @@
 }
 
-# Returns a radio button tag for accessing a specified attribute (identified by $field) on an object
-# assigned to the template (identified by $object). If the current value of $field is $tag_value the
-# radio button will be checked. Additional $options on the input tag can be passed as a
-# hash with $options.
-# Example: Imagine that $post->category is "trax":
-#   radio_button("post", "category", "trax");
-#   radio_button("post", "category", "java");
-# Result:
-#     <input type="radio" id="post_category" name="post[category] value="trax" checked="checked" />
-#     <input type="radio" id="post_category" name="post[category] value="java" />
+/**
+ * Returns a radio button tag for accessing a specified attribute (identified by $field) on an object
+ * assigned to the template (identified by $object). If the current value of $field is $tag_value the
+ * radio button will be checked. Additional $options on the input tag can be passed as a
+ * hash with $options.
+ * Example: Imagine that $post->category is "trax":
+ *   radio_button("post", "category", "trax");
+ *   radio_button("post", "category", "java");
+ * Result:
+ *     <input type="radio" id="post_category" name="post[category] value="trax" checked="checked" />
+ *     <input type="radio" id="post_category" name="post[category] value="java" />
+*/
 function radio_button($object, $field, $tag_value, $options = array()) {
     $form = new FormHelper($object, $field);
@@ -256 +317 @@
 }
 
+/**
+ *
+ */
 function boolean_select($object, $field, $options = array()) {
     $form = new FormHelper($object, $field);