UrlRule.php 8.03 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\rest;

use Yii;
use yii\base\InvalidConfigException;
use yii\helpers\Inflector;
use yii\web\CompositeUrlRule;

/**
Qiang Xue committed
16
 * UrlRule is provided to simplify the creation of URL rules for RESTful API support.
Qiang Xue committed
17 18 19 20 21 22 23 24 25 26 27 28 29 30
 *
 * The simplest usage of UrlRule is to declare a rule like the following in the application configuration,
 *
 * ```php
 * [
 *     'class' => 'yii\rest\UrlRule',
 *     'controller' => 'user',
 * ]
 * ```
 *
 * The above code will create a whole set of URL rules supporting the following RESTful API endpoints:
 *
 * - `'PUT,PATCH users/<id>' => 'user/update'`: update a user
 * - `'DELETE users/<id>' => 'user/delete'`: delete a user
Qiang Xue committed
31
 * - `'GET,HEAD users/<id>' => 'user/view'`: return the details/overview/options of a user
Qiang Xue committed
32
 * - `'POST users' => 'user/create'`: create a new user
Qiang Xue committed
33 34 35
 * - `'GET,HEAD users' => 'user/index'`: return a list/overview/options of users
 * - `'users/<id>' => 'user/options'`: process all unhandled verbs of a user
 * - `'users' => 'user/options'`: process all unhandled verbs of user collection
Qiang Xue committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
 *
 * You may configure [[only]] and/or [[except]] to disable some of the above rules.
 * You may configure [[patterns]] to completely redefine your own list of rules.
 * You may configure [[controller]] with multiple controller IDs to generate rules for all these controllers.
 * For example, the following code will disable the `delete` rule and generate rules for both `user` and `post` controllers:
 *
 * ```php
 * [
 *     'class' => 'yii\rest\UrlRule',
 *     'controller' => ['user', 'post'],
 *     'except' => ['delete'],
 * ]
 * ```
 *
 * The property [[controller]] is required and should be the controller ID. It should be prefixed with
 * the module ID if the controller is within a module.
 *
 * The controller ID used in the pattern will be automatically pluralized (e.g. `user` becomes `users`
 * as shown in the above examples). You may configure [[urlName]] to explicitly specify the controller ID
 * in the pattern.
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class UrlRule extends CompositeUrlRule
{
	/**
	 * @var string the common prefix string shared by all patterns.
	 */
	public $prefix;
	/**
	 * @var string the suffix that will be assigned to [[\yii\web\UrlRule::suffix]] for every generated rule.
	 */
	public $suffix;
	/**
	 * @var string|array the controller ID (e.g. `user`, `post-comment`) that the rules in this composite rule
	 * are dealing with. It should be prefixed with the module ID if the controller is within a module (e.g. `admin/user`).
	 *
	 * By default, the controller ID will be pluralized automatically when it is put in the patterns of the
	 * generated rules. If you want to explicitly specify how the controller ID should appear in the patterns,
	 * you may use an array with the array key being as the controller ID in the pattern, and the array value
	 * the actual controller ID. For example, `['u' => 'user']`.
	 *
	 * You may also pass multiple controller IDs as an array. If this is the case, this composite rule will
	 * generate applicable URL rules for EVERY specified controller. For example, `['user', 'post']`.
	 */
	public $controller;
	/**
	 * @var array list of acceptable actions. If not empty, only the actions within this array
	 * will have the corresponding URL rules created.
	 * @see patterns
	 */
	public $only = [];
	/**
	 * @var array list of actions that should be excluded. Any action found in this array
	 * will NOT have its URL rules created.
	 * @see patterns
	 */
	public $except = [];
Qiang Xue committed
95 96 97 98 99
	/**
	 * @var array patterns for supporting extra actions in addition to those listed in [[patterns]].
	 * The keys are the patterns and the values are the corresponding action IDs.
	 * These extra patterns will take precedence over [[patterns]].
	 */
100
	public $extraPatterns = [];
Qiang Xue committed
101 102 103 104 105 106
	/**
	 * @var array list of tokens that should be replaced for each pattern. The keys are the token names,
	 * and the values are the corresponding replacements.
	 * @see patterns
	 */
	public $tokens = [
Qiang Xue committed
107
		'{id}' => '<id:\\d[\\d,]*>',
Qiang Xue committed
108 109 110 111
	];
	/**
	 * @var array list of possible patterns and the corresponding actions for creating the URL rules.
	 * The keys are the patterns and the values are the corresponding actions.
Qiang Xue committed
112 113 114
	 * The format of patterns is `Verbs Pattern`, where `Verbs` stands for a list of HTTP verbs separated
	 * by comma (without space). If `Verbs` is not specified, it means all verbs are allowed.
	 * `Pattern` is optional. It will be prefixed with [[prefix]]/[[controller]]/,
Qiang Xue committed
115 116 117 118 119
	 * and tokens in it will be replaced by [[tokens]].
	 */
	public $patterns = [
		'PUT,PATCH {id}' => 'update',
		'DELETE {id}' => 'delete',
Qiang Xue committed
120
		'GET,HEAD {id}' => 'view',
Qiang Xue committed
121
		'POST' => 'create',
Qiang Xue committed
122 123 124
		'GET,HEAD' => 'index',
		'{id}' => 'options',
		'' => 'options',
Qiang Xue committed
125
	];
