diff options
Diffstat (limited to 'includes/FormOptions.php')
| -rw-r--r-- | includes/FormOptions.php | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/includes/FormOptions.php b/includes/FormOptions.php index 33bbd86a..8477ed98 100644 --- a/includes/FormOptions.php +++ b/includes/FormOptions.php @@ -2,7 +2,7 @@ /** * Helper class to keep track of options when mixing links and form elements. * - * Copyright © 2008, Niklas Laxstiröm + * Copyright © 2008, Niklas Laxström * Copyright © 2011, Antoine Musso * * This program is free software; you can redistribute it and/or modify @@ -22,7 +22,7 @@ * * @file * @author Niklas Laxström - * @author Antoine Musso + * @author Antoine Musso */ /** @@ -83,6 +83,7 @@ class FormOptions implements ArrayAccess { * which will be assumed as INT if the data is an integer. * * @param $data Mixed: value to guess type for + * @throws MWException * @exception MWException Unsupported datatype * @return int Type constant */ @@ -103,8 +104,9 @@ class FormOptions implements ArrayAccess { /** * Verify the given option name exist. * - * @param $name String: option name + * @param string $name option name * @param $strict Boolean: throw an exception when the option does not exist (default false) + * @throws MWException * @return Boolean: true if option exist, false otherwise */ public function validateName( $name, $strict = false ) { @@ -121,7 +123,7 @@ class FormOptions implements ArrayAccess { /** * Use to set the value of an option. * - * @param $name String: option name + * @param string $name option name * @param $value Mixed: value for the option * @param $force Boolean: whether to set the value when it is equivalent to the default value for this option (default false). * @return null @@ -141,7 +143,7 @@ class FormOptions implements ArrayAccess { * Get the value for the given option name. * Internally use getValueReal() * - * @param $name String: option name + * @param string $name option name * @return Mixed */ public function getValue( $name ) { @@ -152,7 +154,7 @@ class FormOptions implements ArrayAccess { /** * @todo Document - * @param $option Array: array structure describing the option + * @param array $option array structure describing the option * @return Mixed. Value or the default value if it is null */ protected function getValueReal( $option ) { @@ -166,7 +168,7 @@ class FormOptions implements ArrayAccess { /** * Delete the option value. * This will make future calls to getValue() return the default value. - * @param $name String: option name + * @param string $name option name * @return null */ public function reset( $name ) { @@ -176,8 +178,9 @@ class FormOptions implements ArrayAccess { /** * @todo Document - * @param $name String: option name - * @return null + * @param string $name Option name + * @throws MWException If option does not exist. + * @return mixed Value or the default value if it is null. */ public function consumeValue( $name ) { $this->validateName( $name, true ); @@ -188,7 +191,7 @@ class FormOptions implements ArrayAccess { /** * @todo Document - * @param $names Array: array of option names + * @param array $names array of option names * @return null */ public function consumeValues( /*Array*/ $names ) { @@ -205,11 +208,12 @@ class FormOptions implements ArrayAccess { /** * Validate and set an option integer value - * The value will be altered to fit in the range. + * The value will be altered to fit in the range. * - * @param $name String: option name - * @param $min Int: minimum value - * @param $max Int: maximum value + * @param string $name option name + * @param int $min minimum value + * @param int $max maximum value + * @throws MWException * @exception MWException Option is not of type int * @return null */ |