AuthMethod

API reference › yii › filters › auth › AuthMethod

abstract class	`yii\filters\auth\AuthMethod`
Extends	`yii\base\ActionFilter` » `yii\base\Behavior` » `yii\base\BaseObject`
Implements	`AuthInterface`, `yii\base\Configurable`
Since	2.0
Source	`framework/filters/auth/AuthMethod.php`

4 subclasses

AuthMethod is a base class implementing the AuthInterface interface.

Properties

Property	Type	Description	Defined by
`$except`	`array`	List of action IDs that this filter should not apply to. Default: `[]`.	`yii\base\ActionFilter`
`$only`	`array`	List of action IDs that this filter should apply to. Default: `[]`.	`yii\base\ActionFilter`
`$optional`	`array`	List of action IDs that this filter will be applied to, but auth failure will not lead to error. Default: `[]`. Available since 2.0.7.	`AuthMethod`
`$owner`	`yii\base\T\|null`	The owner of this behavior Default: `null`.	`yii\base\Behavior`
`$request`	`yii\web\Request\|null`	The current request. Default: `null`.	`AuthMethod`
`$response`	`yii\web\Response\|null`	The response to be sent. Default: `null`.	`AuthMethod`
`$user`	`yii\web\User\|null`	The user object representing the user authentication status. Default: `null`.	`AuthMethod`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\BaseObject`
`__get()`	Returns the value of an object property.	`yii\base\BaseObject`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\BaseObject`
`__set()`	Sets value of an object property.	`yii\base\BaseObject`
`__unset()`	Sets an object property to null.	`yii\base\BaseObject`
`afterAction()`	This method is invoked right after an action is executed.	`yii\base\ActionFilter`
`afterFilter()`		`yii\base\ActionFilter`
`attach()`	Attaches the behavior object to the component.	`yii\base\ActionFilter`
`authenticate()` abstract	Authenticates the current user.	`AuthInterface`
`beforeAction()`	This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.	`AuthMethod`
`beforeFilter()`		`yii\base\ActionFilter`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\BaseObject`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\BaseObject`
`challenge()`	Generates challenges upon authentication failure.	`AuthMethod`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`detach()`	Detaches the behavior object from the component.	`yii\base\ActionFilter`
`events()`	Declares event handlers for the `$owner`’s events.	`yii\base\Behavior`
`handleFailure()`	Handles authentication failure.	`AuthMethod`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\BaseObject`
`hasProperty()`	Returns a value indicating whether a property is defined.	`yii\base\BaseObject`
`init()`	Initializes the object.	`yii\base\BaseObject`
`getActionId()` protected	Returns an action ID by converting `Action::$uniqueId` into an ID relative to the module.	`yii\base\ActionFilter`
`isActive()` protected	Returns a value indicating whether the filter is active for the given action.	`yii\base\ActionFilter`
`isOptional()` protected	Checks, whether authentication is optional for the given action.	`AuthMethod`

Property details

$optional

public array $optional = []

List of action IDs that this filter will be applied to, but auth failure will not lead to error.

It may be used for actions, that are allowed for public, but return some additional data for authenticated users. Defaults to empty, meaning authentication is not optional for any action. Since version 2.0.10 action IDs can be specified as wildcards, e.g. site/*.

Since

2.0.7

$request

public yii\web\Request|null $request = null

The current request.

If not set, the request application component will be used.

$response

public yii\web\Response|null $response = null

The response to be sent.

If not set, the response application component will be used.

$user

public yii\web\User|null $user = null

The user object representing the user authentication status.

If not set, the user application component will be used.

Method details

beforeAction()

public function beforeAction(mixed $action): bool

This method is invoked right before an action is to be executed (after all possible filters.) You may override this method to do last-minute preparation for the action.

Parameters

Parameter	Type	Description
`$action`	`mixed`	The action to be executed.

Returns

bool: Whether the action should continue to be executed.

challenge()

public function challenge(mixed $response): mixed

Generates challenges upon authentication failure.

For example, some appropriate HTTP headers may be generated.

Parameters

Parameter	Type	Description
`$response`	`mixed`

Returns

mixed

handleFailure()

public function handleFailure(mixed $response): mixed

Handles authentication failure.

The implementation should normally throw UnauthorizedHttpException to indicate authentication failure.

Parameters

Parameter	Type	Description
`$response`	`mixed`

Returns

mixed

Throws

yii\web\UnauthorizedHttpException

isOptional()

protected function isOptional(yii\base\Action $action): bool

Checks, whether authentication is optional for the given action.

Parameters

Parameter	Type	Description
`$action`	`yii\base\Action`	Action to be checked.

Returns

bool: Whether authentication is optional or not.

Since

2.0.7

See also

$optional