HumHub Documentation (unofficial)

AuthAction extends Action
in package

AuthAction performs authentication via different auth clients.

It supports [[OpenId]], [[OAuth1]] and [[OAuth2]] client types.

Usage:

class SiteController extends Controller
{
    public function actions()
    {
        return [
            'auth' => [
                'class' => 'yii\authclient\AuthAction',
                'successCallback' => [$this, 'successCallback'],
            ],
        ]
    }

    public function successCallback($client)
    {
        $attributes = $client->getUserAttributes();
        // user login or signup comes here
    }
}

Usually authentication via external services is performed inside the popup window. This action handles the redirection and closing of popup window correctly.

Tags
see
Collection
see
AuthChoice
author

Paul Klimov klimov.paul@gmail.com

since
2.0

Table of Contents

Properties

$behaviors  : array<string|int, Behavior>
$cancelCallback  : callable
$cancelUrl  : string
$clientCollection  : string
$clientId  : string
$clientIdGetParamName  : string
$controller  : Controller|Controller|Controller
$defaultClientId  : string
$id  : string
$redirectView  : string
$successCallback  : callable
$successUrl  : string
$uniqueId  : string
$user  : User|array<string|int, mixed>|string
$_behaviors  : array<string|int, Behavior>|null
$_cancelUrl  : string
$_events  : array<string|int, mixed>
$_eventWildcards  : array<string|int, mixed>
$_successUrl  : string

Methods

__call()  : mixed
Calls the named method which is not a class method.
__clone()  : mixed
This method is called after the object is created by cloning an existing one.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of a component property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets the value of a component property.
__unset()  : mixed
Sets a component property to be null.
attachBehavior()  : Behavior
Attaches a behavior to this component.
attachBehaviors()  : mixed
Attaches a list of behaviors to the component.
behaviors()  : array<string|int, mixed>
Returns a list of behaviors that this component should behave as.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
detachBehavior()  : Behavior|null
Detaches a behavior from the component.
detachBehaviors()  : mixed
Detaches all behaviors from the component.
ensureBehaviors()  : mixed
Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
getBehavior()  : Behavior|null
Returns the named behavior object.
getBehaviors()  : array<string|int, Behavior>
Returns all behaviors attached to this component.
getCancelUrl()  : string
getClientId()  : string
getSuccessUrl()  : string
getUniqueId()  : string
Returns the unique ID of this action among the whole application.
hasEventHandlers()  : bool
Returns a value indicating whether there is any handler attached to the named event.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined for this component.
init()  : mixed
Initializes the object.
off()  : bool
Detaches an existing event handler from this component.
on()  : mixed
Attaches an event handler to an event.
redirect()  : Response
Redirect to the given URL or simply close the popup window.
redirectCancel()  : Response
Redirect to the [[cancelUrl]] or simply close the popup window.
redirectSuccess()  : Response
Redirect to the URL. If URL is null, [[successUrl]] will be used.
run()  : mixed
Runs the action.
runWithParams()  : mixed
Runs this action with the specified parameters.
setCancelUrl()  : mixed
setSuccessUrl()  : mixed
trigger()  : mixed
Triggers an event.
afterRun()  : mixed
This method is called right after `run()` is executed.
auth()  : Response
Perform authentication for the given client.
authCancel()  : Response
This method is invoked in case of authentication cancelation.
authOAuth1()  : Response
Performs OAuth1 auth flow.
authOAuth2()  : Response
Performs OAuth2 auth flow.
authOpenId()  : Response
Performs OpenID auth flow.
authSuccess()  : Response
This method is invoked in case of successful authentication via auth client.
beforeRun()  : bool
This method is called right before `run()` is executed.
defaultCancelUrl()  : string
Creates default [[cancelUrl]] value.
defaultSuccessUrl()  : string
Creates default [[successUrl]] value.
attachBehaviorInternal()  : Behavior
Attaches a behavior to this component.

Properties

$behaviors read-only

public array<string|int, Behavior> $behaviors

List of behaviors attached to this component.

$cancelCallback

public callable $cancelCallback

PHP callback, which should be triggered in case of authentication cancelation. This callback should accept [[ClientInterface]] instance as an argument. For example:

public function onAuthCancel(ClientInterface $client)
{
    // set flash, logging, etc.
}

