• Главная
• yii
• authclient
• widgets
• AuthChoice

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

It opens a popup window for the client authentication process. By default this widget relies on presence of Collection among application components to get auth clients information. Example: php ['site/auth'] ]); ?> You can customize the widget appearance by using [[begin()]] and [[end()]] syntax along with using method AuthChoice::clientLink or AuthChoice::createClientUrl. For example: php ['site/auth'] ]); ?>

getClients() as $client): ?>
• clientLink($client) ?>

This widget supports following keys for [[ClientInterface::getViewOptions()]] result: - popupWidth: int, width of the popup window in pixels. - popupHeight: int, height of the popup window in pixels. - widget: array, configuration for the widget, which should be used to render a client link; such widget should be a subclass of [[AuthChoiceItem]]. Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство	Тип	Описание
$autoRender		indicates if widget content, should be rendered automatically. Note: this value automatically set to 'false' at the first call of AuthChoice::createClientUrl
$clientCollection		name of the auth client collection application component. This component will be used to fetch services value if it is not set.
$clientIdGetParamName		name of the GET param , which should be used to passed auth client id to URL defined by [[baseAuthUrl]].
$clientOptions		additional options to be passed to the underlying JS plugin.
$options		the HTML attributes that should be rendered in the div HTML tag representing the container element.
$popupMode		indicates if popup window should be used instead of direct links.

Открытые методы

Метод	Описание
clientLink ( yii\authclient\ClientInterface $client, string $text = null, array $htmlOptions = [] ) : string	Outputs client auth link.
createClientUrl ( yii\authclient\ClientInterface $client ) : string	Composes client auth URL.
getBaseAuthUrl ( ) : array
getClients ( ) : yii\authclient\ClientInterface[]
init ( )	Initializes the widget.
run ( ) : string	Runs the widget.
setBaseAuthUrl ( array $baseAuthUrl )
setClients ( array $clients )

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

Метод	Описание
defaultBaseAuthUrl ( ) : array	Composes default base auth URL configuration.
defaultClients ( ) : yii\authclient\ClientInterface[]	Returns default auth clients list.
renderMainContent ( ) : string	Renders the main content, which includes all external services links.

Описание методов

Описание свойств