HumHub Documentation (unofficial)

OpenId extends BaseClient
in package

Application

OpenId provides a simple interface for OpenID (1.1 and 2.0) authentication.

Supports Yadis and HTML discovery.

Usage:

use yii\authclient\OpenId;

$client = new OpenId();
$client->authUrl = 'https://open.id.provider.url'; // Setup provider endpoint
$url = $client->buildAuthUrl(); // Get authentication URL
return Yii::$app->getResponse()->redirect($url); // Redirect to authentication URL
// After user returns at our site:
if ($client->validate()) { // validate response
    $userAttributes = $client->getUserAttributes(); // get account info
    ...
}

AX and SREG extensions are supported. To use them, specify [[requiredAttributes]] and/or [[optionalAttributes]].

Properties

$authUrl : string
$axToSregMap : array<string|int, mixed>
$behaviors : array<string|int, Behavior>
$cainfo : string
$capath : string
$claimedId : string
$data : array<string|int, mixed>
$httpClient : Client
$id : string
$name : string
$normalizeUserAttributeMap : array<string|int, mixed>
$optionalAttributes : array<string|int, mixed>
$requestOptions : array<string|int, mixed>
$requiredAttributes : array<string|int, mixed>
$returnUrl : string
$stateStorage : StateStorageInterface
$title : string
$trustRoot : string
$userAttributes : array<string|int, mixed>
$verifyPeer : bool
$viewOptions : array<string|int, mixed>
$_behaviors : array<string|int, Behavior>|null
$_claimedId : string
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_httpClient : Client|array<string|int, mixed>|string
$_id : string
$_name : string
$_normalizeUserAttributeMap : array<string|int, mixed>
$_requestOptions : array<string|int, mixed>
$_returnUrl : string
$_stateStorage : StateStorageInterface|array<string|int, mixed>|string
$_title : string
$_trustRoot : string
$_userAttributes : array<string|int, mixed>
$_viewOptions : array<string|int, mixed>

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.
buildAuthUrl() : string: Returns authentication URL. Usually, you want to redirect your user to it.
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.
createRequest() : Request: Creates HTTP request instance.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
discover() : array<string|int, mixed>: Performs Yadis and HTML discovery.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
fetchAttributes() : array<string|int, mixed>: Gets AX/SREG attributes provided by OP. Should be used only after successful validation.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getClaimedId() : string
getHttpClient() : Client: Returns HTTP client.
getId() : string
getName() : string
getNormalizeUserAttributeMap() : array<string|int, mixed>
getRequestOptions() : array<string|int, mixed>
getReturnUrl() : string
getStateStorage() : StateStorageInterface
getTitle() : string
getTrustRoot() : string
getUserAttributes() : array<string|int, mixed>
getViewOptions() : array<string|int, mixed>
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.
hostExists() : bool: Checks if the server specified in the url exists.
init() : mixed: Initializes the object.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
setClaimedId() : mixed
setHttpClient() : mixed: Sets HTTP client to be used.
setId() : mixed
setName() : mixed
setNormalizeUserAttributeMap() : mixed
setRequestOptions() : mixed
setReturnUrl() : mixed
setStateStorage() : mixed
setTitle() : mixed
setTrustRoot() : mixed
setUserAttributes() : mixed
setViewOptions() : mixed
trigger() : mixed: Triggers an event.
validate() : bool: Performs OpenID verification with the OP.
buildAuthUrlV1() : string: Builds authentication URL for the protocol version 1.
buildAuthUrlV2() : string: Builds authentication URL for the protocol version 2.
buildAxParams() : array<string|int, mixed>: Composes AX request parameters.
buildSregParams() : array<string|int, mixed>: Composes SREG request parameters.
buildUrl() : string: Combines given URLs into single one.
compareUrl() : bool: Compares 2 URLs taking in account possible GET parameters order miss match and URL encoding inconsistencies.
createHttpClient() : Client: Creates HTTP client instance from reference or configuration.
defaultName() : string: Generates service name.
defaultNormalizeUserAttributeMap() : array<string|int, mixed>: Returns the default [[normalizeUserAttributeMap]] value.
defaultRequestOptions() : array<string|int, mixed>: Returns default HTTP request options.
defaultReturnUrl() : string: Generates default [[returnUrl]] value.
defaultTitle() : string: Generates service title.
defaultViewOptions() : array<string|int, mixed>: Returns the default [[viewOptions]] value.
extractHtmlTagValue() : string|bool: Scans content for <meta>/<link> tags and extract information from them.
fetchAxAttributes() : array<string|int, mixed>: Gets AX attributes provided by OP.
fetchSregAttributes() : array<string|int, mixed>: Gets SREG attributes provided by OP. SREG names will be mapped to AX names.
getState() : mixed: Returns persistent state value.
getStateKeyPrefix() : string: Returns session key prefix, which is used to store internal states.
initUserAttributes() : array<string|int, mixed>: Initializes authenticated user attributes.
normalizeUserAttributes() : array<string|int, mixed>: Normalize given user attributes according to [[normalizeUserAttributeMap]].
removeState() : bool: Removes persistent state value.
sendRequest() : array<string|int, mixed>|string: Sends request to the server
setState() : $this: Sets persistent state.
validateRequiredAttributes() : bool: Checks if all required attributes are present in the server response.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.