If this callback returns [[Response]] instance, it will be used as action response, otherwise redirection to [[cancelUrl]] will be performed.

Tags
since
2.1.5

$clientCollection

public string $clientCollection = 'authClientCollection'

name of the auth client collection application component. It should point to [[Collection]] instance.

$clientId read-only

public string $clientId

Client ID.

$clientIdGetParamName

public string $clientIdGetParamName = 'authclient'

name of the GET param, which is used to passed auth client id to this action. Note: watch for the naming, make sure you do not choose name used in some auth protocol.

$defaultClientId

public string $defaultClientId = ''

the default client ID

Tags
since
2.2.12

$id

public string $id

ID of the action

$redirectView

public string $redirectView

name or alias of the view file, which should be rendered in order to perform redirection. If not set - default one will be used.

$successCallback

public callable $successCallback

PHP callback, which should be triggered in case of successful authentication. This callback should accept [[ClientInterface]] instance as an argument. For example:

public function onAuthSuccess(ClientInterface $client)
{
    $attributes = $client->getUserAttributes();
    // user login or signup comes here
}

If this callback returns [[Response]] instance, it will be used as action response, otherwise redirection to [[successUrl]] will be performed.

$successUrl

public string $successUrl

Successful URL.

$uniqueId read-only

public string $uniqueId

The unique ID of this action among the whole application.

$user

public User|array<string|int, mixed>|string $user = 'user'

the User object or the application component ID of the user component.

Tags
since
2.1.8

$_behaviors

private array<string|int, Behavior>|null $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_cancelUrl

private string $_cancelUrl

the redirect url after unsuccessful authorization (e.g. user canceled).

$_events

private array<string|int, mixed> $_events = []

the attached event handlers (event name => handlers)

$_eventWildcards

private array<string|int, mixed> $_eventWildcards = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

Tags
since
2.0.14

$_successUrl

private string $_successUrl

the redirect url after successful authorization.

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__clone()

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

public __clone() : mixed

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

__construct()

Constructor.

public __construct(string $id, Controller $controller[, array<string|int, mixed> $config = [] ]) : mixed
Parameters
$id : string

the ID of this action

$controller : Controller

the controller that owns this action

$config : array<string|int, mixed> = []

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

__get()

Returns the value of a component property.

public __get(string $name) : mixed

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;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only.

see
__set()
Return values
mixed —

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

__isset()

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

public __isset(string $name) : bool

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).

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set

__set()

Sets the value of a component property.

public __set(string $name, mixed $value) : mixed

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;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only.

see
__get()

__unset()

Sets a component property to be null.

public __unset(string $name) : mixed

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).

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

attachBehavior()

Attaches a behavior to this component.

public attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

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 [[Behavior::attach()]] method.

Parameters
$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

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

  • a [[Behavior]] object
  • a string specifying the behavior class
  • an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.
Tags
see
detachBehavior()
Return values
Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.

public attachBehaviors(array<string|int, mixed> $behaviors) : mixed

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

Parameters
$behaviors : array<string|int, mixed>

list of behaviors to be attached to the component

Tags
see
attachBehavior()

behaviors()

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

public behaviors() : array<string|int, mixed>

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 [[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).

Return values
array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

detachBehavior()

Detaches a behavior from the component.

public detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters
$name : string

the behavior's name.

Return values
Behavior|null —

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

detachBehaviors()

Detaches all behaviors from the component.

public detachBehaviors() : mixed

ensureBehaviors()

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

public ensureBehaviors() : mixed

getBehavior()

Returns the named behavior object.

public getBehavior(string $name) : Behavior|null
Parameters
$name : string

the behavior name

Return values
Behavior|null —

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

getBehaviors()

Returns all behaviors attached to this component.

public getBehaviors() : array<string|int, Behavior>
Return values
array<string|int, Behavior> —

list of behaviors attached to this component

getCancelUrl()

public getCancelUrl() : string
Return values
string —

cancel URL.

getClientId()

public getClientId() : string
Tags
since
2.2.12
Return values
string —

client ID

getSuccessUrl()

public getSuccessUrl() : string
Return values
string —

successful URL.

getUniqueId()

Returns the unique ID of this action among the whole application.

public getUniqueId() : string
Return values
string —

the unique ID of this action among the whole application.

hasEventHandlers()

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

public hasEventHandlers(string $name) : bool
Parameters
$name : string

the event name

Return values
bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

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).
Parameters
$name : string

