Class yii\authclient\widgets\GooglePlusButton
| Inheritance | yii\authclient\widgets\GooglePlusButton » yii\authclient\widgets\AuthChoiceItem » yii\base\Widget » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\base\ViewContextInterface |
| Available since version | 2.0.4 |
| Source Code | https://github.com/yiisoft/yii2-authclient/blob/master/widgets/GooglePlusButton.php |
GooglePlusButton renders Google+ sign-in button.
This widget is designed to interact with yii\authclient\clients\GoogleHybrid.
See also:
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $authChoice | yii\authclient\widgets\AuthChoice | Parent AuthChoice widget | yii\authclient\widgets\AuthChoiceItem |
| $autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component |
| $buttonHtmlOptions | array | Button tag HTML options, which will be merged with the default ones. | yii\authclient\widgets\GooglePlusButton |
| $callback | string | Callback JavaScript function name. Note that the type of this property differs in getter and setter. See getCallback() and setCallback() for details. | yii\authclient\widgets\GooglePlusButton |
| $client | yii\authclient\ClientInterface | Auth client instance. | yii\authclient\widgets\AuthChoiceItem |
| $counter | integer | A counter used to generate $id for widgets. | yii\base\Widget |
| $id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget |
| $stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget |
| $view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget |
| $viewPath | string | The directory containing the view files for this widget. | yii\base\Widget |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget |
| begin() | Begins a widget. | yii\base\Widget |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| end() | Ends a widget. | yii\base\Widget |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getCallback() | yii\authclient\widgets\GooglePlusButton | |
| getId() | Returns the ID of the widget. | yii\base\Widget |
| getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget |
| getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the widget. | yii\authclient\widgets\GooglePlusButton |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| render() | Renders a view. | yii\base\Widget |
| renderFile() | Renders a view file. | yii\base\Widget |
| run() | Runs the widget. | yii\authclient\widgets\GooglePlusButton |
| setCallback() | yii\authclient\widgets\GooglePlusButton | |
| setId() | Sets the ID of the widget. | yii\base\Widget |
| setView() | Sets the view object to be used by this widget. | yii\base\Widget |
| trigger() | Triggers an event. | yii\base\Component |
| widget() | Creates a widget instance and runs it. | yii\base\Widget |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| generateCallback() | Generates JavaScript callback function, which will be used to handle auth response. | yii\authclient\widgets\GooglePlusButton |
| registerClientScript() | Registers necessary JavaScript. | yii\authclient\widgets\GooglePlusButton |
| renderButton() | Renders sign-in button. | yii\authclient\widgets\GooglePlusButton |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget |
Property Details
Button tag HTML options, which will be merged with the default ones.
Callback JavaScript function name. Note that the type of this property differs in getter and setter. See getCallback() and setCallback() for details.
Method Details
Generates JavaScript callback function, which will be used to handle auth response.
| protected string generateCallback ( $url = [] ) | ||
| $url | array | Auth callback URL. |
| return | string | JavaScript function name. |
|---|---|---|
| public string getCallback ( ) | ||
| return | string | Callback JavaScript function name. |
|---|---|---|
Initializes the widget.
| public void init ( ) |
Registers necessary JavaScript.
| protected void registerClientScript ( ) |
Renders sign-in button.
| protected string renderButton ( ) | ||
| return | string | Button HTML. |
|---|---|---|
Runs the widget.
| public void run ( ) |
| public void setCallback ( $callback ) | ||
| $callback | string|array | Callback JavaScript function name or URL config. |