Gets a value from the input data. Overridden to allow specifying a filter
mask.
| public get ( string $name, mixed $default = null, string $filter = 'cmd', integer $mask ) : mixed | ||
| $name | string | Name of the value to get. |
| $default | mixed | Default value to return if variable does not exist. |
| $filter | string | Filter to apply to the value. |
| $mask | integer | The filter mask |
| Результат | mixed | The filtered input value. |
/**
* @covers FOF30\Input\Input::get
* @covers FOF30\Input\Input::_cleanVar
*
* @dataProvider FOF30\Tests\Input\InputProvider::getTestGet
*/
public function testGet($key, $filter, $expected, $message)
{
$input = new Input(InputProvider::getSampleInputData());
$actual = $input->get($key, null, $filter);
$delta = 0.0;
if (in_array($filter, array('float', 'double'))) {
$delta = 1.0E-6;
}
$this->assertEquals($expected, $actual, $message, $delta);
}
/**
* This method will try retrieving a variable from the request (input) data.
*
* @param string $key The user state key for the variable
* @param string $request The request variable name for the variable
* @param Input $input The Input object with the request (input) data
* @param mixed $default The default value. Default: null
* @param string $type The filter type for the variable data. Default: none (no filtering)
* @param boolean $setUserState Should I set the user state with the fetched value?
*
* @see PlatformInterface::getUserStateFromRequest()
*
* @return mixed The value of the variable
*/
public function getUserStateFromRequest($key, $request, $input, $default = null, $type = 'none', $setUserState = true)
{
list($isCLI, $isAdmin) = $this->isCliAdmin();
unset($isAdmin);
// Just to make phpStorm happy
if ($isCLI) {
return $input->get($request, $default, $type);
}
$app = \JFactory::getApplication();
if (method_exists($app, 'getUserState')) {
$old_state = $app->getUserState($key, $default);
} else {
$old_state = null;
}
$cur_state = !is_null($old_state) ? $old_state : $default;
$new_state = $input->get($request, null, $type);
// Save the new value only if it was set in this request
if ($setUserState) {
if ($new_state !== null) {
$app->setUserState($key, $new_state);
} else {
$new_state = $cur_state;
}
} elseif (is_null($new_state)) {
$new_state = $cur_state;
}
return $new_state;
}
/**
* This method will try retrieving a variable from the request (input) data.
*
* @param string $key The user state key for the variable
* @param string $request The request variable name for the variable
* @param Input $input The Input object with the request (input) data
* @param mixed $default The default value. Default: null
* @param string $type The filter type for the variable data. Default: none (no filtering)
* @param boolean $setUserState Should I set the user state with the fetched value?
*
* @see F0FPlatformInterface::getUserStateFromRequest()
*
* @return mixed The value of the variable
*/
public function getUserStateFromRequest($key, $request, $input, $default = null, $type = 'none', $setUserState = true)
{
return $input->get($request, $default, $type);
}