Qiang Xue committed
126 127 128
	/**
	 * @var array the default configuration for creating each URL rule contained by this rule.
	 */
Qiang Xue committed
129 130 131
	public $ruleConfig = [
		'class' => 'yii\web\UrlRule',
	];
Qiang Xue committed
132 133 134 135 136 137 138
	/**
	 * @var boolean whether to automatically pluralize the URL names for controllers.
	 * If true, a controller ID will appear in plural form in URLs. For example, `user` controller
	 * will appear as `users` in URLs.
	 * @see controllers
	 */
	public $pluralize = true;
Qiang Xue committed
139 140 141 142 143 144 145 146 147 148 149 150 151 152


	/**
	 * @inheritdoc
	 */
	public function init()
	{
		if (empty($this->controller)) {
			throw new InvalidConfigException('"controller" must be set.');
		}

		$controllers = [];
		foreach ((array)$this->controller as $urlName => $controller) {
			if (is_integer($urlName)) {
Qiang Xue committed
153
				$urlName = $this->pluralize ? Inflector::pluralize($controller) : $controller;
Qiang Xue committed
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
			}
			$controllers[$urlName] = $controller;
		}
		$this->controller = $controllers;

		$this->prefix = trim($this->prefix, '/');

		parent::init();
	}

	/**
	 * @inheritdoc
	 */
	protected function createRules()
	{
		$only = array_flip($this->only);
		$except = array_flip($this->except);
171
		$patterns = array_merge($this->patterns, $this->extraPatterns);
Qiang Xue committed
172 173 174
		$rules = [];
		foreach ($this->controller as $urlName => $controller) {
			$prefix = trim($this->prefix . '/' . $urlName, '/');
Qiang Xue committed
175
			foreach ($patterns as $pattern => $action) {
Qiang Xue committed
176
				if (!isset($except[$action]) && (empty($only) || isset($only[$action]))) {
Qiang Xue committed
177
					$rules[$urlName][] = $this->createRule($pattern, $prefix, $controller . '/' . $action);
Qiang Xue committed
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
				}
			}
		}
		return $rules;
	}

	/**
	 * Creates a URL rule using the given pattern and action.
	 * @param string $pattern
	 * @param string $prefix
	 * @param string $action
	 * @return \yii\web\UrlRuleInterface
	 */
	protected function createRule($pattern, $prefix, $action)
	{
Qiang Xue committed
193 194 195 196
		$verbs = 'GET|HEAD|POST|PUT|PATCH|DELETE|OPTIONS';
		if (preg_match("/^((?:($verbs),)*($verbs))(?:\\s+(.*))?$/", $pattern, $matches)) {
			$verbs = explode(',', $matches[1]);
			$pattern = isset($matches[4]) ? $matches[4] : '';
Qiang Xue committed
197
		} else {
Qiang Xue committed
198
			$verbs = [];
Qiang Xue committed
199 200 201
		}

		$config = $this->ruleConfig;
Qiang Xue committed
202 203
		$config['verb'] = $verbs;
		$config['pattern'] = rtrim($prefix . '/' . strtr($pattern, $this->tokens), '/');
Qiang Xue committed
204
		$config['route'] = $action;
Qiang Xue committed
205
		if (!in_array('GET', $verbs)) {
Qiang Xue committed
206 207 208 209 210 211
			$config['mode'] = \yii\web\UrlRule::PARSING_ONLY;
		}
		$config['suffix'] = $this->suffix;

		return Yii::createObject($config);
	}
Qiang Xue committed
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

	/**
	 * @inheritdoc
	 */
	public function parseRequest($manager, $request)
	{
		$pathInfo = $request->getPathInfo();
		foreach ($this->rules as $urlName => $rules) {
			if (strpos($pathInfo, $urlName) !== false) {
				foreach ($rules as $rule) {
					/** @var \yii\web\UrlRule $rule */
					if (($result = $rule->parseRequest($manager, $request)) !== false) {
						Yii::trace("Request parsed with URL rule: {$rule->name}", __METHOD__);
						return $result;
					}
				}
			}
		}
		return false;
	}

	/**
	 * @inheritdoc
	 */
	public function createUrl($manager, $route, $params)
	{
		foreach ($this->controller as $urlName => $controller) {
			if (strpos($route, $controller) !== false) {
				foreach ($this->rules[$urlName] as $rule) {
					/** @var \yii\web\UrlRule $rule */
					if (($url = $rule->createUrl($manager, $route, $params)) !== false) {
						return $url;
					}
				}
			}
		}
		return false;
	}
Qiang Xue committed
250
}