Класс yii\authclient\widgets\AuthChoiceItem
| Наследование | yii\authclient\widgets\AuthChoiceItem » yii\base\Widget » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable, yii\base\ViewContextInterface |
| Подклассы | yii\authclient\widgets\GooglePlusButton |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2-authclient/blob/master/widgets/AuthChoiceItem.php |
AuthChoiceItem — базовый класс для создания виджетов, которые могут использоваться для отображения ссылки для клиента авторизации в yii\authclient\widgets\AuthChoice.
См. также yii\authclient\widgets\AuthChoice.
Публичные свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $authChoice | yii\authclient\widgets\AuthChoice | Родительский виджет AuthChoice | yii\authclient\widgets\AuthChoiceItem |
| $autoIdPrefix | string | Префикс для автоматически генерируемых идентификаторов виджетов. | yii\base\Widget |
| $behaviors | yii\base\Behavior[] | Список присоединённых к этому компоненту поведений. | yii\base\Component |
| $client | yii\authclient\ClientInterface | Экземпляр клиента авторизации. | yii\authclient\widgets\AuthChoiceItem |
| $counter | integer | Счётчик, используемый для генерации $id для виджетов. | yii\base\Widget |
| $id | string | Идентификатор виджета. | yii\base\Widget |
| $stack | yii\base\Widget[] | Виджеты, которые в данный момент отображаются (не завершены). | yii\base\Widget |
| $view | yii\web\View | Объект представления, который может использоваться для отображения представлений или файлов представлений. | yii\base\Widget |
| $viewPath | string | Директория, содержащая файлы представлений для этого виджета. | 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 |
| getId() | Возвращает ID виджета. | 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\base\Widget |
| off() | Отсоединяет существующий обработчик событий от данного компонента. | yii\base\Component |
| on() | Присоединяет обработчик событий к событию. | yii\base\Component |
| render() | Рендерит представление. | yii\base\Widget |
| renderFile() | Рендерит файл представления. | yii\base\Widget |
| run() | Выполняет виджет. | yii\base\Widget |
| setId() | Устанавливает ID виджета. | yii\base\Widget |
| setView() | Устанавливает объект представления, который должен использоваться этим виджетом. | yii\base\Widget |
| trigger() | Вызывает событие. | yii\base\Component |
| widget() | Создаёт экземпляр виджета и запускает его. | yii\base\Widget |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробное описание свойств
$authChoice открытое свойство
Родительский виджет AuthChoice
public yii\authclient\widgets\AuthChoice $authChoice = null
$client открытое свойство
Экземпляр клиента Auth.
public yii\authclient\ClientInterface $client = null
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-authclient-widgets-authchoiceitem.html
