Class luya\admin\components\AdminUser

Inheritanceluya\admin\components\AdminUser » yii\web\User » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable
Available since version1.0.0
Source Code https://github.com/luyadev/luya-module-admin/blob/master/src/components/AdminUser.php

AdminUser Component.

The administration user Identity extends from {{yii\web\User}} in order to configure customized behaviors.

Public Properties

Hide inherited properties

Property Type Description Defined By
$absoluteAuthTimeout integer|null The number of seconds in which the user will be logged out automatically regardless of activity. yii\web\User
$absoluteAuthTimeoutParam string The session variable name used to store the value of absolute expiration timestamp of the authenticated state. yii\web\User
$acceptableRedirectTypes array MIME types for which this component should redirect to the $loginUrl. yii\web\User
$accessChecker yii\rbac\CheckAccessInterface|string|array|null The access checker object to use for checking access or the application component ID of the access checker. yii\web\User
$authKeyParam string The session variable name used to store authentication key. yii\web\User
$authTimeout integer|null The number of seconds in which the user will be logged out automatically if the user remains inactive. yii\web\User
$authTimeoutParam string The session variable name used to store the value of expiration timestamp of the authenticated state. yii\web\User
$autoRenewCookie boolean Whether to automatically renew the identity cookie each time a page is requested. yii\web\User
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$cookieLoginDuration integer The number of seconds the web cookie with auto login should be active luya\admin\components\AdminUser
$defaultLanguage string Variable to assign the default language from the admin module in order to set default language if not set. luya\admin\components\AdminUser
$enableAutoLogin boolean Whether to enable cookie-based login. luya\admin\components\AdminUser
$enableSession boolean Whether to use session to persist authentication status across multiple requests. yii\web\User
$id string|integer|null The unique identifier for the user. yii\web\User
$idParam string The session variable name used to store the value of $id. yii\web\User
$identity luya\admin\models\User The user identitity object. luya\admin\components\AdminUser
$identityClass string The class name of the $identity object. luya\admin\components\AdminUser
$identityCookie array The configuration of the identity cookie. luya\admin\components\AdminUser
$interfaceLanguage string luya\admin\components\AdminUser
$isGuest boolean Whether the current user is a guest. yii\web\User
$loginUrl string|array|null The URL for login when loginRequired() is called. luya\admin\components\AdminUser
$returnUrl string The URL that the user should be redirected to after login. yii\web\User
$returnUrlParam string The session variable name used to store the value of $returnUrl. yii\web\User

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\Component
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
can() Checks if the user can perform the operation as specified by the given permission. yii\web\User
canApi() Perform a can api match request for the logged in user if user is logged in, returns false otherwhise. luya\admin\components\AdminUser
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canRoute() Perform a can route auth request match for the logged in user if user is logged in, returns false otherwhise. luya\admin\components\AdminUser
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
checkRedirectAcceptable() Checks if the Accept header contains a content type that allows redirection to the login page. yii\web\User
className() Returns the fully qualified name of this class. yii\base\BaseObject
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getId() Returns a value that uniquely represents the user. yii\web\User
getIdentity() Returns the identity object associated with the currently logged-in user. yii\web\User
getInterfaceLanguage() Return the interface language for the given logged in user. luya\admin\components\AdminUser
getIsGuest() Returns a value indicating whether the user is a guest (not authenticated). yii\web\User
getReturnUrl() Returns the URL that the browser should be redirected to after successful login. yii\web\User
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the application component. luya\admin\components\AdminUser
login() Logs in a user. yii\web\User
loginByAccessToken() Logs in a user by the given access token. yii\web\User
loginRequired() Redirects the user browser to the login page. yii\web\User
logout() Logs out the current user. yii\web\User
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
onAfterLogin() After the login process of the user, set the admin interface language based on the user settings. luya\admin\components\AdminUser
onBeforeLogout() After loging out, the useronline status must be refreshed and the current user must be deleted from the user online list. luya\admin\components\AdminUser
setIdentity() Sets the user identity object. yii\web\User
setReturnUrl() Remembers the URL in the session so that it can be retrieved back later by getReturnUrl(). yii\web\User
switchIdentity() Switches to a new identity for the current user. yii\web\User
trigger() Triggers an event. yii\base\Component
uniqueHostVariable() luya\admin\components\AdminUser

Protected Methods

Hide inherited methods

