Class luya\web\GroupUser
Inheritance | luya\web\GroupUser » yii\web\User » yii\base\Component » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 1.0.0 |
Source Code | https://github.com/luyadev/luya/blob/master/core/web/GroupUser.php |
Group User Component.
User class to login based on {{yii\web\User}}, but allows you to check whether a user is in this group or not.
The {{luya\web\GroupUserIdentityInterface}} Interface must be implemented by the User Model used in {{yii\web\User::$identityClass}}.
Assume we have made 3 groups:
- group-a
- group-b
- group-c
And we assume we have different users login forms which have access only to the defined groups.
class app\UserCustomers implements GroupUserIdentityInterface
{
public function getGroups()
{
return ['group-a', 'group-c'];
}
}
class app\UserCompanys implements GroupUserIdentityInterface
{
public function getGroups()
{
return ['group-b'];
}
}
Lets perform the login on the IdentiyInterface base:
Yii::$app->user->login(\app\UserCompanys);
Lets say the validation of the UserCompanys was successfull based on the validation rules of the same class (IdentityInterface). Now we can quickly check if the the user is allowed in the current group:
if (Yii::$app->user->inGroup('group-b')) {
// this user can see those parts of the Website.
}
THE BELOW CODE REQUIRES IMPLEMENTATIONS FIRST AND IS STILL PART OF THE CONCEPT!
The above usecase is very straight forward in templates, a more common scenario are the useaccess of access restricting filters. The below example will show how action1 and action2 will have seperate allowed groups. while action3 can be access as guest. If there is no gues defined all actions which are not in the allowed list for the groups are denied automatically.
public function behaviors()
{
return [
'access' => [
'class' => 'authadmin\filters\GroupAuth',
'allow' => [
'action1' => ['group-b'],
'action2' => ['group-a', 'group-c'],
],
'guest' => ['action3'],
],
];
}
Another use case is to make sure some files are only by access by the allowed group, for this scenario. Therefore you can assign groups to a file which will be allowed to download/see this file. To make sure the defined group can acces the file is a global event which happens before file download, as the bootstrap proccess of luya modules can particpate on.
public function init()
{
parent::init();
Yii::$app->on(Admin::EVENT_BEFORE_FILE_DOWNLOAD, [$this, 'verifyUserGroup']);
}
public function verifyUserGroup($event)
{
$event->isValid = (!$event->hasPermissions() ||Â Yii::$app->user->inGroup($event->getFileGroups()));
}
Public 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 |
$enableAutoLogin | boolean | Whether to enable cookie-based login. | yii\web\User |
$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 | yii\web\IdentityInterface|null | The identity object associated with the currently logged-in user. | yii\web\User |
$identityClass | string | The class name of the $identity object. | yii\web\User |
$identityCookie | array | The configuration of the identity cookie. | yii\web\User |
$isGuest | boolean | Whether the current user is a guest. | yii\web\User |
$loginUrl | string|array|null | The URL for login when loginRequired() is called. | yii\web\User |
$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
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 |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
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 |
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 |
inGroup() | Checks whether a user exists for the provided group based on the GroupUserIdentityInterface implementation | luya\web\GroupUser |
init() | Initializes the application component. | yii\web\User |
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 |
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 |
Protected 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
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 |
Method Details
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()");
}
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;
}
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();
}
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);
}
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)
.
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;
}
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);
}
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)
.
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);
}
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,
]));
}
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,
]));
}
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);
}
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);
}
}
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;
}
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;
}
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 [];
}
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 |
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;
}
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;
}
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;
}
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;
}
::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();
}
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;
}
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);
}
}
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);
}
}
}
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();
}
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();
}
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;
}
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;
}
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 |
---|
public function getId()
{
$identity = $this->getIdentity();
return $identity !== null ? $identity->getId() : null;
}
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.
|
---|
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;
}
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;
}
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;
}
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;
}
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);
}
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 |
$checkBehaviors | boolean |
Whether to treat behaviors' methods as methods of this component |
return | boolean |
Whether the method is defined |
---|
public function hasMethod($name, $checkBehaviors = true)
{
if (method_exists($this, $name)) {
return true;
} elseif ($checkBehaviors) {
$this->ensureBehaviors();
foreach ($this->_behaviors as $behavior) {
if ($behavior->hasMethod($name)) {
return true;
}
}
}
return false;
}
Defined in: yii\base\Component::hasProperty()
Returns a value indicating whether a property is defined for this component.
A property is defined if:
- the class has a getter or 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 property of the given name (when
$checkBehaviors
is true).
See also:
public boolean hasProperty ( $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 is defined |
---|
public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}
Checks whether a user exists for the provided group based on the GroupUserIdentityInterface implementation
public boolean inGroup ( $alias ) | ||
$alias | string|array | |
throws | yii\base\InvalidConfigException |
---|
public function inGroup($alias)
{
if ($this->isGuest) {
return false;
}
$identity = $this->identity;
if (!$identity instanceof GroupUserIdentityInterface) {
throw new InvalidConfigException('The $identityClass must be instance of luya\web\GroupUserIdentityInterface.');
}
$groups = (array) $alias;
foreach ($groups as $groupAlias) {
if (in_array($groupAlias, $identity->authGroups())) {
return true;
}
}
return false;
}
Defined in: yii\web\User::init()
Initializes the application component.
public void init ( ) |
public function init()
{
parent::init();
if ($this->identityClass === null) {
throw new InvalidConfigException('User::identityClass must be set.');
}
if ($this->enableAutoLogin && !isset($this->identityCookie['name'])) {
throw new InvalidConfigException('User::identityCookie must contain the "name" element.');
}
if ($this->accessChecker !== null) {
$this->accessChecker = Instance::ensure($this->accessChecker, '\yii\rbac\CheckAccessInterface');
}
}
Defined in: yii\web\User::login()
Logs in a user.
After logging in a user:
- the user's identity information is obtainable from the $identity property
If $enableSession is true
:
- the identity information will be stored in session and be available in the next requests
- in case of
$duration == 0
: as long as the session remains active or till the user closes the browser - in case of
$duration > 0
: as long as the session remains active or as long as the cookie remains valid by it's$duration
in seconds when $enableAutoLogin is settrue
.
If $enableSession is false
:
- the
$duration
parameter will be ignored
public boolean login ( yii\web\IdentityInterface $identity, $duration = 0 ) | ||
$identity | yii\web\IdentityInterface |
The user identity (which should already be authenticated) |
$duration | integer |
Number of seconds that the user can remain in logged-in status, defaults to |
return | boolean |
Whether the user is logged in |
---|
public function login(IdentityInterface $identity, $duration = 0)
{
if ($this->beforeLogin($identity, false, $duration)) {
$this->switchIdentity($identity, $duration);
$id = $identity->getId();
$ip = Yii::$app->getRequest()->getUserIP();
if ($this->enableSession) {
$log = "User '$id' logged in from $ip with duration $duration.";
} else {
$log = "User '$id' logged in from $ip. Session not enabled.";
}
$this->regenerateCsrfToken();
Yii::info($log, __METHOD__);
$this->afterLogin($identity, false, $duration);
}
return !$this->getIsGuest();
}
Defined in: yii\web\User::loginByAccessToken()
Logs in a user by the given access token.
This method will first authenticate the user by calling yii\web\IdentityInterface::findIdentityByAccessToken() with the provided access token. If successful, it will call login() to log in the authenticated user. If authentication fails or login() is unsuccessful, it will return null.
public yii\web\IdentityInterface|null loginByAccessToken ( $token, $type = null ) | ||
$token | string |
The access token |
$type | mixed |
The type of the token. The value of this parameter depends on the implementation.
For example, yii\filters\auth\HttpBearerAuth will set this parameter to be |
return | yii\web\IdentityInterface|null |
The identity associated with the given access token. Null is returned if the access token is invalid or login() is unsuccessful. |
---|
public function loginByAccessToken($token, $type = null)
{
/* @var $class IdentityInterface */
$class = $this->identityClass;
$identity = $class::findIdentityByAccessToken($token, $type);
if ($identity && $this->login($identity)) {
return $identity;
}
return null;
}
Defined in: yii\web\User::loginByCookie()
Logs in a user by cookie.
This method attempts to log in a user using the ID and authKey information provided by the identity cookie.
protected void loginByCookie ( ) |
protected function loginByCookie()
{
$data = $this->getIdentityAndDurationFromCookie();
if (isset($data['identity'], $data['duration'])) {
$identity = $data['identity'];
$duration = $data['duration'];
if ($this->beforeLogin($identity, true, $duration)) {
$this->switchIdentity($identity, $this->autoRenewCookie ? $duration : 0);
$id = $identity->getId();
$ip = Yii::$app->getRequest()->getUserIP();
Yii::info("User '$id' logged in from $ip via cookie.", __METHOD__);
$this->afterLogin($identity, true, $duration);
}
}
}
Defined in: yii\web\User::loginRequired()
Redirects the user browser to the login page.
Before the redirection, the current URL (if it's not an AJAX url) will be kept as $returnUrl so that the user browser may be redirected back to the current page after successful login.
Make sure you set $loginUrl so that the user browser can be redirected to the specified login URL after calling this method.
Note that when $loginUrl is set, calling this method will NOT terminate the application execution.
public yii\web\Response loginRequired ( $checkAjax = true, $checkAcceptHeader = true ) | ||
$checkAjax | boolean |
Whether to check if the request is an AJAX request. When this is true and the request is an AJAX request, the current URL (for AJAX request) will NOT be set as the return URL. |
$checkAcceptHeader | boolean |
Whether to check if the request accepts HTML responses. Defaults to |
return | yii\web\Response |
The redirection response if $loginUrl is set |
---|---|---|
throws | yii\web\ForbiddenHttpException |
the "Access Denied" HTTP exception if $loginUrl is not set or a redirect is not applicable. |
public function loginRequired($checkAjax = true, $checkAcceptHeader = true)
{
$request = Yii::$app->getRequest();
$canRedirect = !$checkAcceptHeader || $this->checkRedirectAcceptable();
if ($this->enableSession
&& $request->getIsGet()
&& (!$checkAjax || !$request->getIsAjax())
&& $canRedirect
) {
$this->setReturnUrl($request->getAbsoluteUrl());
}
if ($this->loginUrl !== null && $canRedirect) {
$loginUrl = (array) $this->loginUrl;
if ($loginUrl[0] !== Yii::$app->requestedRoute) {
return Yii::$app->getResponse()->redirect($this->loginUrl);
}
}
throw new ForbiddenHttpException(Yii::t('yii', 'Login Required'));
}
Defined in: yii\web\User::logout()
Logs out the current user.
This will remove authentication-related session data.
If $destroySession
is true, all session data will be removed.
public boolean logout ( $destroySession = true ) | ||
$destroySession | boolean |
Whether to destroy the whole session. Defaults to true. This parameter is ignored if $enableSession is false. |
return | boolean |
Whether the user is logged out |
---|
public function logout($destroySession = true)
{
$identity = $this->getIdentity();
if ($identity !== null && $this->beforeLogout($identity)) {
$this->switchIdentity(null);
$id = $identity->getId();
$ip = Yii::$app->getRequest()->getUserIP();
Yii::info("User '$id' logged out from $ip.", __METHOD__);
if ($destroySession && $this->enableSession) {
Yii::$app->getSession()->destroy();
}
$this->afterLogout($identity);
}
return $this->getIsGuest();
}
Defined in: yii\base\Component::off()
Detaches an existing event handler from this component.
This method is the opposite of on().
Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.
See also on().
public boolean off ( $name, $handler = null ) | ||
$name | string |
Event name |
$handler | callable|null |
The event handler to be removed. If it is null, all handlers attached to the named event will be removed. |
return | boolean |
If a handler is found and detached |
---|
public function off($name, $handler = null)
{
$this->ensureBehaviors();
if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
return false;
}
if ($handler === null) {
unset($this->_events[$name], $this->_eventWildcards[$name]);
return true;
}
$removed = false;
// plain event names
if (isset($this->_events[$name])) {
foreach ($this->_events[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_events[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_events[$name] = array_values($this->_events[$name]);
return true;
}
}
// wildcard event names
if (isset($this->_eventWildcards[$name])) {
foreach ($this->_eventWildcards[$name] as $i => $event) {
if ($event[0] === $handler) {
unset($this->_eventWildcards[$name][$i]);
$removed = true;
}
}
if ($removed) {
$this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
// remove empty wildcards to save future redundant regex checks:
if (empty($this->_eventWildcards[$name])) {
unset($this->_eventWildcards[$name]);
}
}
}
return $removed;
}
Defined in: yii\base\Component::on()
Attaches an event handler to an event.
The event handler must be a valid PHP callback. The following are some examples:
function ($event) { ... } // anonymous function
[$object, 'handleClick'] // $object->handleClick()
['Page', 'handleClick'] // Page::handleClick()
'handleClick' // global function handleClick()
The event handler must be defined with the following signature,
function ($event)
where $event
is an yii\base\Event object which includes parameters associated with the event.
Since 2.0.14 you can specify event name as a wildcard pattern:
$component->on('event.group.*', function ($event) {
Yii::trace($event->name . ' is triggered.');
});
See also off().
public void on ( $name, $handler, $data = null, $append = true ) | ||
$name | string |
The event name |
$handler | callable |
The event handler |
$data | mixed |
The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data. |
$append | boolean |
Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list. |
public function on($name, $handler, $data = null, $append = true)
{
$this->ensureBehaviors();
if (strpos($name, '*') !== false) {
if ($append || empty($this->_eventWildcards[$name])) {
$this->_eventWildcards[$name][] = [$handler, $data];
} else {
array_unshift($this->_eventWildcards[$name], [$handler, $data]);
}
return;
}
if ($append || empty($this->_events[$name])) {
$this->_events[$name][] = [$handler, $data];
} else {
array_unshift($this->_events[$name], [$handler, $data]);
}
}
Defined in: yii\web\User::regenerateCsrfToken()
Regenerates CSRF token
protected void regenerateCsrfToken ( ) |
protected function regenerateCsrfToken()
{
$request = Yii::$app->getRequest();
if ($request->enableCsrfCookie || $this->enableSession) {
$request->getCsrfToken(true);
}
}
Defined in: yii\web\User::removeIdentityCookie()
Removes the identity cookie.
This method is used when $enableAutoLogin is true.
protected void removeIdentityCookie ( ) |
protected function removeIdentityCookie()
{
Yii::$app->getResponse()->getCookies()->remove(Yii::createObject(array_merge($this->identityCookie, [
'class' => 'yii\web\Cookie',
])));
}
Defined in: yii\web\User::renewAuthStatus()
Updates the authentication status using the information from session and cookie.
This method will try to determine the user identity using the $idParam session variable.
If $authTimeout is set, this method will refresh the timer.
If the user identity cannot be determined by session, this method will try to login by cookie if $enableAutoLogin is true.
protected void renewAuthStatus ( ) |
protected function renewAuthStatus()
{
$session = Yii::$app->getSession();
$id = $session->getHasSessionId() || $session->getIsActive() ? $session->get($this->idParam) : null;
if ($id === null) {
$identity = null;
} else {
/* @var $class IdentityInterface */
$class = $this->identityClass;
$identity = $class::findIdentity($id);
if ($identity === null) {
$this->switchIdentity(null);
}
}
if ($identity !== null) {
$authKey = $session->get($this->authKeyParam);
if ($authKey !== null && !$identity->validateAuthKey($authKey)) {
$identity = null;
$ip = Yii::$app->getRequest()->getUserIP();
Yii::warning("Invalid session auth key attempted for user '$id' from $ip: $authKey", __METHOD__);
}
}
$this->setIdentity($identity);
if ($identity !== null && ($this->authTimeout !== null || $this->absoluteAuthTimeout !== null)) {
$expire = $this->authTimeout !== null ? $session->get($this->authTimeoutParam) : null;
$expireAbsolute = $this->absoluteAuthTimeout !== null ? $session->get($this->absoluteAuthTimeoutParam) : null;
if ($expire !== null && $expire < time() || $expireAbsolute !== null && $expireAbsolute < time()) {
$this->logout(false);
} elseif ($this->authTimeout !== null) {
$session->set($this->authTimeoutParam, time() + $this->authTimeout);
}
}
if ($this->enableAutoLogin) {
if ($this->getIsGuest()) {
$this->loginByCookie();
} elseif ($this->autoRenewCookie) {
$this->renewIdentityCookie();
}
}
}
Defined in: yii\web\User::renewIdentityCookie()
Renews the identity cookie.
This method will set the expiration time of the identity cookie to be the current time plus the originally specified cookie duration.
protected void renewIdentityCookie ( ) |
protected function renewIdentityCookie()
{
$name = $this->identityCookie['name'];
$value = Yii::$app->getRequest()->getCookies()->getValue($name);
if ($value !== null) {
$data = json_decode($value, true);
if (is_array($data) && isset($data[2])) {
$cookie = Yii::createObject(array_merge($this->identityCookie, [
'class' => 'yii\web\Cookie',
'value' => $value,
'expire' => time() + (int) $data[2],
]));
Yii::$app->getResponse()->getCookies()->add($cookie);
}
}
}
Defined in: yii\web\User::sendIdentityCookie()
Sends an identity cookie.
This method is used when $enableAutoLogin is true. It saves $id, auth key, and the duration of cookie-based login information in the cookie.
See also loginByCookie().
protected void sendIdentityCookie ( $identity, $duration ) | ||
$identity | yii\web\IdentityInterface | |
$duration | integer |
Number of seconds that the user can remain in logged-in status. |
protected function sendIdentityCookie($identity, $duration)
{
$cookie = Yii::createObject(array_merge($this->identityCookie, [
'class' => 'yii\web\Cookie',
'value' => json_encode([
$identity->getId(),
$identity->getAuthKey(),
$duration,
], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE),
'expire' => time() + $duration,
]));
Yii::$app->getResponse()->getCookies()->add($cookie);
}
Defined in: yii\web\User::setIdentity()
Sets the user identity object.
Note that this method does not deal with session or cookie. You should usually use switchIdentity() to change the identity of the current user.
public void setIdentity ( $identity ) | ||
$identity | yii\web\IdentityInterface|null |
The identity object associated with the currently logged user. If null, it means the current user will be a guest without any associated identity. |
throws | yii\base\InvalidValueException |
if |
---|
public function setIdentity($identity)
{
if ($identity instanceof IdentityInterface) {
$this->_identity = $identity;
} elseif ($identity === null) {
$this->_identity = null;
} else {
throw new InvalidValueException('The identity object must implement IdentityInterface.');
}
$this->_access = [];
}
Defined in: yii\web\User::setReturnUrl()
Remembers the URL in the session so that it can be retrieved back later by getReturnUrl().
public void setReturnUrl ( $url ) | ||
$url | string|array |
The URL that the user should be redirected to after login. 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, and the rest of the name-value pairs are GET parameters used to construct the URL. For example,
|
public function setReturnUrl($url)
{
Yii::$app->getSession()->set($this->returnUrlParam, $url);
}
Defined in: yii\web\User::switchIdentity()
Switches to a new identity for the current user.
When $enableSession is true, this method may use session and/or cookie to store the user identity information,
according to the value of $duration
. Please refer to login() for more details.
This method is mainly called by login(), logout() and loginByCookie() when the current user needs to be associated with the corresponding identity information.
public void switchIdentity ( $identity, $duration = 0 ) | ||
$identity | yii\web\IdentityInterface|null |
The identity information to be associated with the current user. If null, it means switching the current user to be a guest. |
$duration | integer |
Number of seconds that the user can remain in logged-in status.
This parameter is used only when |
public function switchIdentity($identity, $duration = 0)
{
$this->setIdentity($identity);
if (!$this->enableSession) {
return;
}
/* Ensure any existing identity cookies are removed. */
if ($this->enableAutoLogin && ($this->autoRenewCookie || $identity === null)) {
$this->removeIdentityCookie();
}
$session = Yii::$app->getSession();
$session->regenerateID(true);
$session->remove($this->idParam);
$session->remove($this->authTimeoutParam);
$session->remove($this->authKeyParam);
if ($identity) {
$session->set($this->idParam, $identity->getId());
$session->set($this->authKeyParam, $identity->getAuthKey());
if ($this->authTimeout !== null) {
$session->set($this->authTimeoutParam, time() + $this->authTimeout);
}
if ($this->absoluteAuthTimeout !== null) {
$session->set($this->absoluteAuthTimeoutParam, time() + $this->absoluteAuthTimeout);
}
if ($this->enableAutoLogin && $duration > 0) {
$this->sendIdentityCookie($identity, $duration);
}
}
}
Defined in: yii\base\Component::trigger()
Triggers an event.
This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.
public void trigger ( $name, yii\base\Event $event = null ) | ||
$name | string |
The event name |
$event | yii\base\Event|null |
The event instance. If not set, a default yii\base\Event object will be created. |
public function trigger($name, Event $event = null)
{
$this->ensureBehaviors();
$eventHandlers = [];
foreach ($this->_eventWildcards as $wildcard => $handlers) {
if (StringHelper::matchWildcard($wildcard, $name)) {
$eventHandlers[] = $handlers;
}
}
if (!empty($this->_events[$name])) {
$eventHandlers[] = $this->_events[$name];
}
if (!empty($eventHandlers)) {
$eventHandlers = call_user_func_array('array_merge', $eventHandlers);
if ($event === null) {
$event = new Event();
}
if ($event->sender === null) {
$event->sender = $this;
}
$event->handled = false;
$event->name = $name;
foreach ($eventHandlers as $handler) {
$event->data = $handler[1];
call_user_func($handler[0], $event);
// stop further handling if the event is handled
if ($event->handled) {
return;
}
}
}
// invoke class-level attached handlers
Event::trigger($this, $name, $event);
}