# Class yii\filters\auth\CompositeAuth

Inheritance | yii\filters\auth\CompositeAuth » yii\filters\auth\AuthMethod » yii\base\ActionFilter » yii\base\Behavior » yii\base\BaseObject
Implements | yii\base\Configurable, yii\filters\auth\AuthInterface
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/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::className(),
                'authMethods' => [
                    \yii\filters\auth\HttpBasicAuth::className(),
                    \yii\filters\auth\QueryParamAuth::className(),
                ],
            ],
        ];
    }

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$authMethods | array | The supported authentication methods. | yii\filters\auth\CompositeAuth
$except | array | List of action IDs that this filter should not apply to. | yii\base\ActionFilter
$only | array | List of action IDs that this filter should apply to. | yii\base\ActionFilter
$optional | array | List of action IDs that this filter will be applied to, but auth failure will not lead to error. | yii\filters\auth\AuthMethod
$owner | yii\base\Component|null | The owner of this behavior | yii\base\Behavior
$request | yii\web\Request | The current request. | yii\filters\auth\AuthMethod
$response | yii\web\Response | The response to be sent. | yii\filters\auth\AuthMethod
$user | yii\web\User | The user object representing the user authentication status. | yii\filters\auth\AuthMethod

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\BaseObject
__construct() | Constructor. | 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. | yii\filters\auth\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. | yii\filters\auth\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. | yii\filters\auth\CompositeAuth
className() | 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. | yii\filters\auth\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

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
getActionId() | Returns an action ID by converting yii\base\Action::$uniqueId into an ID relative to the module. | yii\base\ActionFilter
isActive() | Returns a value indicating whether the filter is active for the given action. | yii\base\ActionFilter
isOptional() | Checks, whether authentication is optional for the given action. | yii\filters\auth\AuthMethod

## Property Details

$authMethods public property

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 yii\filters\auth\AuthInterface interface.

public array $authMethods = []

## Method Details

authenticate() public method

Authenticates the current user.

public yii\web\IdentityInterface authenticate ( $user, $request, $response )
$user | yii\web\User |
$request | yii\web\Request |
$response | yii\web\Response |
return | yii\web\IdentityInterface | 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 method

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.

public boolean beforeAction ( $action )
$action | yii\base\Action | The action to be executed.
return | boolean | Whether the action should continue to be executed.

challenge() public method

Generates challenges upon authentication failure.

For example, some appropriate HTTP headers may be generated.

public void challenge ( $response )
$response | yii\web\Response |