PHP Class Input, newscoop

Mostra file Open project: sourcefabric/newscoop Class Usage Examples

Public Methods

Method Description
CleanMagicQuotes ( array $p_array ) : array Please see: {@link http://ca.php.net/manual/en/function.get-magic-quotes-gpc.php this PHP.net page specifically the user note by php at kaiundina dot de}, for why this is so complicated.
Get ( string $p_varName, string $p_type = 'string', mixed $p_defaultValue = null, boolean $p_errorsOk = false ) : mixed Get an input value from the $_REQUEST array and check its type.
GetErrorString ( ) : string Return a default error string.
GetMethod ( ) : string Returns the method used to read the input data: GET, POST etc.
GetVar ( $p_varName, $p_type = 'string', $p_defaultValue = null, $p_errorsOk = false ) Get an input value from the $_REQUEST array and check its type.
IsValid ( ) : boolean Return FALSE if any calls to Input::Get() resulted in an error.

Method Details

CleanMagicQuotes() public static method

Please see: {@link http://ca.php.net/manual/en/function.get-magic-quotes-gpc.php this PHP.net page specifically the user note by php at kaiundina dot de}, for why this is so complicated.
public static CleanMagicQuotes ( array $p_array ) : array
$p_array array
return array

Get() public static method

The default value is returned if the value is not defined in the $_REQUEST array, or if the value does not match the required type. The type 'checkbox' is special - you cannot specify a default value for this. The return value will be TRUE or FALSE, but you can change this by specifying 'numeric' as the 3rd parameter in which case it will return '1' or '0'. Use Input::IsValid() to check if any errors were generated.
public static Get ( string $p_varName, string $p_type = 'string', mixed $p_defaultValue = null, boolean $p_errorsOk = false ) : mixed
$p_varName string The index into the $_REQUEST array.
$p_type string The type of data expected; can be: "int" "string" "array" "checkbox" "boolean" Default is 'string'.
$p_defaultValue mixed The default value to return if the value is not defined in the $_REQUEST array, or if the value does not match the required type.
$p_errorsOk boolean Set to true to ignore any errors for this variable (i.e. Input::IsValid() will still return true even if there are errors for this varaible).
return mixed

GetErrorString() public static method

Return a default error string.
public static GetErrorString ( ) : string
return string

GetMethod() public static method

Returns the method used to read the input data: GET, POST etc.
public static GetMethod ( ) : string
return string

GetVar() public static method

This is a wrapper for Input::Get().
public static GetVar ( $p_varName, $p_type = 'string', $p_defaultValue = null, $p_errorsOk = false )

IsValid() public static method

Return FALSE if any calls to Input::Get() resulted in an error.
public static IsValid ( ) : boolean
return boolean