Browse Source

minor doc fix.

tags/2.0.0-beta
Qiang Xue 11 years ago
parent
commit
5a8517f194
  1. 10
      extensions/yii/authclient/README.md
  2. 4
      extensions/yii/authclient/widgets/Choice.php

10
extensions/yii/authclient/README.md

@ -21,7 +21,7 @@ or add
"yiisoft/yii2-authclient": "*" "yiisoft/yii2-authclient": "*"
``` ```
to the require section of your composer.json. to the `require` section of your composer.json.
Usage & Documentation Usage & Documentation
@ -51,7 +51,7 @@ You need to setup auth client collection application component:
] ]
``` ```
Then you need to apply [[yii\authclient\AuthAction]] to some of your web controllers: Then you need to add [[yii\authclient\AuthAction]] to some of your web controllers:
``` ```
class SiteController extends Controller class SiteController extends Controller
@ -68,7 +68,7 @@ class SiteController extends Controller
public function successCallback($client) public function successCallback($client)
{ {
$atributes = $client->getUserAttributes(); $attributes = $client->getUserAttributes();
// user login or signup comes here // user login or signup comes here
} }
} }
@ -79,5 +79,5 @@ You may use [[yii\authclient\widgets\Choice]] to compose auth client selection:
``` ```
<?= yii\authclient\Choice::widget([ <?= yii\authclient\Choice::widget([
'baseAuthUrl' => ['site/auth'] 'baseAuthUrl' => ['site/auth']
]); ?> ]) ?>
``` ```

4
extensions/yii/authclient/widgets/Choice.php

@ -56,7 +56,7 @@ class Choice extends Widget
private $_clients; private $_clients;
/** /**
* @var string name of the auth client collection application component. * @var string name of the auth client collection application component.
* This component will be used to fetch {@link services} value if it is not set. * This component will be used to fetch services value if it is not set.
*/ */
public $clientCollection = 'authClientCollection'; public $clientCollection = 'authClientCollection';
/** /**
@ -226,4 +226,4 @@ class Choice extends Widget
} }
echo Html::endTag('div'); echo Html::endTag('div');
} }
} }

Loading…
Cancel
Save