joomla-framework / form

src/Form.php

Doc Comments +3 added lines, -3 removed lines

@@ -647,7 +647,7 @@ 
 	 *
 	 * @param   string  $name     The name of the field for which to get the value.
 	 * @param   string  $group    The optional dot-separated form group path on which to get the value.
-	 * @param   mixed   $default  The optional default value of the field value is empty.
+	 * @param   string   $default  The optional default value of the field value is empty.
 	 *
 	 * @return  mixed  The value of the field or the default value if empty.
 	 *
@@ -1126,7 +1126,7 @@ 
 	 * @param   string  $group  The optional dot-separated form group path on which to filter the
 	 *                          fields to be validated.
 	 *
-	 * @return  mixed  True on success.
+	 * @return  boolean  True on success.
 	 *
 	 * @since   1.0
 	 */
@@ -1519,7 +1519,7 @@ 
 	 * Method to get an array of <field /> elements from the form XML document which are
 	 * in a control group by name.
 	 *
-	 * @param   mixed    $group   The optional dot-separated form group path on which to find the fields.
+	 * @param   string|null    $group   The optional dot-separated form group path on which to find the fields.
 	 *                            Null will return all fields. False will return fields not in a group.
 	 * @param   boolean  $nested  True to also include fields in nested groups that are inside of the
 	 *                            group for which to find fields.

src/FormHelper.php

Doc Comments +4 added lines, -4 removed lines

@@ -44,7 +44,7 @@ 
 	 *
 	 * @param   string  $type  Type of a field whose class should be loaded.
 	 *
-	 * @return  mixed  Class name on success or false otherwise.
+	 * @return  string|false  Class name on success or false otherwise.
 	 *
 	 * @since   1.0
 	 */
@@ -60,7 +60,7 @@ 
 	 *
 	 * @param   string  $type  Type of a rule whose class should be loaded.
 	 *
-	 * @return  mixed  Class name on success or false otherwise.
+	 * @return  string|false  Class name on success or false otherwise.
 	 *
 	 * @since   1.0
 	 */
@@ -78,7 +78,7 @@ 
 	 * @param   string  $entity  One of the form entities (field or rule).
 	 * @param   string  $type    Type of an entity.
 	 *
-	 * @return  boolean|string  Class name on success or false otherwise.
+	 * @return  string|false  Class name on success or false otherwise.
 	 *
 	 * @since   1.0
 	 */
@@ -114,7 +114,7 @@ 
 	/**
 	 * Method to add a path to the list of form include paths.
 	 *
-	 * @param   mixed  $new  A path or array of paths to add.
+	 * @param   string  $new  A path or array of paths to add.
 	 *
 	 * @return  array  The list of paths that have been added.
 	 *

src/Html/Select.php

Doc Comments +5 added lines, -5 removed lines

@@ -107,7 +107,7 @@ 
 	 *                               set to null, the index of the value array is used.
 	 * @param   string   $optText    The name of the object variable for the option text.
 	 * @param   mixed    $selected   The key that is selected (accepts an array or a string).
-	 * @param   mixed    $idtag      Value of the field id or null by default
+	 * @param   string    $idtag      Value of the field id or null by default
 	 * @param   boolean  $translate  True to translate
 	 *
 	 * @return  string  HTML for the select list.
@@ -413,7 +413,7 @@ 
 	 *
 	 * @param   string   $value    The value of the option
 	 * @param   string   $text     The text for the option
-	 * @param   mixed    $optKey   If a string, the returned object property name for
+	 * @param   string    $optKey   If a string, the returned object property name for
 	 *                             the value. If an array, options. Valid options are:
 	 *                             attr: String|array. Additional attributes for this option.
 	 *                             Defaults to none.
@@ -435,7 +435,7 @@ 
 	 *                             parameter is ignored if an options array is passed.
 	 * @param   boolean  $disable  Not used.
 	 *
-	 * @return  object
+	 * @return  \stdClass
 	 *
 	 * @since   1.0
 	 */
@@ -696,10 +696,10 @@ 
 	/**
 	 * Generates an HTML radio list.
 	 *
-	 * @param   array    $data       An array of objects
+	 * @param   \stdClass[]    $data       An array of objects
 	 * @param   string   $name       The value of the HTML name attribute
 	 * @param   string   $attribs    Additional HTML attributes for the <select> tag
-	 * @param   mixed    $optKey     The key that is selected
+	 * @param   string    $optKey     The key that is selected
 	 * @param   string   $optText    The name of the object variable for the option value
 	 * @param   string   $selected   The name of the object variable for the option text
 	 * @param   boolean  $idtag      Value of the field id or null by default