Choice.php 6.32 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\authclient\widgets;

use yii\base\Widget;
use Yii;
use yii\helpers\Html;
13
use yii\authclient\ClientInterface;
14 15

/**
16
 * Choice prints buttons for authentication via various auth clients.
17
 * It opens a popup window for the client authentication process.
18 19 20 21
 * By default this widget relies on presence of [[\yii\authclient\Collection]] among application components
 * to get auth clients information.
 *
 * Example:
Qiang Xue committed
22 23 24
 *
 * ~~~php
 * <?= yii\authclient\widgets\Choice::widget([
25 26 27 28 29 30 31 32
 *     'baseAuthUrl' => ['site/auth']
 * ]); ?>
 * ~~~
 *
 * You can customize the widget appearance by using [[beginWidget()]] and [[endWidget()]] syntax
 * along with using method {@link clientLink()} or {@link createClientUrl()}.
 * For example:
 *
Qiang Xue committed
33 34
 * ~~~php
 * <?php $authChoice = yii\authclient\widgets\Choice::beginWidget([
35 36
 *     'baseAuthUrl' => ['site/auth']
 * ]); ?>
37 38 39 40 41
 * <ul>
 * <?php foreach ($authChoice->getClients() as $client): ?>
 *     <li><?= $authChoice->clientLink($client); ?></li>
 * <?php endforeach; ?>
 * </ul>
Qiang Xue committed
42
 * <?php yii\authclient\widgets\Choice::endWidget(); ?>
43
 * ~~~
44
 *
45 46 47 48
 * 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.
 *
49 50
 * @see \yii\authclient\AuthAction
 *
Qiang Xue committed
51 52
 * @property array $baseAuthUrl Base auth URL configuration. This property is read-only.
 * @property ClientInterface[] $clients Auth providers. This property is read-only.
53
 *
54 55 56 57 58 59
 * @author Paul Klimov <klimov.paul@gmail.com>
 * @since 2.0
 */
class Choice extends Widget
{
	/**
60
	 * @var string name of the auth client collection application component.
Qiang Xue committed
61
	 * This component will be used to fetch services value if it is not set.
62
	 */
63
	public $clientCollection = 'authClientCollection';
64
	/**
65
	 * @var string name of the GET param , which should be used to passed auth client id to URL
Qiang Xue committed
66
	 * defined by [[baseAuthUrl]].
67
	 */
68
	public $clientIdGetParamName = 'authclient';
69 70 71
	/**
	 * @var array the HTML attributes that should be rendered in the div HTML tag representing the container element.
	 */
Qiang Xue committed
72
	public $options = [
73
		'class' => 'auth-clients'
74 75 76 77 78 79 80 81 82 83 84
	];
	/**
	 * @var boolean indicates if popup window should be used instead of direct links.
	 */
	public $popupMode = true;
	/**
	 * @var boolean indicates if widget content, should be rendered automatically.
	 * Note: this value automatically set to 'false' at the first call of [[createProviderUrl()]]
	 */
	public $autoRender = true;

Qiang Xue committed
85 86 87 88 89 90 91 92 93
	/**
	 * @var array configuration for the external clients base authentication URL.
	 */
	private $_baseAuthUrl;
	/**
	 * @var ClientInterface[] auth providers list.
	 */
	private $_clients;

94
	/**
95
	 * @param ClientInterface[] $clients auth providers
96
	 */
97
	public function setClients(array $clients)
98
	{
99
		$this->_clients = $clients;
100 101 102
	}

	/**
103
	 * @return ClientInterface[] auth providers
104
	 */
105
	public function getClients()
106
	{
107 108
		if ($this->_clients === null) {
			$this->_clients = $this->defaultClients();
109
		}
110
		return $this->_clients;
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
	}

	/**
	 * @param array $baseAuthUrl base auth URL configuration.
	 */
	public function setBaseAuthUrl(array $baseAuthUrl)
	{
		$this->_baseAuthUrl = $baseAuthUrl;
	}