$authUrl


    public
        string
    $authUrl

authentication base URL, which should be used to compose actual authentication URL by [[buildAuthUrl()]] method.

$axToSregMap


    public
        array<string|int, mixed>
    $axToSregMap
     = ['namePerson/friendly' => 'nickname', 'contact/email' => 'email', 'namePerson' => 'fullname', 'birthDate' => 'dob', 'person/gender' => 'gender', 'contact/postalCode/home' => 'postcode', 'contact/country/home' => 'country', 'pref/language' => 'language', 'pref/timezone' => 'timezone']

map of matches between AX and SREG attribute names in format: axAttributeName => sregAttributeName

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$cainfo


    public
        string
    $cainfo

the name of a file holding one or more certificates to verify the peer with. This value will take effect only if [[verifyPeer]] is set.

$capath


    public
        string
    $capath

directory that holds multiple CA certificates. This value will take effect only if [[verifyPeer]] is set.

$claimedId


    public
        string
    $claimedId

Claimed identifier (identity).

$data


    public
        array<string|int, mixed>
    $data

data, which should be used to retrieve the OpenID response. If not set combination of GET and POST will be used.

$httpClient


    public
        Client
    $httpClient

Internal HTTP client. Note that the type of this property differs in getter and setter. See [[getHttpClient()]] and [[setHttpClient()]] for details.

$id


    public
        string
    $id

Service id.

$name


    public
        string
    $name

Service name.

$normalizeUserAttributeMap


    public
        array<string|int, mixed>
    $normalizeUserAttributeMap

Normalize user attribute map.

$optionalAttributes


    public
        array<string|int, mixed>
    $optionalAttributes
     = []

list of attributes, which could be returned from server. Attribute names should be always specified in AX format. For example:

['namePerson/first', 'namePerson/last']

$requestOptions read-only


    public
        array<string|int, mixed>
    $requestOptions

HTTP request options.

$requiredAttributes


    public
        array<string|int, mixed>
    $requiredAttributes
     = []

list of attributes, which always should be returned from server. Attribute names should be always specified in AX format. For example:

['namePerson/friendly', 'contact/email']

$returnUrl


    public
        string
    $returnUrl

Authentication return URL.

$stateStorage


    public
        StateStorageInterface
    $stateStorage

Stage storage. Note that the type of this property differs in getter and setter. See [[getStateStorage()]] and [[setStateStorage()]] for details.

$title


    public
        string
    $title

Service title.

$trustRoot


    public
        string
    $trustRoot

Client trust root (realm).

$userAttributes


    public
        array<string|int, mixed>
    $userAttributes

List of user attributes.

$verifyPeer


    public
        bool
    $verifyPeer

whether to verify the peer's certificate.

$viewOptions


    public
        array<string|int, mixed>
    $viewOptions

View options in format: optionName => optionValue.

$_behaviors


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

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

$_claimedId


    private
        string
    $_claimedId

claimed identifier (identity)

$_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)

$_httpClient


    private
        Client|array<string|int, mixed>|string
    $_httpClient
     = 'yii\httpclient\Client'

internal HTTP client.

$_id


    private
        string
    $_id

auth service id. This value mainly used as HTTP request parameter.

$_name


    private
        string
    $_name

auth service name. This value may be used in database records, CSS files and so on.

$_normalizeUserAttributeMap


    private
        array<string|int, mixed>
    $_normalizeUserAttributeMap

