FOF30\Platform\Joomla\Platform::getUserStateFromRequest PHP Méthode

getUserStateFromRequest() public méthode

This method will try retrieving a variable from the request (input) data.
See also: PlatformInterface::getUserStateFromRequest()
public getUserStateFromRequest ( string $key, string $request, Input $input, mixed $default = null, string $type = 'none', boolean $setUserState = true ) : mixed
$key string The user state key for the variable
$request string The request variable name for the variable
$input FOF30\Input\Input The Input object with the request (input) data
$default mixed The default value. Default: null
$type string The filter type for the variable data. Default: none (no filtering)
$setUserState boolean Should I set the user state with the fetched value?
Résultat 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;
    }

Usage Example

Exemple #1
0
 public function getUserStateFromRequest($key, $request, $input, $default = null, $type = 'none', $setUserState = true)
 {
     if (is_callable(static::$getUserStateFromRequest)) {
         return call_user_func_array(static::$getUserStateFromRequest, array($key, $request, $input, $default, $type, $setUserState));
     }
     return parent::getUserStateFromRequest($key, $request, $input, $default, $type, $setUserState);
 }