CompositeAuth

API reference › yii › filters › auth › CompositeAuth

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

CompositeAuth is an action filter that supports multiple authentication methods at the same time.

The authentication methods contained by CompositeAuth are configured via $authMethods, which is a list of supported authentication class configurations.

The following example shows how to support three authentication methods:

public function behaviors()
{
    return [
        'compositeAuth' => [
            'class' => \yii\filters\auth\CompositeAuth::class,
            'authMethods' => [
                \yii\filters\auth\HttpBasicAuth::class,
                \yii\filters\auth\QueryParamAuth::class,
            ],
        ],
    ];
}

Properties

Property	Type	Description	Defined by
`$authMethods`	`list<class-string<AuthInterface>\|array{class: class-string<AuthInterface>}>`	The supported authentication methods. Default: `[]`.	`CompositeAuth`
`$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()`	Authenticates the current user.	`CompositeAuth`
`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.	`CompositeAuth`
`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.	`CompositeAuth`
`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

$authMethods

public list<class-string<yii\filters\auth\AuthInterface>|array{class: class-string<yii\filters\auth\AuthInterface>}> $authMethods = []

The supported authentication methods.

This property should take a list of supported authentication methods, each represented by an authentication class or configuration.

If this property is empty, no authentication will be performed.

Note that an auth method class must implement the AuthInterface interface.

Method details

authenticate()

public function authenticate(mixed $user, mixed $request, mixed $response): yii\web\IdentityInterface|null

Authenticates the current user.

Parameters

Parameter	Type	Description
`$user`	`mixed`
`$request`	`mixed`
`$response`	`mixed`

Returns

yii\web\IdentityInterface|null: The authenticated user identity. If authentication information is not provided, null will be returned.

Throws

yii\web\UnauthorizedHttpException: if authentication information is provided but is invalid.

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