Abstract Class yii\authclient\BaseOAuth

Inheritanceyii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component
Implementsyii\authclient\ClientInterface
Subclassesyii\authclient\OAuth1, yii\authclient\OAuth2, yii\authclient\clients\Facebook, yii\authclient\clients\GitHub, yii\authclient\clients\GoogleHybrid, yii\authclient\clients\GoogleOAuth, yii\authclient\clients\LinkedIn, yii\authclient\clients\Live, yii\authclient\clients\Twitter, yii\authclient\clients\VKontakte, yii\authclient\clients\YandexOAuth
Available since extension's version2.0
Source Code https://github.com/yiisoft/yii2-authclient/blob/master/BaseOAuth.php

BaseOAuth is a base class for the OAuth clients.

See also http://oauth.net/.

Public Properties

Hide inherited properties

Property Type Description Defined By
$accessToken yii\authclient\OAuthToken Auth token instance. yii\authclient\BaseOAuth
$apiBaseUrl string API base URL. yii\authclient\BaseOAuth
$authUrl string Authorize URL. yii\authclient\BaseOAuth
$autoRefreshAccessToken boolean Whether to automatically perform 'refresh access token' request on expired access token. yii\authclient\BaseOAuth
$curlOptions array CURL options. yii\authclient\BaseOAuth
$id string Service id. yii\authclient\BaseClient
$name string Service name. yii\authclient\BaseClient
$normalizeUserAttributeMap array Normalize user attribute map. yii\authclient\BaseClient
$returnUrl string Return URL. yii\authclient\BaseOAuth
$scope string Auth request scope. yii\authclient\BaseOAuth
$signatureMethod yii\authclient\signature\BaseMethod Signature method instance. yii\authclient\BaseOAuth
$title string Service title. yii\authclient\BaseClient
$userAttributes array List of user attributes. yii\authclient\BaseClient
$version string Protocol version. yii\authclient\BaseOAuth
$viewOptions array View options in format: optionName => optionValue. yii\authclient\BaseClient

Protected Methods

Hide inherited methods

Method Description Defined By
apiInternal() Performs request to the OAuth API. yii\authclient\BaseOAuth
composeRequestCurlOptions() Composes HTTP request CUrl options, which will be merged with the default ones. yii\authclient\BaseOAuth
composeUrl() Composes URL from base URL and GET params. yii\authclient\BaseOAuth
convertXmlToArray() Converts XML document to array. yii\authclient\BaseOAuth
createSignatureMethod() Creates signature method instance from its configuration. yii\authclient\BaseOAuth
createToken() Creates token from its configuration. yii\authclient\BaseOAuth
defaultCurlOptions() Returns default cURL options. yii\authclient\BaseOAuth
defaultName() Generates service name. yii\authclient\BaseClient
defaultNormalizeUserAttributeMap() Returns the default $normalizeUserAttributeMap value. yii\authclient\BaseClient
defaultReturnUrl() Composes default $returnUrl value. yii\authclient\BaseOAuth
defaultTitle() Generates service title. yii\authclient\BaseClient
defaultViewOptions() Returns the default $viewOptions value. yii\authclient\BaseClient
determineContentTypeByHeaders() Attempts to determine HTTP request content type by headers. yii\authclient\BaseOAuth
determineContentTypeByRaw() Attempts to determine the content type from raw content. yii\authclient\BaseOAuth
getState() Returns persistent state value. yii\authclient\BaseOAuth
getStateKeyPrefix() Returns session key prefix, which is used to store internal states. yii\authclient\BaseOAuth
initUserAttributes() Initializes authenticated user attributes. yii\authclient\BaseClient
mergeCurlOptions() Merge CUrl options. yii\authclient\BaseOAuth
normalizeUserAttributes() Normalize given user attributes according to $normalizeUserAttributeMap. yii\authclient\BaseClient
processResponse() Processes raw response converting it to actual data. yii\authclient\BaseOAuth
removeState() Removes persistent state value. yii\authclient\BaseOAuth
restoreAccessToken() Restores access token. yii\authclient\BaseOAuth
saveAccessToken() Saves token as persistent state. yii\authclient\BaseOAuth
sendRequest() Sends HTTP request. yii\authclient\BaseOAuth
setState() Sets persistent state. yii\authclient\BaseOAuth

Constants

Hide inherited constants