map used to normalize user attributes fetched from external auth service in format: normalizedAttributeName => sourceSpecification 'sourceSpecification' can be:

string, raw attribute name
array, pass to raw attribute value
callable, PHP callback, which should accept array of raw attributes and return normalized value.

For example:

'normalizeUserAttributeMap' => [
     'about' => 'bio',
     'language' => ['languages', 0, 'name'],
     'fullName' => function ($attributes) {
         return $attributes['firstName'] . ' ' . $attributes['lastName'];
     },
 ],

$_requestOptions


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

cURL request options. Option values from this field will overwrite corresponding values from [[defaultRequestOptions()]].

$_returnUrl


    private
        string
    $_returnUrl

authentication return URL.

$_stateStorage


    private
        StateStorageInterface|array<string|int, mixed>|string
    $_stateStorage
     = 'yii\authclient\SessionStateStorage'

state storage to be used.

$_title


    private
        string
    $_title

auth service title to display in views.

$_trustRoot


    private
        string
    $_trustRoot

client trust root (realm), by default [[\yii\web\Request::hostInfo]] value will be used.

$_userAttributes


    private
        array<string|int, mixed>
    $_userAttributes

authenticated user attributes.

$_viewOptions


    private
        array<string|int, mixed>
    $_viewOptions

view options in format: optionName => optionValue

__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

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([array<string|int, mixed> $config = [] ]) : mixed

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.

Parameters

$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

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

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

__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

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.

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

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.

buildAuthUrl()

Returns authentication URL. Usually, you want to redirect your user to it.


    public
                    buildAuthUrl([bool $identifierSelect = null ]) : string

Parameters

$identifierSelect : bool = null: whether to request OP to select identity for an user in OpenID 2, does not affect OpenID 1.

Return values

string —

the authentication URL.

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

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

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

createRequest()

Creates HTTP request instance.


    public
                    createRequest() : Request

Return values

Request —

HTTP request instance.

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

discover()

Performs Yadis and HTML discovery.


    public
                    discover(string $url) : array<string|int, mixed>

Parameters

$url : string: Identity URL.

Return values

array<string|int, mixed> —

OpenID provider info, following keys will be available:

url: string, OP Endpoint (i.e. OpenID provider address).
version: int, OpenID protocol version used by provider.
identity: string, identity value.
identifier_select: bool, whether to request OP to select identity for an user in OpenID 2, does not affect OpenID 1.
ax: bool, whether AX attributes should be used.
sreg: bool, whether SREG attributes should be used.

ensureBehaviors()

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


    public
                    ensureBehaviors() : mixed

fetchAttributes()

Gets AX/SREG attributes provided by OP. Should be used only after successful validation.


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

Note that it does not guarantee that any of the required/optional parameters will be present, or that there will be no other attributes besides those specified. In other words. OP may provide whatever information it wants to. SREG names will be mapped to AX names.

Return values

array<string|int, mixed> —

array of attributes with keys being the AX schema names, e.g. 'contact/email'

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

getClaimedId()


    public
                    getClaimedId() : string

Return values

string —

claimed identifier (identity).

getHttpClient()

Returns HTTP client.


    public
                    getHttpClient() : Client

Return values

Client —

internal HTTP client.

getId()


    public
                    getId() : string

Return values

string —

service id

getName()


    public
                    getName() : string

Return values

string —

service name.

getNormalizeUserAttributeMap()


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

Return values

array<string|int, mixed> —

normalize user attribute map.

getRequestOptions()


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

Return values

array<string|int, mixed> —

HTTP request options.

getReturnUrl()


    public
                    getReturnUrl() : string

Return values

string —

authentication return URL.

getStateStorage()


    public
                    getStateStorage() : StateStorageInterface

Return values

StateStorageInterface —

stage storage.

getTitle()


    public
                    getTitle() : string

Return values

string —

service title.

getTrustRoot()


    public
                    getTrustRoot() : string

Return values

string —

client trust root (realm).

getUserAttributes()


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

Return values

array<string|int, mixed> —

list of user attributes

getViewOptions()


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

Return values

array<string|int, mixed> —

view options in format: optionName => optionValue

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

Return values

bool —

whether the property is defined

hostExists()

Checks if the server specified in the url exists.


    public
                    hostExists(string $url) : bool

Parameters

$url : string: URL to check

Return values

bool —

true, if the server exists; false otherwise

init()

