Класс yii\authclient\widgets\AuthChoice

AuthChoice отображает кнопки для аутентификации через различные поставщики аутентификации.

Он открывает всплывающее окно для процесса аутентификации клиента. По умолчанию этот виджет полагается на наличие компонента yii\authclient\Collection среди компонентов приложения для получения информации о поставщиках аутентификации.

Пример:

<?= yii\authclient\widgets\AuthChoice::widget([
    'baseAuthUrl' => ['site/auth']
]); ?>

Вы можете настроить внешний вид виджета, используя синтаксис begin() и end() вместе с использованием метода clientLink() или createClientUrl(). Например:

<?php
use yii\authclient\widgets\AuthChoice;
?>
<?php $authAuthChoice = AuthChoice::begin([
    'baseAuthUrl' => ['site/auth']
]); ?>
<ul>
<?php foreach ($authAuthChoice->getClients() as $client): ?>
    <li><?= $authAuthChoice->clientLink($client) ?></li>
<?php endforeach; ?>
</ul>
<?php AuthChoice::end(); ?>

Этот виджет поддерживает следующие ключи для результата yii\authclient\ClientInterface::getViewOptions():

• popupWidth: int, ширина всплывающего окна в пикселях.
• popupHeight: int, высота всплывающего окна в пикселях.
• widget: массив, конфигурация для виджета, который должен использоваться для отображения ссылки клиента; такой виджет должен быть подклассом yii\authclient\widgets\AuthChoiceItem.

См. также yii\authclient\AuthAction.

Свойства

Методы

Защищенные методы

События

Подробности свойств

$autoRender общественное свойство

Указывает, должен ли контент виджета отображаться автоматически. Примечание: это значение автоматически устанавливается в 'false' при первом вызове createClientUrl().

public boolean $autoRender = true

$baseAuthUrl общественное свойство

Конфигурация базового URL авторизации.

public array getBaseAuthUrl ( )
public void setBaseAuthUrl ( array $baseAuthUrl )

$clientCollection общественное свойство

Имя компонента приложения для коллекции клиентов авторизации. Этот компонент будет использоваться для извлечения значений сервисов, если они не заданы.

public string $clientCollection = 'authClientCollection'

$clientIdGetParamName общественное свойство

Имя параметра GET, которое должно использоваться для передачи идентификатора клиента авторизации в URL, определенный $baseAuthUrl.

public string $clientIdGetParamName = 'authclient'

$clientOptions общественное свойство

Дополнительные параметры, которые нужно передать в базовый JS-плагин.

public array $clientOptions = []

$clients общественное свойство

Поставщики авторизации

public yii\authclient\ClientInterface[] getClients ( )
public void setClients ( array $clients )

$options общественное свойство

Атрибуты HTML, которые должны быть отображены в теге div, представляющем контейнерный элемент.

См. также yii\helpers\Html::renderTagAttributes() для получения подробностей об отображении атрибутов.

public array $options = []

$popupMode общественное свойство

Указывает, следует ли использовать всплывающее окно вместо прямых ссылок.

public boolean $popupMode = true

Подробности методов