Constant Value Description Defined By
CONTENT_TYPE_AUTO 'auto' yii\authclient\BaseOAuth
CONTENT_TYPE_JSON 'json' yii\authclient\BaseOAuth
CONTENT_TYPE_URLENCODED 'urlencoded' yii\authclient\BaseOAuth
CONTENT_TYPE_XML 'xml' yii\authclient\BaseOAuth

Property Details

Hide inherited properties

$accessToken public property

Auth token instance. Note that the type of this property differs in getter and setter. See getAccessToken() and setAccessToken() for details.

$apiBaseUrl public property

API base URL.

public string $apiBaseUrl null
$authUrl public property

Authorize URL.

public string $authUrl null
$autoRefreshAccessToken public property (available since version 2.0.6)

Whether to automatically perform 'refresh access token' request on expired access token.

$curlOptions public property

CURL options. This property is read-only.

public array $curlOptions null
$returnUrl public property

Return URL.

public string $returnUrl null
$scope public property

Auth request scope.

public string $scope null
$signatureMethod public property

Signature method instance. Note that the type of this property differs in getter and setter. See getSignatureMethod() and setSignatureMethod() for details.

$version public property

Protocol version.

public string $version '1.0'

Method Details

Hide inherited methods

api() public method

Performs request to the OAuth API.

public array api ( $apiSubUrl, $method 'GET', array $params = [], array $headers = [] )
$apiSubUrl string

API sub URL, which will be append to $apiBaseUrl, or absolute API URL.

$method string

Request method.

$params array

Request parameters.

$headers array

Additional request headers.

return array

API response

throws \yii\base\Exception

on failure.

                public function api($apiSubUrl, $method = 'GET', array $params = [], array $headers = [])
{
    if (preg_match('/^https?:\\/\\//is', $apiSubUrl)) {
        $url = $apiSubUrl;
    } else {
        $url = $this->apiBaseUrl . '/' . $apiSubUrl;
    }
    $accessToken = $this->getAccessToken();
    if (!is_object($accessToken) || !$accessToken->getIsValid()) {
        throw new Exception('Invalid access token.');
    }
    return $this->apiInternal($accessToken, $url, $method, $params, $headers);
}

            
apiInternal() protected abstract method

Performs request to the OAuth API.

protected abstract array apiInternal ( $accessToken, $url, $method, array $params, array $headers )
$accessToken yii\authclient\OAuthToken

Actual access token.

$url string

Absolute API URL.

$method string

Request method.

$params array

Request parameters.

$headers array

Additional request headers.

return array

API response.

throws \yii\base\Exception

on failure.

                abstract protected function apiInternal($accessToken, $url, $method, array $params, array $headers);

            
composeRequestCurlOptions() protected abstract method

Composes HTTP request CUrl options, which will be merged with the default ones.

protected abstract array composeRequestCurlOptions ( $method, $url, array $params )
$method string

Request type.

$url string

Request URL.

$params array

Request params.

return array

CUrl options.

throws \yii\base\Exception

on failure.

                abstract protected function composeRequestCurlOptions($method, $url, array $params);

            
composeUrl() protected method

Composes URL from base URL and GET params.

protected string composeUrl ( $url, array $params = [] )
$url string

Base URL.

$params array

GET params.

return string

Composed URL.

                protected function composeUrl($url, array $params = [])
{
    if (strpos($url, '?') === false) {
        $url .= '?';
    } else {
        $url .= '&';
    }
    $url .= http_build_query($params, '', '&', PHP_QUERY_RFC3986);
    return $url;
}

            
convertXmlToArray() protected method

Converts XML document to array.

protected array convertXmlToArray ( $xml )
$xml string|SimpleXMLElement

Xml to process.

return array

XML array representation.

                protected function convertXmlToArray($xml)
{
    if (!is_object($xml)) {
        $xml = simplexml_load_string($xml);
    }
    $result = (array) $xml;
    foreach ($result as $key => $value) {
        if (is_object($value)) {
            $result[$key] = $this->convertXmlToArray($value);
        }
    }
    return $result;
}

            
createSignatureMethod() protected method

Creates signature method instance from its configuration.

protected yii\authclient\signature\BaseMethod createSignatureMethod ( array $signatureMethodConfig )
$signatureMethodConfig array

Signature method configuration.

return yii\authclient\signature\BaseMethod

Signature method instance.

                protected function createSignatureMethod(array $signatureMethodConfig)
{
    if (!array_key_exists('class', $signatureMethodConfig)) {
        $signatureMethodConfig['class'] = signature\HmacSha1::className();
    }
    return Yii::createObject($signatureMethodConfig);
}

            
createToken() protected method