Method Description Defined By
afterLogin() This method is called after the user is successfully logged in. yii\web\User
afterLogout() This method is invoked right after a user is logged out via logout(). yii\web\User
beforeLogin() This method is called before logging in a user. yii\web\User
beforeLogout() This method is invoked when calling logout() to log out a user. yii\web\User
getAccessChecker() Returns the access checker used for checking access. yii\web\User
getAuthManager() Returns auth manager associated with the user component. yii\web\User
getIdentityAndDurationFromCookie() Determines if an identity cookie has a valid format and contains a valid auth key. yii\web\User
loginByCookie() Logs in a user by cookie. yii\web\User
regenerateCsrfToken() Regenerates CSRF token yii\web\User
removeIdentityCookie() Removes the identity cookie. yii\web\User
renewAuthStatus() Updates the authentication status using the information from session and cookie. yii\web\User
renewIdentityCookie() Renews the identity cookie. yii\web\User
sendIdentityCookie() Sends an identity cookie. yii\web\User

Constants

Hide inherited constants

Constant Value Description Defined By
EVENT_AFTER_LOGIN 'afterLogin' yii\web\User
EVENT_AFTER_LOGOUT 'afterLogout' yii\web\User
EVENT_BEFORE_LOGIN 'beforeLogin' yii\web\User
EVENT_BEFORE_LOGOUT 'beforeLogout' yii\web\User

Property Details

Hide inherited properties

$cookieLoginDuration public property (available since version 3.0.0)

The number of seconds the web cookie with auto login should be active

public integer $cookieLoginDuration 2592000
$defaultLanguage public property

Variable to assign the default language from the admin module in order to set default language if not set.

public string $defaultLanguage null
$enableAutoLogin public property

Whether to enable cookie-based login. Defaults to false. Note that this property will be ignored if $enableSession is false.

public boolean $enableAutoLogin true
$identity public property

The user identitity object.

$identityClass public property

The class name of the $identity object.

public string $identityClass '\luya\admin\models\User'
$identityCookie public property

The configuration of the identity cookie. This property is used only when $enableAutoLogin is true.

public array $identityCookie = [
    
'name' => '_adminIdentity',
    
'httpOnly' => true,
]
$interfaceLanguage public property
public string $interfaceLanguage null
$loginUrl public property

The URL for login when loginRequired() is called. If an array is given, yii\web\UrlManager::createUrl() will be called to create the corresponding URL. The first element of the array should be the route to the login action, and the rest of the name-value pairs are GET parameters used to construct the login URL. For example,

['site/login', 'ref' => 1]

If this property is null, a 403 HTTP exception will be raised when loginRequired() is called.

public string|array|null $loginUrl = [
    
'/admin/login/index',
]

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

Defined in: yii\base\BaseObject::__construct()

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

            
__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
afterLogin() protected method

Defined in: yii\web\User::afterLogin()

This method is called after the user is successfully logged in.

The default implementation will trigger the EVENT_AFTER_LOGIN event. If you override this method, make sure you call the parent implementation so that the event is triggered.

protected void afterLogin ( $identity, $cookieBased, $duration )
$identity yii\web\IdentityInterface

The user identity information

$cookieBased boolean

Whether the login is cookie-based

$duration integer

Number of seconds that the user can remain in logged-in status. If 0, it means login till the user closes the browser or the session is manually destroyed.

                protected function afterLogin($identity, $cookieBased, $duration)
{
    $this->trigger(self::EVENT_AFTER_LOGIN, new UserEvent([
        'identity' => $identity,
        'cookieBased' => $cookieBased,
        'duration' => $duration,
    ]));
}

            
afterLogout() protected method

Defined in: yii\web\User::afterLogout()

This method is invoked right after a user is logged out via logout().

The default implementation will trigger the EVENT_AFTER_LOGOUT event. If you override this method, make sure you call the parent implementation so that the event is triggered.

protected void afterLogout ( $identity )
$identity yii\web\IdentityInterface