the property name

$checkBehaviors : bool = true

whether to treat behaviors' methods as methods of this component

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.

public hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

init()

Initializes the object.

public init() : mixed
Tags
inheritdoc

off()

Detaches an existing event handler from this component.

public off(string $name[, callable|null $handler = null ]) : bool

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.

Parameters
$name : string

event name

$handler : callable|null = null

the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Tags
see
on()
Return values
bool —

if a handler is found and detached

on()

Attaches an event handler to an event.

public on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

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 [[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.');
});
Parameters
$name : string

the event name

$handler : callable

the event handler

$data : mixed = null

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 [[Event::data]].

$append : bool = true

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.

Tags
see
off()

redirect()

Redirect to the given URL or simply close the popup window.

public redirect(mixed $url[, bool $enforceRedirect = true ]) : Response
Parameters
$url : mixed

URL to redirect, could be a string or array config to generate a valid URL.

$enforceRedirect : bool = true

indicates if redirect should be performed even in case of popup window.

Return values
Response —

response instance.

redirectCancel()

Redirect to the [[cancelUrl]] or simply close the popup window.

public redirectCancel([string $url = null ]) : Response
Parameters
$url : string = null

URL to redirect.

Return values
Response —

response instance.

redirectSuccess()

Redirect to the URL. If URL is null, [[successUrl]] will be used.

public redirectSuccess([string $url = null ]) : Response
Parameters
$url : string = null

URL to redirect.

Return values
Response —

response instance.

runWithParams()

Runs this action with the specified parameters.

public runWithParams(array<string|int, mixed> $params) : mixed

This method is mainly invoked by the controller.

Parameters
$params : array<string|int, mixed>

the parameters to be bound to the action's run() method.

Tags
throws
InvalidConfigException

if the action class does not have a run() method

Return values
mixed —

the result of the action

setCancelUrl()

public setCancelUrl(string $url) : mixed
Parameters
$url : string

cancel URL.

setSuccessUrl()

public setSuccessUrl(string $url) : mixed
Parameters
$url : string

successful URL.

trigger()

Triggers an event.

public trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters
$name : string

the event name

$event : Event|null = null

the event instance. If not set, a default [[Event]] object will be created.

afterRun()

This method is called right after `run()` is executed.

protected afterRun() : mixed

You may override this method to do post-processing work for the action run.

auth()

Perform authentication for the given client.

protected auth(mixed $client[, array<string|int, mixed> $authUrlParams = [] ]) : Response
Parameters
$client : mixed

auth client instance.

$authUrlParams : array<string|int, mixed> = []

additional auth GET params.

Tags
throws
NotSupportedException

on invalid client.

Return values
Response —

response instance.

authOAuth1()

Performs OAuth1 auth flow.

protected authOAuth1(OAuth1 $client[, array<string|int, mixed> $authUrlParams = [] ]) : Response
Parameters
$client : OAuth1

auth client instance.

$authUrlParams : array<string|int, mixed> = []

additional auth GET params.

Return values
Response —

action response.

authOAuth2()

Performs OAuth2 auth flow.

protected authOAuth2(OAuth2 $client[, array<string|int, mixed> $authUrlParams = [] ]) : Response
Parameters
$client : OAuth2

auth client instance.

$authUrlParams : array<string|int, mixed> = []

additional auth GET params.

Tags
throws
Exception

on failure.

Return values
Response —

action response.

beforeRun()

This method is called right before `run()` is executed.

protected beforeRun() : bool

You may override this method to do preparation work for the action run. If the method returns false, it will cancel the action.

Return values
bool —

whether to run the action.

defaultCancelUrl()

Creates default [[cancelUrl]] value.

protected defaultCancelUrl() : string
Return values
string —

cancel URL value.

defaultSuccessUrl()

Creates default [[successUrl]] value.

protected defaultSuccessUrl() : string
Return values
string —

success URL value.

attachBehaviorInternal()

Attaches a behavior to this component.

private attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior
Parameters
$name : string|int

the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.

$behavior : string|array<string|int, mixed>|Behavior

the behavior to be attached

Return values
Behavior —

the attached behavior.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results