Creates token from its configuration.

protected yii\authclient\OAuthToken createToken ( array $tokenConfig = [] )
$tokenConfig array

Token configuration.

return yii\authclient\OAuthToken

Token instance.

                protected function createToken(array $tokenConfig = [])
{
    if (!array_key_exists('class', $tokenConfig)) {
        $tokenConfig['class'] = OAuthToken::className();
    }
    return Yii::createObject($tokenConfig);
}

            
defaultCurlOptions() protected method

Returns default cURL options.

protected array defaultCurlOptions ( )
return array

CURL options.

                protected function defaultCurlOptions()
{
    return [
        CURLOPT_USERAGENT => Yii::$app->name . ' OAuth ' . $this->version . ' Client',
        CURLOPT_CONNECTTIMEOUT => 30,
        CURLOPT_TIMEOUT => 30,
        CURLOPT_SSL_VERIFYPEER => false,
    ];
}

            
defaultName() protected method

Defined in: yii\authclient\BaseClient::defaultName()

Generates service name.

protected string defaultName ( )
return string

Service name.

                protected function defaultName()
{
    return Inflector::camel2id(StringHelper::basename(get_class($this)));
}

            
defaultNormalizeUserAttributeMap() protected method

Defined in: yii\authclient\BaseClient::defaultNormalizeUserAttributeMap()

Returns the default $normalizeUserAttributeMap value.

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

protected array defaultNormalizeUserAttributeMap ( )
return array

Normalize attribute map.

                protected function defaultNormalizeUserAttributeMap()
{
    return [];
}

            
defaultReturnUrl() protected method

Composes default $returnUrl value.

protected string defaultReturnUrl ( )
return string

Return URL.

                protected function defaultReturnUrl()
{
    return Yii::$app->getRequest()->getAbsoluteUrl();
}

            
defaultTitle() protected method

Defined in: yii\authclient\BaseClient::defaultTitle()

Generates service title.

protected string defaultTitle ( )
return string

Service title.

                protected function defaultTitle()
{
    return StringHelper::basename(get_class($this));
}

            
defaultViewOptions() protected method

Defined in: yii\authclient\BaseClient::defaultViewOptions()

Returns the default $viewOptions value.

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

protected array defaultViewOptions ( )
return array

List of default $viewOptions

                protected function defaultViewOptions()
{
    return [];
}

            
determineContentTypeByHeaders() protected method

Attempts to determine HTTP request content type by headers.

protected string determineContentTypeByHeaders ( array $headers )
$headers array

Request headers.

return string

Content type.

                protected function determineContentTypeByHeaders(array $headers)
{
    if (isset($headers['content_type'])) {
        if (stripos($headers['content_type'], 'json') !== false) {
            return self::CONTENT_TYPE_JSON;
        }
        if (stripos($headers['content_type'], 'urlencoded') !== false) {
            return self::CONTENT_TYPE_URLENCODED;
        }
        if (stripos($headers['content_type'], 'xml') !== false) {
            return self::CONTENT_TYPE_XML;
        }
    }
    return self::CONTENT_TYPE_AUTO;
}

            
determineContentTypeByRaw() protected method

Attempts to determine the content type from raw content.

protected string determineContentTypeByRaw ( $rawContent )
$rawContent string

Raw response content.

return string

Response type.

                protected function determineContentTypeByRaw($rawContent)
{
    if (preg_match('/^\\{.*\\}$/is', $rawContent)) {
        return self::CONTENT_TYPE_JSON;
    }
    if (preg_match('/^[^=|^&]+=[^=|^&]+(&[^=|^&]+=[^=|^&]+)*$/is', $rawContent)) {
        return self::CONTENT_TYPE_URLENCODED;
    }
    if (preg_match('/^<.*>$/is', $rawContent)) {
        return self::CONTENT_TYPE_XML;
    }
    return self::CONTENT_TYPE_AUTO;
}

            
getAccessToken() public method

public yii\authclient\OAuthToken getAccessToken ( )
return yii\authclient\OAuthToken

Auth token instance.

                public function getAccessToken()
{
    if (!is_object($this->_accessToken)) {
        $this->_accessToken = $this->restoreAccessToken();
    }
    return $this->_accessToken;
}

            
getCurlOptions() public method