	/**
	 * @return array base auth URL configuration.
	 */
	public function getBaseAuthUrl()
	{
		if (!is_array($this->_baseAuthUrl)) {
			$this->_baseAuthUrl = $this->defaultBaseAuthUrl();
		}
		return $this->_baseAuthUrl;
	}

	/**
133 134
	 * Returns default auth clients list.
	 * @return ClientInterface[] auth clients list.
135
	 */
136
	protected function defaultClients()
137
	{
138 139 140
		/** @var $collection \yii\authclient\Collection */
		$collection = Yii::$app->getComponent($this->clientCollection);
		return $collection->getClients();
141 142 143 144 145 146 147 148 149 150 151 152
	}

	/**
	 * Composes default base auth URL configuration.
	 * @return array base auth URL configuration.
	 */
	protected function defaultBaseAuthUrl()
	{
		$baseAuthUrl = [
			Yii::$app->controller->getRoute()
		];
		$params = $_GET;
153
		unset($params[$this->clientIdGetParamName]);
154 155 156 157 158
		$baseAuthUrl = array_merge($baseAuthUrl, $params);
		return $baseAuthUrl;
	}

	/**
159
	 * Outputs client auth link.
160
	 * @param ClientInterface $client external auth client instance.
161 162 163
	 * @param string $text link text, if not set - default value will be generated.
	 * @param array $htmlOptions link HTML options.
	 */
164
	public function clientLink($client, $text = null, array $htmlOptions = [])
165 166
	{
		if ($text === null) {
167 168
			$text = Html::tag('span', '', ['class' => 'auth-icon ' . $client->getName()]);
			$text .= Html::tag('span', $client->getTitle(), ['class' => 'auth-title']);
169 170
		}
		if (!array_key_exists('class', $htmlOptions)) {
171
			$htmlOptions['class'] = 'auth-link ' . $client->getName();
172 173
		}
		if ($this->popupMode) {
174 175 176
			$viewOptions = $client->getViewOptions();
			if (isset($viewOptions['popupWidth'])) {
				$htmlOptions['data-popup-width'] = $viewOptions['popupWidth'];
177
			}
178 179
			if (isset($viewOptions['popupHeight'])) {
				$htmlOptions['data-popup-height'] = $viewOptions['popupHeight'];
180 181
			}
		}
182
		echo Html::a($text, $this->createClientUrl($client), $htmlOptions);
183 184 185
	}

	/**
186 187
	 * Composes client auth URL.
	 * @param ClientInterface $provider external auth client instance.
188 189
	 * @return string auth URL.
	 */
190
	public function createClientUrl($provider)
191 192 193
	{
		$this->autoRender = false;
		$url = $this->getBaseAuthUrl();
194
		$url[$this->clientIdGetParamName] = $provider->getId();
195 196 197 198 199 200 201 202
		return Html::url($url);
	}

	/**
	 * Renders the main content, which includes all external services links.
	 */
	protected function renderMainContent()
	{
203
		echo Html::beginTag('ul', ['class' => 'auth-clients clear']);
204
		foreach ($this->getClients() as $externalService) {
205
			echo Html::beginTag('li', ['class' => 'auth-client']);
206
			$this->clientLink($externalService);
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
			echo Html::endTag('li');
		}
		echo Html::endTag('ul');
	}

	/**
	 * Initializes the widget.
	 */
	public function init()
	{
		if ($this->popupMode) {
			$view = Yii::$app->getView();
			ChoiceAsset::register($view);
			$view->registerJs("\$('#" . $this->getId() . "').authchoice();");
		}
Qiang Xue committed
222 223
		$this->options['id'] = $this->getId();
		echo Html::beginTag('div', $this->options);
224 225 226 227 228 229 230 231 232 233 234 235
	}

	/**
	 * Runs the widget.
	 */
	public function run()
	{
		if ($this->autoRender) {
			$this->renderMainContent();
		}
		echo Html::endTag('div');
	}
Qiang Xue committed
236
}