Initializes the object.


    public
                    init() : mixed

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.

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.

setClaimedId()


    public
                    setClaimedId(string $claimedId) : mixed

Parameters

$claimedId : string: claimed identifier (identity).

setHttpClient()

Sets HTTP client to be used.


    public
                    setHttpClient(array<string|int, mixed>|Client $httpClient) : mixed

Parameters

$httpClient : array<string|int, mixed>|Client: internal HTTP client.

setId()


    public
                    setId(string $id) : mixed

Parameters

$id : string: service id.

setName()


    public
                    setName(string $name) : mixed

Parameters

$name : string: service name.

setNormalizeUserAttributeMap()


    public
                    setNormalizeUserAttributeMap(array<string|int, mixed> $normalizeUserAttributeMap) : mixed

Parameters

$normalizeUserAttributeMap : array<string|int, mixed>: normalize user attribute map.

setRequestOptions()


    public
                    setRequestOptions(array<string|int, mixed> $options) : mixed

Parameters

$options : array<string|int, mixed>: HTTP request options.

setReturnUrl()


    public
                    setReturnUrl(string $returnUrl) : mixed

Parameters

$returnUrl : string: authentication return URL.

setStateStorage()


    public
                    setStateStorage(StateStorageInterface|array<string|int, mixed>|string $stateStorage) : mixed

Parameters

$stateStorage : StateStorageInterface|array<string|int, mixed>|string: stage storage to be used.

setTitle()


    public
                    setTitle(string $title) : mixed

Parameters

$title : string: service title.

setTrustRoot()


    public
                    setTrustRoot(string $value) : mixed

Parameters

$value : string: client trust root (realm).

setUserAttributes()


    public
                    setUserAttributes(array<string|int, mixed> $userAttributes) : mixed

Parameters

$userAttributes : array<string|int, mixed>: list of user attributes

setViewOptions()


    public
                    setViewOptions(array<string|int, mixed> $viewOptions) : mixed

Parameters

$viewOptions : array<string|int, mixed>: view options in format: optionName => optionValue

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.

validate()

Performs OpenID verification with the OP.


    public
                    validate([bool $validateRequiredAttributes = true ]) : bool

Parameters

$validateRequiredAttributes : bool = true: whether to validate required attributes.

Return values

bool —

whether the verification was successful.

buildAuthUrlV1()

Builds authentication URL for the protocol version 1.


    protected
                    buildAuthUrlV1(array<string|int, mixed> $serverInfo) : string

Parameters

$serverInfo : array<string|int, mixed>: OpenID server info.

Return values

string —

authentication URL.

buildAuthUrlV2()

Builds authentication URL for the protocol version 2.


    protected
                    buildAuthUrlV2(array<string|int, mixed> $serverInfo) : string

Parameters

$serverInfo : array<string|int, mixed>: OpenID server info.

Return values

string —

authentication URL.

buildAxParams()

Composes AX request parameters.


    protected
                    buildAxParams() : array<string|int, mixed>

Return values

array<string|int, mixed> —

AX parameters.

buildSregParams()

Composes SREG request parameters.


    protected
                    buildSregParams() : array<string|int, mixed>

Return values

array<string|int, mixed> —

SREG parameters.

buildUrl()

Combines given URLs into single one.


    protected
                    buildUrl(string $baseUrl, string|array<string|int, mixed> $additionalUrl) : string

Parameters

$baseUrl : string: base URL.
$additionalUrl : string|array<string|int, mixed>: additional URL string or information array.

Return values

string —

composed URL.

compareUrl()

Compares 2 URLs taking in account possible GET parameters order miss match and URL encoding inconsistencies.


    protected
                    compareUrl(string $expectedUrl, string $actualUrl) : bool

Parameters

$expectedUrl : string: expected URL.
$actualUrl : string: actual URL.

Return values

bool —

whether URLs are equal.

createHttpClient()

Creates HTTP client instance from reference or configuration.


    protected
                    createHttpClient(string|array<string|int, mixed> $reference) : Client

Parameters

$reference : string|array<string|int, mixed>: component name or array configuration.

Return values

Client —

HTTP client instance.

defaultName()

Generates service name.


    protected
                    defaultName() : string

Return values

string —

service name.

defaultNormalizeUserAttributeMap()

Returns the default [[normalizeUserAttributeMap]] value.


    protected
                    defaultNormalizeUserAttributeMap() : array<string|int, mixed>