public array getCurlOptions ( )
return array

CURL options.

                public function getCurlOptions()
{
    return $this->_curlOptions;
}

            
getId() public method
public string getId ( )
return string

Service id

                public function getId()
{
    if (empty($this->_id)) {
        $this->_id = $this->getName();
    }
    return $this->_id;
}

            
getName() public method
public string getName ( )
return string

Service name.

                public function getName()
{
    if ($this->_name === null) {
        $this->_name = $this->defaultName();
    }
    return $this->_name;
}

            
getNormalizeUserAttributeMap() public method
public array getNormalizeUserAttributeMap ( )
return array

Normalize user attribute map.

                public function getNormalizeUserAttributeMap()
{
    if ($this->_normalizeUserAttributeMap === null) {
        $this->_normalizeUserAttributeMap = $this->defaultNormalizeUserAttributeMap();
    }
    return $this->_normalizeUserAttributeMap;
}

            
getReturnUrl() public method

public string getReturnUrl ( )
return string

Return URL.

                public function getReturnUrl()
{
    if ($this->_returnUrl === null) {
        $this->_returnUrl = $this->defaultReturnUrl();
    }
    return $this->_returnUrl;
}

            
getSignatureMethod() public method

public yii\authclient\signature\BaseMethod getSignatureMethod ( )
return yii\authclient\signature\BaseMethod

Signature method instance.

                public function getSignatureMethod()
{
    if (!is_object($this->_signatureMethod)) {
        $this->_signatureMethod = $this->createSignatureMethod($this->_signatureMethod);
    }
    return $this->_signatureMethod;
}

            
getState() protected method

Returns persistent state value.

protected mixed getState ( $key )
$key string

State key.

return mixed

State value.

                protected function getState($key)
{
    if (!Yii::$app->has('session')) {
        return null;
    }
    /* @var \yii\web\Session $session */
    $session = Yii::$app->get('session');
    $key = $this->getStateKeyPrefix() . $key;
    $value = $session->get($key);
    return $value;
}

            
getStateKeyPrefix() protected method

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

protected string getStateKeyPrefix ( )
return string

Session key prefix.

                protected function getStateKeyPrefix()
{
    return get_class($this) . '_' . sha1($this->authUrl) . '_';
}

            
getTitle() public method
public string getTitle ( )
return string

Service title.

                public function getTitle()
{
    if ($this->_title === null) {
        $this->_title = $this->defaultTitle();
    }
    return $this->_title;
}

            
getUserAttributes() public method
public array getUserAttributes ( )
return array

List of user attributes

                public function getUserAttributes()
{
    if ($this->_userAttributes === null) {
        $this->_userAttributes = $this->normalizeUserAttributes($this->initUserAttributes());
    }
    return $this->_userAttributes;
}

            
getViewOptions() public method
public array getViewOptions ( )
return array

View options in format: optionName => optionValue

                public function getViewOptions()
{
    if ($this->_viewOptions === null) {
        $this->_viewOptions = $this->defaultViewOptions();
    }
    return $this->_viewOptions;
}

            
initUserAttributes() protected method

Defined in: yii\authclient\BaseClient::initUserAttributes()

Initializes authenticated user attributes.

protected array initUserAttributes ( )
return array

Auth user attributes.

                protected function initUserAttributes()
{
    throw new NotSupportedException('Method "' . get_class($this) . '::' . __FUNCTION__ . '" not implemented.');
}

            
mergeCurlOptions() protected method

Merge CUrl options.

If each options array has an element with the same key value, the latter will overwrite the former.

protected array mergeCurlOptions ( $options1, $options2 )
$options1 array

Options to be merged to.

$options2 array

Options to be merged from. You can specify additional arrays via third argument, fourth argument etc.

return array

Merged options (the original options are not changed.)

                protected function mergeCurlOptions($options1, $options2)
{
    $args = func_get_args();
    $res = array_shift($args);
    while (!empty($args)) {
        $next = array_shift($args);
        foreach ($next as $k => $v) {
            if (is_array($v) && !empty($res[$k]) && is_array($res[$k])) {
                $res[$k] = array_merge($res[$k], $v);
            } else {
                $res[$k] = $v;
            }
        }
    }
    return $res;
}

            
normalizeUserAttributes() protected method

Defined in: yii\authclient\BaseClient::normalizeUserAttributes()

Normalize given user attributes according to $normalizeUserAttributeMap.

