Skip to content

Y
yii2
Commit 0765f1e5 by Klimov Paul
Options

Doc comments at "yii\authclient\widgets\Choice" extended.

parent ffb79133
Showing with 5 additions and 0 deletions
extensions/yii/authclient/widgets/Choice.php
...@@ -14,6 +14,7 @@ use yii\authclient\ClientInterface; ...@@ -14,6 +14,7 @@ use yii\authclient\ClientInterface;
/** /**
* Choice prints buttons for authentication via various auth clients. * Choice prints buttons for authentication via various auth clients.
* It opens a popup window for the client authentication process.
* By default this widget relies on presence of [[\yii\authclient\Collection]] among application components * By default this widget relies on presence of [[\yii\authclient\Collection]] among application components
* to get auth clients information. * to get auth clients information.
* *
...@@ -41,6 +42,10 @@ use yii\authclient\ClientInterface; ...@@ -41,6 +42,10 @@ use yii\authclient\ClientInterface;
* <?php yii\authclient\widgets\Choice::endWidget(); ?> * <?php yii\authclient\widgets\Choice::endWidget(); ?>
* ~~~ * ~~~
* *
* This widget supports following keys for [[ClientInterface::getViewOptions()]] result:
* - popupWidth - integer width of the popup window in pixels.
* - popupHeight - integer height of the popup window in pixels.
*
* @see \yii\authclient\AuthAction * @see \yii\authclient\AuthAction
* *
* @property array $baseAuthUrl Base auth URL configuration. This property is read-only. * @property array $baseAuthUrl Base auth URL configuration. This property is read-only.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment