Класс yii\authclient\widgets\GooglePlusButton
| Наследование | yii\authclient\widgets\GooglePlusButton » yii\authclient\widgets\AuthChoiceItem » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/widgets/GooglePlusButton.php |
GooglePlusButton отображает кнопку входа в Google+.
Этот виджет предназначен для взаимодействия с yii\authclient\clients\GoogleHybrid.
См. также:
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $authChoice | yii\authclient\widgets\AuthChoice | Родительский виджет AuthChoice | yii\authclient\widgets\AuthChoiceItem |
| $autoIdPrefix | строка | Префикс для автоматически генерируемых идентификаторов виджетов. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список поведений, прикреплённых к этому компоненту | yii\base\Component |
| $buttonHtmlOptions | массив | HTML-атрибуты тега кнопки, которые будут объединены с предустановленными. | yii\authclient\widgets\GooglePlusButton |
| $callback | строка|массив | Имя JavaScript-функции обратного вызова или конфигурация URL. | yii\authclient\widgets\GooglePlusButton |
| $client | yii\authclient\ClientInterface | Экземпляр клиента авторизации. | yii\authclient\widgets\AuthChoiceItem |
| $counter | целое число | Счётчик, используемый для генерации $id виджетов. | yii\base\Widget |
| $id | строка | Идентификатор виджета. | yii\base\Widget |
| $stack | yii\base\Widget[] | Виджеты, которые в настоящее время отображаются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который можно использовать для отображения представлений или файлов представлений. | yii\base\Widget |
| $viewPath | строка | Директория, содержащая файлы представлений для данного виджета. | yii\base\Widget |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т. е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в null. | yii\base\Object |
| afterRun() | Этот метод вызывается сразу после выполнения виджета. | yii\base\Widget |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| beforeRun() | Этот метод вызывается непосредственно перед выполнением виджета. | yii\base\Widget |
| begin() | Начинает работу виджета. | yii\base\Widget |
| behaviors() | Возвращает список поведений, которые должен выполнять этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершает работу виджета. | yii\base\Widget |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), прикреплены к этому компоненту. | yii\base\Component |
| getBehavior() | Возвращает объект поведения с указанным именем. | yii\base\Component |
| getBehaviors() | Возвращает все прикрепленные к этому компоненту поведения. | yii\base\Component |
| getCallback() | yii\authclient\widgets\GooglePlusButton | |
| getId() | Возвращает идентификатор виджета. | yii\base\Widget |
| getView() | Возвращает объект представления, который можно использовать для рендеринга представлений или файлов представлений. | yii\base\Widget |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для этого виджета. | yii\base\Widget |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчики, прикрепленные к событию с указанным именем. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определен ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует виджет. | yii\authclient\widgets\GooglePlusButton |
| off() | Отсоединяет существующий обработчик событий от этого компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\authclient\widgets\GooglePlusButton |
| setCallback() | yii\authclient\widgets\GooglePlusButton | |
| setId() | Устанавливает идентификатор виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который будет использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
Защищенные методы
| Метод | Описание | Определено в |
|---|---|---|
| generateCallback() | Генерирует JavaScript-функцию обратного вызова, которая будет использована для обработки ответа авторизации. | yii\authclient\widgets\GooglePlusButton |
| registerClientScript() | Регистрирует необходимый JavaScript. | yii\authclient\widgets\GooglePlusButton |
| renderButton() | Рендерит кнопку входа. | yii\authclient\widgets\GooglePlusButton |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| EVENT_AFTER_RUN | yii\base\WidgetEvent | Событие, поднимаемое сразу после выполнения виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_BEFORE_RUN | yii\base\WidgetEvent | Событие, поднимаемое непосредственно перед выполнением виджета. (доступно начиная с версии 2.0.11) | yii\base\Widget |
| EVENT_INIT | yii\base\Event | Событие, которое срабатывает при инициализации виджета через init(). (доступно начиная с версии 2.0.11) | yii\base\Widget |
Подробное описание свойств
$buttonHtmlOptions публичное свойство
HTML-атрибуты тега кнопки, которые будут объединены с базовыми.
public array $buttonHtmlOptions = []
$callback публичное свойство
Имя JavaScript-функции обратного вызова или конфигурация URL.
public string getCallback ( )
public void setCallback ( $callback )
Подробное описание методов
generateCallback() защищенный метод
Генерирует JavaScript функцию обратного вызова, которая будет использоваться для обработки ответа авторизации.
| защищенный string generateCallback ( $url = [] ) | ||
|---|---|---|
| $url | array |
URL обратного вызова авторизации. |
| return | string |
Имя JavaScript функции. |
getCallback() публичный метод
| публичный string getCallback ( ) | ||
|---|---|---|
| return | string |
Имя JavaScript функции обратного вызова. |
init() публичный метод
Инициализирует виджет.
| публичный void init ( ) |
|---|
registerClientScript() защищенный метод
Регистрирует необходимый JavaScript.
| защищенный void registerClientScript ( ) |
|---|
renderButton() защищенный метод
Отображает кнопку входа.
| защищенный string renderButton ( ) | ||
|---|---|---|
| return | string |
HTML кнопки. |
run() публичный метод
Выполняет виджет.
| публичный void run ( ) |
|---|
setCallback() публичный метод
| публичный void setCallback ( $callback ) | ||
|---|---|---|
| $callback | string|array |
Имя JavaScript функции обратного вызова или конфигурация URL. |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-widgets-googleplusbutton.html