protected array normalizeUserAttributes ( $attributes )
$attributes array

Raw attributes.

return array

Normalized attributes.

throws \yii\base\InvalidConfigException

on incorrect normalize attribute map.

                protected function normalizeUserAttributes($attributes)
{
    foreach ($this->getNormalizeUserAttributeMap() as $normalizedName => $actualName) {
        if (is_scalar($actualName)) {
            if (array_key_exists($actualName, $attributes)) {
                $attributes[$normalizedName] = $attributes[$actualName];
            }
        } else {
            if (is_callable($actualName)) {
                $attributes[$normalizedName] = call_user_func($actualName, $attributes);
            } elseif (is_array($actualName)) {
                $haystack = $attributes;
                $searchKeys = $actualName;
                $isFound = true;
                while (($key = array_shift($searchKeys)) !== null) {
                    if (is_array($haystack) && array_key_exists($key, $haystack)) {
                        $haystack = $haystack[$key];
                    } else {
                        $isFound = false;
                        break;
                    }
                }
                if ($isFound) {
                    $attributes[$normalizedName] = $haystack;
                }
            } else {
                throw new InvalidConfigException('Invalid actual name "' . gettype($actualName) . '" specified at "' . get_class($this) . '::normalizeUserAttributeMap"');
            }
        }
    }
    return $attributes;
}

            
processResponse() protected method

Processes raw response converting it to actual data.

protected array processResponse ( $rawResponse, $contentType self::CONTENT_TYPE_AUTO )
$rawResponse string

Raw response.

$contentType string

Response content type.

return array

Actual response.

throws \yii\base\Exception

on failure.

                protected function processResponse($rawResponse, $contentType = self::CONTENT_TYPE_AUTO)
{
    if (empty($rawResponse)) {
        return [];
    }
    switch ($contentType) {
        case self::CONTENT_TYPE_AUTO: {
            $contentType = $this->determineContentTypeByRaw($rawResponse);
            if ($contentType == self::CONTENT_TYPE_AUTO) {
                throw new Exception('Unable to determine response content type automatically.');
            }
            $response = $this->processResponse($rawResponse, $contentType);
            break;
        }
        case self::CONTENT_TYPE_JSON: {
            $response = Json::decode($rawResponse, true);
            break;
        }
        case self::CONTENT_TYPE_URLENCODED: {
            $response = [];
            parse_str($rawResponse, $response);
            break;
        }
        case self::CONTENT_TYPE_XML: {
            $response = $this->convertXmlToArray($rawResponse);
            break;
        }
        default: {
            throw new Exception('Unknown response type "' . $contentType . '".');
        }
    }
    return $response;
}

            
refreshAccessToken() public abstract method

Gets new auth token to replace expired one.

public abstract yii\authclient\OAuthToken refreshAccessToken ( yii\authclient\OAuthToken $token )
$token yii\authclient\OAuthToken

Expired auth token.

return yii\authclient\OAuthToken

New auth token.

                abstract public function refreshAccessToken(OAuthToken $token);

            
removeState() protected method

Removes persistent state value.

protected boolean removeState ( $key )
$key string

State key.

return boolean

Success.

                protected function removeState($key)
{
    if (!Yii::$app->has('session')) {
        return true;
    }
    /* @var \yii\web\Session $session */
    $session = Yii::$app->get('session');
    $key = $this->getStateKeyPrefix() . $key;
    $session->remove($key);
    return true;
}

            
restoreAccessToken() protected method

Restores access token.

protected yii\authclient\OAuthToken restoreAccessToken ( )
return yii\authclient\OAuthToken

Auth token.

                protected function restoreAccessToken()
{
    $token = $this->getState('token');
    if (is_object($token)) {
        /* @var $token OAuthToken */
        if ($token->getIsExpired() && $this->autoRefreshAccessToken) {
            $token = $this->refreshAccessToken($token);
        }
    }
    return $token;
}

            
saveAccessToken() protected method

Saves token as persistent state.

protected $this saveAccessToken ( yii\authclient\OAuthToken $token )
$token yii\authclient\OAuthToken

Auth token

return $this

The object itself.

                protected function saveAccessToken(OAuthToken $token)
{
    return $this->setState('token', $token);
}

            
sendRequest() protected method

Sends HTTP request.

protected array sendRequest ( $method, $url, array $params = [], array $headers = [] )
$method string

Request type.

$url string

Request URL.

$params array

Request params.

$headers array

Additional request headers.

