Class yii\authclient\clients\GitHub
| Inheritance | yii\authclient\clients\GitHub » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component |
|---|---|
| Implements | yii\authclient\ClientInterface |
| Available since extension's version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/clients/GitHub.php |
GitHub allows authentication via GitHub OAuth.
In order to use GitHub OAuth you must register your application at https://github.com/settings/applications/new.
Example application configuration:
'components' => [ 'authClientCollection' => [ 'class' => 'yii\authclient\Collection', 'clients' => [ 'github' => [ 'class' => 'yii\authclient\clients\GitHub', 'clientId' => 'github_client_id', 'clientSecret' => 'github_client_secret', ], ], ] ... ] See also:
Public Properties
Public Methods
Protected Methods
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
Authorize URL.
Method Details
Defined in: yii\authclient\BaseOAuth::api()
Performs request to the OAuth API.
| public array api ( string $apiSubUrl, string $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); } Defined in: yii\authclient\OAuth2::apiInternal()
Performs request to the OAuth API.
| protected array apiInternal ( mixed $accessToken, mixed $url, mixed $method, array $params, array $headers ) | ||
| $accessToken | mixed | Actual access token. |
| $url | mixed | Absolute API URL. |
| $method | mixed | Request method. |
| $params | array | Request parameters. |
| $headers | array | Additional request headers. |
| return | array | API response. |
|---|---|---|
| throws | \yii\base\Exception | on failure. |
protected function apiInternal($accessToken, $url, $method, array $params, array $headers) { $params['access_token'] = $accessToken->getToken(); return $this->sendRequest($method, $url, $params, $headers); } Defined in: yii\authclient\OAuth2::buildAuthUrl()
Composes user authorization URL.
| public string buildAuthUrl ( array $params = [] ) | ||
| $params | array | Additional auth GET params. |
| return | string | Authorization URL. |
|---|---|---|
public function buildAuthUrl(array $params = []) { $defaultParams = [ 'client_id' => $this->clientId, 'response_type' => 'code', 'redirect_uri' => $this->getReturnUrl(), 'xoauth_displayname' => Yii::$app->name, ]; if (!empty($this->scope)) { $defaultParams['scope'] = $this->scope; } return $this->composeUrl($this->authUrl, array_merge($defaultParams, $params)); } Defined in: yii\authclient\OAuth2::composeRequestCurlOptions()
Composes HTTP request CUrl options, which will be merged with the default ones.
| protected array composeRequestCurlOptions ( string $method, string $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. |
protected function composeRequestCurlOptions($method, $url, array $params) { $curlOptions = []; switch ($method) { case 'GET': { $curlOptions[CURLOPT_URL] = $this->composeUrl($url, $params); break; } case 'POST': { $curlOptions[CURLOPT_POST] = true; $curlOptions[CURLOPT_HTTPHEADER] = ['Content-type: application/x-www-form-urlencoded']; $curlOptions[CURLOPT_POSTFIELDS] = http_build_query($params, '', '&', PHP_QUERY_RFC3986); break; } case 'HEAD': { $curlOptions[CURLOPT_CUSTOMREQUEST] = $method; if (!empty($params)) { $curlOptions[CURLOPT_URL] = $this->composeUrl($url, $params); } break; } default: { $curlOptions[CURLOPT_CUSTOMREQUEST] = $method; if (!empty($params)) { $curlOptions[CURLOPT_POSTFIELDS] = $params; } } } return $curlOptions; } Defined in: yii\authclient\BaseOAuth::composeUrl()
Composes URL from base URL and GET params.
| protected string composeUrl ( string $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; } Defined in: yii\authclient\BaseOAuth::convertXmlToArray()
Converts XML document to array.
| protected array convertXmlToArray ( string|SimpleXMLElement $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; } Defined in: yii\authclient\BaseOAuth::createSignatureMethod()
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); } Defined in: yii\authclient\OAuth2::createToken()
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 = []) { $tokenConfig['tokenParamKey'] = 'access_token'; return parent::createToken($tokenConfig); } Defined in: yii\authclient\BaseOAuth::defaultCurlOptions()
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, ]; } Generates service name.
| protected string defaultName ( ) | ||
| return | string | Service name. |
|---|---|---|
protected function defaultName() { return 'github'; } 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 []; } Defined in: yii\authclient\OAuth2::defaultReturnUrl()
Composes default $returnUrl value.
| protected string defaultReturnUrl ( ) | ||
| return | string | Return URL. |
|---|---|---|
protected function defaultReturnUrl() { $params = $_GET; unset($params['code']); $params[0] = Yii::$app->controller->getRoute(); return Yii::$app->getUrlManager()->createAbsoluteUrl($params); } Generates service title.
| protected string defaultTitle ( ) | ||
| return | string | Service title. |
|---|---|---|
protected function defaultTitle() { return 'GitHub'; } 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 []; } Defined in: yii\authclient\BaseOAuth::determineContentTypeByHeaders()
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; } Defined in: yii\authclient\BaseOAuth::determineContentTypeByRaw()
Attempts to determine the content type from raw content.
| protected string determineContentTypeByRaw ( string $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; } Defined in: yii\authclient\OAuth2::fetchAccessToken()
Fetches access token from authorization code.
| public yii\authclient\OAuthToken fetchAccessToken ( string $authCode, array $params = [] ) | ||
| $authCode | string | Authorization code, usually comes at $_GET['code']. |
| $params | array | Additional request params. |
| return | yii\authclient\OAuthToken | Access token. |
|---|---|---|
public function fetchAccessToken($authCode, array $params = []) { $defaultParams = [ 'client_id' => $this->clientId, 'client_secret' => $this->clientSecret, 'code' => $authCode, 'grant_type' => 'authorization_code', 'redirect_uri' => $this->getReturnUrl(), ]; $response = $this->sendRequest('POST', $this->tokenUrl, array_merge($defaultParams, $params)); $token = $this->createToken(['params' => $response]); $this->setAccessToken($token); return $token; } Defined in: yii\authclient\BaseOAuth::getAccessToken()
| 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; } Defined in: yii\authclient\BaseOAuth::getCurlOptions()
| public array getCurlOptions ( ) | ||
| return | array | CURL options. |
|---|---|---|
public function getCurlOptions() { return $this->_curlOptions; } Defined in: yii\authclient\BaseClient::getId()
| public string getId ( ) | ||
| return | string | Service id |
|---|---|---|
public function getId() { if (empty($this->_id)) { $this->_id = $this->getName(); } return $this->_id; } Defined in: yii\authclient\BaseClient::getName()
| public string getName ( ) | ||
| return | string | Service name. |
|---|---|---|
public function getName() { if ($this->_name === null) { $this->_name = $this->defaultName(); } return $this->_name; } | public array getNormalizeUserAttributeMap ( ) | ||
| return | array | Normalize user attribute map. |
|---|---|---|
public function getNormalizeUserAttributeMap() { if ($this->_normalizeUserAttributeMap === null) { $this->_normalizeUserAttributeMap = $this->defaultNormalizeUserAttributeMap(); } return $this->_normalizeUserAttributeMap; } Defined in: yii\authclient\BaseOAuth::getReturnUrl()
| public string getReturnUrl ( ) | ||
| return | string | Return URL. |
|---|---|---|
public function getReturnUrl() { if ($this->_returnUrl === null) { $this->_returnUrl = $this->defaultReturnUrl(); } return $this->_returnUrl; } Defined in: yii\authclient\BaseOAuth::getSignatureMethod()
| 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; } Defined in: yii\authclient\BaseOAuth::getState()
Returns persistent state value.
| protected mixed getState ( string $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; } Defined in: yii\authclient\BaseOAuth::getStateKeyPrefix()
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) . '_'; } Defined in: yii\authclient\BaseClient::getTitle()
| public string getTitle ( ) | ||
| return | string | Service title. |
|---|---|---|
public function getTitle() { if ($this->_title === null) { $this->_title = $this->defaultTitle(); } return $this->_title; } Defined in: yii\authclient\BaseClient::getUserAttributes()
| 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; } Defined in: yii\authclient\BaseClient::getViewOptions()
| 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; }
| public init ( ) |
public function init() { parent::init(); if ($this->scope === null) { $this->scope = 'user'; } } Initializes authenticated user attributes.
| protected array initUserAttributes ( ) | ||
| return | array | Auth user attributes. |
|---|---|---|
protected function initUserAttributes() { $attributes = $this->api('user', 'GET'); if (empty($attributes['email'])) { // in case user set 'Keep my email address private' in GitHub profile, email should be retrieved via extra API request $scopes = explode(' ', $this->scope); if (in_array('user:email', $scopes, true) || in_array('user', $scopes, true)) { $emails = $this->api('user/emails', 'GET'); if (!empty($emails)) { foreach ($emails as $email) { if ($email['primary'] == 1 && $email['verified'] == 1) { $attributes['email'] = $email['email']; break; } } } } } return $attributes; } Defined in: yii\authclient\BaseOAuth::mergeCurlOptions()
Merge CUrl options.
If each options array has an element with the same key value, the latter will overwrite the former.
| protected array mergeCurlOptions ( array $options1, array $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; } Defined in: yii\authclient\BaseClient::normalizeUserAttributes()
Normalize given user attributes according to $normalizeUserAttributeMap.
| protected array normalizeUserAttributes ( array $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; } Defined in: yii\authclient\BaseOAuth::processResponse()
Processes raw response converting it to actual data.
| protected array processResponse ( string $rawResponse, string $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; } Defined in: yii\authclient\OAuth2::refreshAccessToken()
Gets new auth token to replace expired one.
| public yii\authclient\OAuthToken refreshAccessToken ( yii\authclient\OAuthToken $token ) | ||
| $token | yii\authclient\OAuthToken | Expired auth token. |
| return | yii\authclient\OAuthToken | New auth token. |
|---|---|---|
public function refreshAccessToken(OAuthToken $token) { $params = [ 'client_id' => $this->clientId, 'client_secret' => $this->clientSecret, 'grant_type' => 'refresh_token' ]; $params = array_merge($token->getParams(), $params); $response = $this->sendRequest('POST', $this->tokenUrl, $params); $token = $this->createToken(['params' => $response]); $this->setAccessToken($token); return $token; } Defined in: yii\authclient\BaseOAuth::removeState()
Removes persistent state value.
| protected boolean removeState ( string $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; } Defined in: yii\authclient\BaseOAuth::restoreAccessToken()
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; } Defined in: yii\authclient\BaseOAuth::saveAccessToken()
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); } Defined in: yii\authclient\BaseOAuth::sendRequest()
Sends HTTP request.
| protected array sendRequest ( string $method, string $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)); } Defined in: yii\authclient\BaseOAuth::setAccessToken()
| public mixed setAccessToken ( array|yii\authclient\OAuthToken $token ) | ||
| $token | array|yii\authclient\OAuthToken | |
public function setAccessToken($token) { if (!is_object($token)) { $token = $this->createToken($token); } $this->_accessToken = $token; $this->saveAccessToken($token); } Defined in: yii\authclient\BaseOAuth::setCurlOptions()
| public mixed setCurlOptions ( array $curlOptions ) | ||
| $curlOptions | array | CURL options. |
public function setCurlOptions(array $curlOptions) { $this->_curlOptions = $curlOptions; } Defined in: yii\authclient\BaseClient::setId()
| public mixed setId ( string $id ) | ||
| $id | string | Service id. |
public function setId($id) { $this->_id = $id; } Defined in: yii\authclient\BaseClient::setName()
| public mixed setName ( string $name ) | ||
| $name | string | Service name. |
public function setName($name) { $this->_name = $name; } | public mixed setNormalizeUserAttributeMap ( array $normalizeUserAttributeMap ) | ||
| $normalizeUserAttributeMap | array | Normalize user attribute map. |
public function setNormalizeUserAttributeMap($normalizeUserAttributeMap) { $this->_normalizeUserAttributeMap = $normalizeUserAttributeMap; } Defined in: yii\authclient\BaseOAuth::setReturnUrl()
| public mixed setReturnUrl ( string $returnUrl ) | ||
| $returnUrl | string | Return URL |
public function setReturnUrl($returnUrl) { $this->_returnUrl = $returnUrl; } Defined in: yii\authclient\BaseOAuth::setSignatureMethod()
| public mixed setSignatureMethod ( array|yii\authclient\signature\BaseMethod $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; } Defined in: yii\authclient\BaseOAuth::setState()
Sets persistent state.
| protected $this setState ( string $key, mixed $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; } Defined in: yii\authclient\BaseClient::setTitle()
| public mixed setTitle ( string $title ) | ||
| $title | string | Service title. |
public function setTitle($title) { $this->_title = $title; } Defined in: yii\authclient\BaseClient::setUserAttributes()
| public mixed setUserAttributes ( array $userAttributes ) | ||
| $userAttributes | array | List of user attributes |
public function setUserAttributes($userAttributes) { $this->_userAttributes = $this->normalizeUserAttributes($userAttributes); } Defined in: yii\authclient\BaseClient::setViewOptions()
| public mixed setViewOptions ( array $viewOptions ) | ||
| $viewOptions | array | View options in format: optionName => optionValue |
public function setViewOptions($viewOptions) { $this->_viewOptions = $viewOptions; }