Particular client may override this method in order to provide specific default map.

Return values

array<string|int, mixed> —

normalize attribute map.

defaultRequestOptions()

Returns default HTTP request options.


    protected
                    defaultRequestOptions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

HTTP request options.

defaultReturnUrl()

Generates default [[returnUrl]] value.


    protected
                    defaultReturnUrl() : string

Return values

string —

default authentication return URL.

defaultTitle()

Generates service title.


    protected
                    defaultTitle() : string

Return values

string —

service title.

defaultViewOptions()

Returns the default [[viewOptions]] value.


    protected
                    defaultViewOptions() : array<string|int, mixed>

Particular client may override this method in order to provide specific default view options.

Return values

array<string|int, mixed> —

list of default [[viewOptions]]

extractHtmlTagValue()

Scans content for <meta>/<link> tags and extract information from them.


    protected
                    extractHtmlTagValue(string $content, string $tag, string $matchAttributeName, string $matchAttributeValue, string $valueAttributeName) : string|bool

Parameters

$content : string: HTML content to be be parsed.
$tag : string: name of the source tag.
$matchAttributeName : string: name of the source tag attribute, which should contain $matchAttributeValue
$matchAttributeValue : string: required value of $matchAttributeName
$valueAttributeName : string: name of the source tag attribute, which should contain searched value.

Return values

string|bool —

searched value, "false" on failure.

fetchAxAttributes()

Gets AX attributes provided by OP.


    protected
                    fetchAxAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

array of attributes.

fetchSregAttributes()

Gets SREG attributes provided by OP. SREG names will be mapped to AX names.


    protected
                    fetchSregAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

array of attributes with keys being the AX schema names, e.g. 'contact/email'

getState()

Returns persistent state value.


    protected
                    getState(string $key) : mixed

Parameters

$key : string: state key.

Return values

mixed —

state value.

getStateKeyPrefix()

Returns session key prefix, which is used to store internal states.


    protected
                    getStateKeyPrefix() : string

Return values

string —

session key prefix.

initUserAttributes()

Initializes authenticated user attributes.


    protected
                    initUserAttributes() : array<string|int, mixed>

Return values

array<string|int, mixed> —

auth user attributes.

normalizeUserAttributes()

Normalize given user attributes according to [[normalizeUserAttributeMap]].


    protected
                    normalizeUserAttributes(array<string|int, mixed> $attributes) : array<string|int, mixed>

Parameters

$attributes : array<string|int, mixed>: raw attributes.

Return values

array<string|int, mixed> —

normalized attributes.

removeState()

Removes persistent state value.


    protected
                    removeState(string $key) : bool

Parameters

$key : string: state key.

Return values

bool —

success.

sendRequest()

Sends request to the server


    protected
                    sendRequest(string $url[, string $method = 'GET' ][, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>|string

Parameters

$url : string: request URL.
$method : string = 'GET': request method.
$params : array<string|int, mixed> = []: request parameters.

Return values

array<string|int, mixed>|string —

response.

setState()

Sets persistent state.


    protected
                    setState(string $key, mixed $value) : $this

Parameters

$key : string: state key.
$value : mixed: state value

Return values

$this —

the object itself

validateRequiredAttributes()

Checks if all required attributes are present in the server response.


    protected
                    validateRequiredAttributes() : bool

Return values

bool —

whether all required attributes are present.

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.

OpenId extends BaseClient in package Application

Tags

Table of Contents

Properties

Methods

Properties

$authUrl

$axToSregMap

$behaviors read-only

$cainfo

$capath

$claimedId

$data

$httpClient

$id

$name

$normalizeUserAttributeMap

$optionalAttributes

$requestOptions read-only

$requiredAttributes

$returnUrl

$stateStorage

$title

$trustRoot

$userAttributes

$verifyPeer

$viewOptions

$_behaviors

$_claimedId

$_events

$_eventWildcards

Tags

$_httpClient

Tags

$_id

$_name

$_normalizeUserAttributeMap

$_requestOptions

Tags

$_returnUrl

$_stateStorage

$_title

$_trustRoot

$_userAttributes

$_viewOptions

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Tags

Return values

__set()

Parameters

Tags

__unset()

Parameters

Tags

attachBehavior()

Parameters

Tags

Return values

attachBehaviors()

Parameters

OpenId extends BaseClient
in package

Application