Class yii\authclient\clients\GoogleHybrid

Inheritanceyii\authclient\clients\GoogleHybrid » yii\authclient\clients\GoogleOAuth » yii\authclient\OAuth2 » yii\authclient\BaseOAuth » yii\authclient\BaseClient » yii\base\Component
Implementsyii\authclient\ClientInterface
Available since version2.0

GoogleHybrid is an enhanced version of the yii\authclient\clients\GoogleOAuth, which uses Google+ hybrid sign-in flow, which relies on embedded JavaScript code to generate a sign-in button.

Example application configuration:

'components' => [
    'authClientCollection' => [
        'class' => 'yii\authclient\Collection',
        'clients' => [
            'google' => [
                'class' => 'yii\authclient\clients\GoogleHybrid',
                'clientId' => 'google_client_id',
                'clientSecret' => 'google_client_secret',
            ],
        ],
    ]
    ...
]

JavaScript button itself generated by \yii\authclient\clients\yii\authclient\widgets\GooglePlusButton widget. If you are using \yii\authclient\clients\yii\authclient\widgets\AuthChoice it will appear automatically. Otherwise you need to add it into your page manually. You may customize its appearance using 'widget' key at \yii\authclient\clients\viewOptions:

'google' => [
    ...
    'viewOptions' => [
        'widget' => [
            'class' => 'yii\authclient\widgets\GooglePlusButton',
            'buttonHtmlOptions' => [
                'data-approvalprompt' => 'force'
            ],
        ],
    ],
],

See also:

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$apiBaseUrl string API base URL. yii\authclient\clients\GoogleOAuth
$authUrl string Authorize URL. yii\authclient\clients\GoogleOAuth
$autoRefreshAccessToken boolean Whether to automatically perform 'refresh access token' request on expired access token. yii\authclient\BaseOAuth
$clientId string OAuth client ID. yii\authclient\OAuth2
$clientSecret string OAuth client secret. yii\authclient\OAuth2
$scope string Auth request scope. yii\authclient\BaseOAuth
$tokenUrl string Token request URL endpoint. yii\authclient\clients\GoogleOAuth
$version string Protocol version. yii\authclient\BaseOAuth

Protected Methods

Hide inherited methods

MethodDescriptionDefined 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\clients\GoogleOAuth
defaultNormalizeUserAttributeMap() Returns the default \yii\authclient\normalizeUserAttributeMap value. yii\authclient\BaseClient
defaultReturnUrl() Composes default \yii\authclient\clients\returnUrl value. yii\authclient\clients\GoogleHybrid
defaultTitle() Generates service title. yii\authclient\clients\GoogleOAuth
defaultViewOptions() Returns the default \yii\authclient\clients\viewOptions value. yii\authclient\clients\GoogleHybrid
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\clients\GoogleOAuth
mergeCurlOptions() Merge CUrl options. yii\authclient\BaseOAuth
normalizeUserAttributes() Normalize given user attributes according to \yii\authclient\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

ConstantValueDescriptionDefined 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

Method Details

defaultReturnUrl() protected method

Composes default \yii\authclient\clients\returnUrl value.

protected string defaultReturnUrl ( )
return string

Return URL.

defaultViewOptions() protected method

Returns the default \yii\authclient\clients\viewOptions value.

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

protected array defaultViewOptions ( )
return array

List of default \yii\authclient\clients\viewOptions