Claro_Input Interface Reference
Inheritance diagram for Claro_Input:
Public Member Functions | |
| get ($name, $default=null) | |
| getMandatory ($name) | |
Detailed Description
Defines the required methods for a data input object
Definition at line 30 of file input.lib.php.
Member Function Documentation
| get | ( | $ | name, | |
| $ | default = null | |||
| ) |
Get a value given its name
- Parameters:
-
string $name variable name mixed $default default value (if $name is missingin the input)
- Returns:
- mixed value of $name in input data or $default value
- Exceptions:
-
Claro_Input_Exception on failure
Implemented in Claro_Input_Array, and Claro_Input_Validator.
| getMandatory | ( | $ | name | ) |
Get a value given its name, the value must be set in the data but can be empty
- Parameters:
-
string $name variable name
- Returns:
- mixed value of $name
- Exceptions:
-
Claro_Input_Exception on failure or if $name is missing
Implemented in Claro_Input_Array, and Claro_Input_Validator.
The documentation for this interface was generated from the following file:
- claroline/claroline/inc/lib/utils/input.lib.php