The user identity information

                protected function afterLogout($identity)
{
    $this->trigger(self::EVENT_AFTER_LOGOUT, new UserEvent([
        'identity' => $identity,
    ]));
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

The name of the behavior.

$behavior string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

return yii\base\Behavior

The behavior object

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

List of behaviors to be attached to the component

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeLogin() protected method

Defined in: yii\web\User::beforeLogin()

This method is called before logging in a user.

The default implementation will trigger the EVENT_BEFORE_LOGIN event. If you override this method, make sure you call the parent implementation so that the event is triggered.

protected boolean beforeLogin ( $identity, $cookieBased, $duration )
$identity yii\web\IdentityInterface

The user identity information

$cookieBased boolean

Whether the login is cookie-based

$duration integer

Number of seconds that the user can remain in logged-in status. If 0, it means login till the user closes the browser or the session is manually destroyed.

return boolean

Whether the user should continue to be logged in

                protected function beforeLogin($identity, $cookieBased, $duration)
{
    $event = new UserEvent([
        'identity' => $identity,
        'cookieBased' => $cookieBased,
        'duration' => $duration,
    ]);
    $this->trigger(self::EVENT_BEFORE_LOGIN, $event);
    return $event->isValid;
}

            
beforeLogout() protected method

Defined in: yii\web\User::beforeLogout()

This method is invoked when calling logout() to log out a user.

The default implementation will trigger the EVENT_BEFORE_LOGOUT event. If you override this method, make sure you call the parent implementation so that the event is triggered.

protected boolean beforeLogout ( $identity )
$identity yii\web\IdentityInterface

The user identity information

return boolean

Whether the user should continue to be logged out

                protected function beforeLogout($identity)
{
    $event = new UserEvent([
        'identity' => $identity,
    ]);
    $this->trigger(self::EVENT_BEFORE_LOGOUT, $event);
    return $event->isValid;
}

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return array

The behavior configurations.

                public function behaviors()
{
    return [];
}

            
can() public method

Defined in: yii\web\User::can()

Checks if the user can perform the operation as specified by the given permission.

Note that you must configure "authManager" application component in order to use this method. Otherwise it will always return false.

public boolean can ( $permissionName, $params = [], $allowCaching true )
$permissionName string

The name of the permission (e.g. "edit post") that needs access check.

$params array

Name-value pairs that would be passed to the rules associated with the roles and permissions assigned to the user.

$allowCaching boolean

Whether to allow caching the result of access check. When this parameter is true (default), if the access check of an operation was performed before, its result will be directly returned when calling this method to check the same operation. If this parameter is false, this method will always call yii\rbac\CheckAccessInterface::checkAccess() to obtain the up-to-date access result. Note that this caching is effective only within the same request and only works when $params = [].

return boolean

Whether the user can perform the operation as specified by the given permission.

                public function can($permissionName, $params = [], $allowCaching = true)
{
    if ($allowCaching && empty($params) && isset($this->_access[$permissionName])) {
        return $this->_access[$permissionName];
    }
    if (($accessChecker = $this->getAccessChecker()) === null) {
        return false;
    }
    $access = $accessChecker->checkAccess($this->getId(), $permissionName, $params);
    if ($allowCaching && empty($params)) {
        $this->_access[$permissionName] = $access;
    }
    return $access;
}

            
canApi() public method

Perform a can api match request for the logged in user if user is logged in, returns false otherwhise.

See the {{luya\admin\components\Auth::matchApi}} for details.

public boolean canApi ( $apiEndpoint, $typeVerification false )
$apiEndpoint string
$typeVerification string
return boolean

Whether the current user can request the provided api endpoint.

                public function canApi($apiEndpoint, $typeVerification = false)
{
    return !$this->isGuest && Yii::$app->auth->matchApi($this->getId(), $apiEndpoint, $typeVerification);
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canRoute() public method

Perform a can route auth request match for the logged in user if user is logged in, returns false otherwhise.

See the {{luya\admin\components\Auth::matchRoute}} for details.

public boolean canRoute ( $route )
$route string
return boolean

Whether the current user can request the provided route.

                public function canRoute($route)
{
    return !$this->isGuest && Yii::$app->auth->matchRoute($this->getId(), $route);
}

            
canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
checkRedirectAcceptable() public method (available since version 2.0.8)

Defined in: yii\web\User::checkRedirectAcceptable()

Checks if the Accept header contains a content type that allows redirection to the login page.

The login page is assumed to serve text/html or application/xhtml+xml by default. You can change acceptable content types by modifying $acceptableRedirectTypes property.

See also $acceptableRedirectTypes.

public boolean checkRedirectAcceptable ( )
return boolean

Whether this request may be redirected to the login page.

                public function checkRedirectAcceptable()
{
    $acceptableTypes = Yii::$app->getRequest()->getAcceptableContentTypes();
    if (empty($acceptableTypes) || (count($acceptableTypes) === 1 && array_keys($acceptableTypes)[0] === '*/*')) {
        return true;
    }
    foreach ($acceptableTypes as $type => $params) {
        if (in_array($type, $this->acceptableRedirectTypes, true)) {
            return true;
        }
    }
    return false;
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name string

The behavior's name.

return yii\base\Behavior|null

The detached behavior. Null if the behavior does not exist.

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
getAccessChecker() protected method (available since version 2.0.9)

Defined in: yii\web\User::getAccessChecker()

Returns the access checker used for checking access.

protected yii\rbac\CheckAccessInterface getAccessChecker ( )

                protected function getAccessChecker()
{
    return $this->accessChecker !== null ? $this->accessChecker : $this->getAuthManager();
}

            
getAuthManager() protected method (available since version 2.0.6)
Deprecated since version 2.0.9, to be removed in 2.1. Use getAccessChecker() instead.

Defined in: yii\web\User::getAuthManager()

Returns auth manager associated with the user component.

By default this is the authManager application component. You may override this method to return a different auth manager instance if needed.

protected yii\rbac\ManagerInterface getAuthManager ( )

                protected function getAuthManager()
{
    return Yii::$app->getAuthManager();
}

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name string

The behavior name

return yii\base\Behavior|null

The behavior object, or null if the behavior does not exist

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

List of behaviors attached to this component

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getId() public method

Defined in: yii\web\User::getId()

Returns a value that uniquely represents the user.

See also getIdentity().

public string|integer|null getId ( )
return string|integer|null

The unique identifier for the user. If null, it means the user is a guest.

                public function getId()
{
    $identity = $this->getIdentity();
    return $identity !== null ? $identity->getId() : null;
}

            
getIdentity() public method

Defined in: yii\web\User::getIdentity()

Returns the identity object associated with the currently logged-in user.

When $enableSession is true, this method may attempt to read the user's authentication data stored in session and reconstruct the corresponding identity object, if it has not done so before.

See also:

public yii\web\IdentityInterface|null getIdentity ( $autoRenew true )
$autoRenew boolean

Whether to automatically renew authentication status if it has not been done so before. This is only useful when $enableSession is true.

return yii\web\IdentityInterface|null

The identity object associated with the currently logged-in user. null is returned if the user is not logged in (not authenticated).

                public function getIdentity($autoRenew = true)
{
    if ($this->_identity === false) {
        if ($this->enableSession && $autoRenew) {
            try {
                $this->_identity = null;
                $this->renewAuthStatus();
            } catch (\Exception $e) {
                $this->_identity = false;
                throw $e;
            } catch (\Throwable $e) {
                $this->_identity = false;
                throw $e;
            }
        } else {
            return null;
        }
    }
    return $this->_identity;
}

            
getIdentityAndDurationFromCookie() protected method (available since version 2.0.9)

Defined in: yii\web\User::getIdentityAndDurationFromCookie()

Determines if an identity cookie has a valid format and contains a valid auth key.

This method is used when $enableAutoLogin is true. This method attempts to authenticate a user using the information in the identity cookie.

See also loginByCookie().

protected array|null getIdentityAndDurationFromCookie ( )
return array|null

Returns an array of 'identity' and 'duration' if valid, otherwise null.

                protected function getIdentityAndDurationFromCookie()
{
    $value = Yii::$app->getRequest()->getCookies()->getValue($this->identityCookie['name']);
    if ($value === null) {
        return null;
    }
    $data = json_decode($value, true);
    if (is_array($data) && count($data) == 3) {
        list($id, $authKey, $duration) = $data;
        /* @var $class IdentityInterface */
        $class = $this->identityClass;
        $identity = $class::findIdentity($id);
        if ($identity !== null) {
            if (!$identity instanceof IdentityInterface) {
                throw new InvalidValueException("$class::findIdentity() must return an object implementing IdentityInterface.");
            } elseif (!$identity->validateAuthKey($authKey)) {
                $ip = Yii::$app->getRequest()->getUserIP();
                Yii::warning("Invalid cookie auth key attempted for user '$id' from $ip: $authKey", __METHOD__);
            } else {
                return ['identity' => $identity, 'duration' => $duration];
            }
        }
    }
    $this->removeIdentityCookie();
    return null;
}

            
getInterfaceLanguage() public method

Return the interface language for the given logged in user.

public string getInterfaceLanguage ( )

                public function getInterfaceLanguage()
{
    return $this->getIsGuest() ? $this->defaultLanguage : $this->identity->setting->get('luyadminlanguage', $this->defaultLanguage);
}

            
getIsGuest() public method

Defined in: yii\web\User::getIsGuest()

Returns a value indicating whether the user is a guest (not authenticated).

See also getIdentity().

public boolean getIsGuest ( )
return boolean

Whether the current user is a guest.

                public function getIsGuest()
{
    return $this->getIdentity() === null;
}

            
getReturnUrl() public method

Defined in: yii\web\User::getReturnUrl()

Returns the URL that the browser should be redirected to after successful login.

This method reads the return URL from the session. It is usually used by the login action which may call this method to redirect the browser to where it goes after successful authentication.

See also loginRequired().

public string getReturnUrl ( $defaultUrl null )
$defaultUrl string|array|null

The default return URL in case it was not set previously. If this is null and the return URL was not set previously, yii\web\Application::$homeUrl will be redirected to. Please refer to setReturnUrl() on accepted format of the URL.

return string

The URL that the user should be redirected to after login.

                public function getReturnUrl($defaultUrl = null)
{
    $url = Yii::$app->getSession()->get($this->returnUrlParam, $defaultUrl);
    if (is_array($url)) {
        if (isset($url[0])) {
            return Yii::$app->getUrlManager()->createUrl($url);
        }
        $url = null;
    }
    return $url === null ? Yii::$app->getHomeUrl() : $url;
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name string

The event name

return boolean

Whether there is any handler attached to the event.

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

The property name