return array

Response.

throws \yii\base\Exception

on failure.

                protected function sendRequest($method, $url, array $params = [], array $headers = [])
{
    $curlOptions = $this->mergeCurlOptions(
        $this->defaultCurlOptions(),
        $this->getCurlOptions(),
        [
            CURLOPT_HTTPHEADER => $headers,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_URL => $url,
        ],
        $this->composeRequestCurlOptions(strtoupper($method), $url, $params)
    );
    $curlResource = curl_init();
    foreach ($curlOptions as $option => $value) {
        curl_setopt($curlResource, $option, $value);
    }
    $response = curl_exec($curlResource);
    $responseHeaders = curl_getinfo($curlResource);
    // check cURL error
    $errorNumber = curl_errno($curlResource);
    $errorMessage = curl_error($curlResource);
    curl_close($curlResource);
    if ($errorNumber > 0) {
        throw new Exception('Curl error requesting "' .  $url . '": #' . $errorNumber . ' - ' . $errorMessage);
    }
    if (strncmp($responseHeaders['http_code'], '20', 2) !== 0) {
        throw new InvalidResponseException($responseHeaders, $response, 'Request failed with code: ' . $responseHeaders['http_code'] . ', message: ' . $response);
    }
    return $this->processResponse($response, $this->determineContentTypeByHeaders($responseHeaders));
}

            
setAccessToken() public method

public void setAccessToken ( $token )
$token array|yii\authclient\OAuthToken

                public function setAccessToken($token)
{
    if (!is_object($token)) {
        $token = $this->createToken($token);
    }
    $this->_accessToken = $token;
    $this->saveAccessToken($token);
}

            
setCurlOptions() public method

public void setCurlOptions ( array $curlOptions )
$curlOptions array

CURL options.

                public function setCurlOptions(array $curlOptions)
{
    $this->_curlOptions = $curlOptions;
}

            
setId() public method
public void setId ( $id )
$id string

Service id.

                public function setId($id)
{
    $this->_id = $id;
}

            
setName() public method
public void setName ( $name )
$name string

Service name.

                public function setName($name)
{
    $this->_name = $name;
}

            
setNormalizeUserAttributeMap() public method
public void setNormalizeUserAttributeMap ( $normalizeUserAttributeMap )
$normalizeUserAttributeMap array

Normalize user attribute map.

                public function setNormalizeUserAttributeMap($normalizeUserAttributeMap)
{
    $this->_normalizeUserAttributeMap = $normalizeUserAttributeMap;
}

            
setReturnUrl() public method

public void setReturnUrl ( $returnUrl )
$returnUrl string

Return URL

                public function setReturnUrl($returnUrl)
{
    $this->_returnUrl = $returnUrl;
}

            
setSignatureMethod() public method

public void setSignatureMethod ( $signatureMethod )
$signatureMethod array|yii\authclient\signature\BaseMethod

Signature method instance or its array configuration.

throws \yii\base\InvalidParamException

on wrong argument.

                public function setSignatureMethod($signatureMethod)
{
    if (!is_object($signatureMethod) && !is_array($signatureMethod)) {
        throw new InvalidParamException('"' . get_class($this) . '::signatureMethod" should be instance of "\yii\autclient\signature\BaseMethod" or its array configuration. "' . gettype($signatureMethod) . '" has been given.');
    }
    $this->_signatureMethod = $signatureMethod;
}

            
setState() protected method

Sets persistent state.

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

State key.

$value mixed

State value

return $this

The object itself

                protected function setState($key, $value)
{
    if (!Yii::$app->has('session')) {
        return $this;
    }
    /* @var \yii\web\Session $session */
    $session = Yii::$app->get('session');
    $key = $this->getStateKeyPrefix() . $key;
    $session->set($key, $value);
    return $this;
}

            
setTitle() public method
public void setTitle ( $title )
$title string

Service title.

                public function setTitle($title)
{
    $this->_title = $title;
}

            
setUserAttributes() public method
public void setUserAttributes ( $userAttributes )
$userAttributes array

List of user attributes

                public function setUserAttributes($userAttributes)
{
    $this->_userAttributes = $this->normalizeUserAttributes($userAttributes);
}

            
setViewOptions() public method
public void setViewOptions ( $viewOptions )
$viewOptions array

View options in format: optionName => optionValue

                public function setViewOptions($viewOptions)
{
    $this->_viewOptions = $viewOptions;
}