Class luya\admin\components\UrlRule
| Inheritance | luya\admin\components\UrlRule » yii\rest\UrlRule » yii\web\CompositeUrlRule » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\web\UrlRuleInterface |
| Available since version | 1.0.0 |
| Source Code | https://github.com/luyadev/luya-module-admin/blob/master/src/components/UrlRule.php |
Url rule for NgRest Apis.
As ngrest apis should have the same module as identifer like admin/api-user-lists therefore
this rule is going to "fake" those admin module routes.
The controllerMap property from the admin module is provided by {{luya\web\Bootstrap::run()}} method.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $cacheFlag | boolean | This is used to ensure the url rule caching works with yii version 2.0.14 | luya\admin\components\UrlRule |
| $controller | string|array | The controller ID (e.g. user, post-comment) that the rules in this composite rule are dealing with. |
yii\rest\UrlRule |
| $createUrlStatus | integer|null | Status of the URL creation after the last createUrl() call. | yii\web\CompositeUrlRule |
| $except | array | List of actions that should be excluded. | yii\rest\UrlRule |
| $extraPatterns | array | Patterns for supporting extra actions in addition to those listed in $patterns. | yii\rest\UrlRule |
| $only | array | List of acceptable actions. | yii\rest\UrlRule |
| $patterns | array | List of possible patterns and the corresponding actions for creating the URL rules. | yii\rest\UrlRule |
| $pluralize | boolean | Whether to automatically pluralize the URL names for controllers. | luya\admin\components\UrlRule |
| $prefix | string|null | The common prefix string shared by all patterns. | yii\rest\UrlRule |
| $ruleConfig | array | The default configuration for creating each URL rule contained by this rule. | yii\rest\UrlRule |
| $suffix | string | The suffix that will be assigned to yii\web\UrlRule::$suffix for every generated rule. | yii\rest\UrlRule |
| $tokens | array | List of tokens that should be replaced for each pattern. | yii\rest\UrlRule |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $createStatus | integer|null | Status of the URL creation after the last createUrl() call. | yii\web\CompositeUrlRule |
| $rules | yii\web\UrlRuleInterface[] | The URL rules contained in this composite rule. | yii\web\CompositeUrlRule |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of an object property. | yii\base\BaseObject |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
| __set() | Sets value of an object property. | yii\base\BaseObject |
| __unset() | Sets an object property to null. | yii\base\BaseObject |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| createUrl() | Creates a URL according to the given route and parameters. | yii\rest\UrlRule |
| getCreateUrlStatus() | Returns status of the URL creation after the last createUrl() call. | yii\web\CompositeUrlRule |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
| init() | Initializes the object. | yii\rest\UrlRule |
| parseRequest() | Parses the given request and returns the corresponding route and parameters. | yii\rest\UrlRule |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| createRule() | Creates a URL rule using the given pattern and action. | yii\rest\UrlRule |
| createRules() | Creates the URL rules that should be contained within this composite rule. | yii\rest\UrlRule |
| iterateRules() | Iterates through specified rules and calls createUrl() for each of them. | yii\web\CompositeUrlRule |
Property Details
This is used to ensure the url rule caching works with yii version 2.0.14
See also https://github.com/luyadev/luya-module-admin/issues/68.
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.
Method Details
Defined in: yii\base\BaseObject::__call()
Calls the named method which is not a class method.
Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.
| public mixed __call ( $name, $params ) | ||
| $name | string |
The method name |
| $params | array |
Method parameters |
| return | mixed |
The method return value |
|---|---|---|
| throws | yii\base\UnknownMethodException |
when calling unknown method |
public function __call($name, $params)
{
throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}
Defined in: yii\base\BaseObject::__construct()
Constructor.
The default implementation does two things:
- Initializes the object with the given configuration
$config. - Call init().
If this method is overridden in a child class, it is recommended that
- the last parameter of the constructor is a configuration array, like
$confighere. - call the parent implementation at the end of the constructor.
| public void __construct ( $config = [] ) | ||
| $config | array |
Name-value pairs that will be used to initialize the object properties |
public function __construct($config = [])
{
if (!empty($config)) {
Yii::configure($this, $config);
}
$this->init();
}
Defined in: yii\base\BaseObject::__get()
Returns the value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $value = $object->property;.
See also __set().
| public mixed __get ( $name ) | ||
| $name | string |
The property name |
| return | mixed |
The property value |
|---|---|---|
| throws | yii\base\UnknownPropertyException |
if the property is not defined |
| throws | yii\base\InvalidCallException |
if the property is write-only |
public function __get($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter();
} elseif (method_exists($this, 'set' . $name)) {
throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
}
throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}
Defined in: yii\base\BaseObject::__isset()
Checks if a property is set, i.e. defined and not null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing isset($object->property).
Note that if the property is not defined, false will be returned.
| public boolean __isset ( $name ) | ||
| $name | string |
The property name or the event name |
| return | boolean |
Whether the named property is set (not null). |
|---|---|---|
public function __isset($name)
{
$getter = 'get' . $name;
if (method_exists($this, $getter)) {
return $this->$getter() !== null;
}
return false;
}
Defined in: yii\base\BaseObject::__set()
Sets value of an object property.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing $object->property = $value;.
See also __get().
| public void __set ( $name, $value ) | ||
| $name | string |
The property name or the event name |
| $value | mixed |
The property value |
| throws | yii\base\UnknownPropertyException |
if the property is not defined |
|---|---|---|
| throws | yii\base\InvalidCallException |
if the property is read-only |
public function __set($name, $value)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter($value);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
} else {
throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::__unset()
Sets an object property to null.
Do not call this method directly as it is a PHP magic method that
will be implicitly called when executing unset($object->property).
Note that if the property is not defined, this method will do nothing. If the property is read-only, it will throw an exception.
| public void __unset ( $name ) | ||
| $name | string |
The property name |
| throws | yii\base\InvalidCallException |
if the property is read only. |
|---|---|---|
public function __unset($name)
{
$setter = 'set' . $name;
if (method_exists($this, $setter)) {
$this->$setter(null);
} elseif (method_exists($this, 'get' . $name)) {
throw new InvalidCallException('Unsetting read-only property: ' . get_class($this) . '::' . $name);
}
}
Defined in: yii\base\BaseObject::canGetProperty()
Returns a value indicating whether a property can be read.
A property is readable if:
- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canSetProperty().
| public boolean canGetProperty ( $name, $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be read |
|---|---|---|
public function canGetProperty($name, $checkVars = true)
{
return method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name);
}
Defined in: yii\base\BaseObject::canSetProperty()
Returns a value indicating whether a property can be set.
A property is writable if:
- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also canGetProperty().
| public boolean canSetProperty ( $name, $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property can be written |
|---|---|---|
public function canSetProperty($name, $checkVars = true)
{
return method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name);
}
::class instead.
Defined in: yii\base\BaseObject::className()
Returns the fully qualified name of this class.
| public static string className ( ) | ||
| return | string |
The fully qualified name of this class. |
|---|---|---|
public static function className()
{
return get_called_class();
}
Defined in: yii\rest\UrlRule::createRule()
Creates a URL rule using the given pattern and action.
| protected yii\web\UrlRuleInterface createRule ( $pattern, $prefix, $action ) | ||
| $pattern | string | |
| $prefix | string | |
| $action | string | |
protected function createRule($pattern, $prefix, $action)
{
$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] : '';
} else {
$verbs = [];
}
$config = $this->ruleConfig;
$config['verb'] = $verbs;
$config['pattern'] = rtrim($prefix . '/' . strtr($pattern, $this->tokens), '/');
$config['route'] = $action;
$config['suffix'] = $this->suffix;
return Yii::createObject($config);
}
Defined in: yii\rest\UrlRule::createRules()
Creates the URL rules that should be contained within this composite rule.
| protected yii\web\UrlRuleInterface[] createRules ( ) | ||
| return | yii\web\UrlRuleInterface[] |
The URL rules |
|---|---|---|
protected function createRules()
{
$only = array_flip($this->only);
$except = array_flip($this->except);
$patterns = $this->extraPatterns + $this->patterns;
$rules = [];
foreach ($this->controller as $urlName => $controller) {
$prefix = trim($this->prefix . '/' . $urlName, '/');
foreach ($patterns as $pattern => $action) {
if (!isset($except[$action]) && (empty($only) || isset($only[$action]))) {
$rules[$urlName][] = $this->createRule($pattern, $prefix, $controller . '/' . $action);
}
}
}
return $rules;
}
Defined in: yii\rest\UrlRule::createUrl()
Creates a URL according to the given route and parameters.
| public string|boolean createUrl ( $manager, $route, $params ) | ||
| $manager | yii\web\UrlManager |
The URL manager |
| $route | string |
The route. It should not have slashes at the beginning or the end. |
| $params | array |
The parameters |
| return | string|boolean |
The created URL, or false if this rule cannot be used for creating this URL. |
|---|---|---|
public function createUrl($manager, $route, $params)
{
$this->createStatus = WebUrlRule::CREATE_STATUS_SUCCESS;
foreach ($this->controller as $urlName => $controller) {
if (strpos($route, $controller) !== false) {
/* @var $rules UrlRuleInterface[] */
$rules = $this->rules[$urlName];
$url = $this->iterateRules($rules, $manager, $route, $params);
if ($url !== false) {
return $url;
}
} else {
$this->createStatus |= WebUrlRule::CREATE_STATUS_ROUTE_MISMATCH;
}
}
if ($this->createStatus === WebUrlRule::CREATE_STATUS_SUCCESS) {
// create status was not changed - there is no rules configured
$this->createStatus = WebUrlRule::CREATE_STATUS_PARSING_ONLY;
}
return false;
}
Defined in: yii\web\CompositeUrlRule::getCreateUrlStatus()
Returns status of the URL creation after the last createUrl() call.
For multiple rules statuses will be combined by bitwise or operator
(e.g. UrlRule::CREATE_STATUS_PARSING_ONLY | UrlRule::CREATE_STATUS_PARAMS_MISMATCH).
See also:
| public integer|null getCreateUrlStatus ( ) | ||
| return | integer|null |
Status of the URL creation after the last createUrl() call. |
|---|---|---|
public function getCreateUrlStatus()
{
return $this->createStatus;
}
Defined in: yii\base\BaseObject::hasMethod()
Returns a value indicating whether a method is defined.
The default implementation is a call to php function method_exists().
You may override this method when you implemented the php magic method __call().
| public boolean hasMethod ( $name ) | ||
| $name | string |
The method name |
| return | boolean |
Whether the method is defined |
|---|---|---|
public function hasMethod($name)
{
return method_exists($this, $name);
}
Defined in: yii\base\BaseObject::hasProperty()
Returns a value indicating whether a property is defined.
A property is defined if:
- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when
$checkVarsis true);
See also:
| public boolean hasProperty ( $name, $checkVars = true ) | ||
| $name | string |
The property name |
| $checkVars | boolean |
Whether to treat member variables as properties |
| return | boolean |
Whether the property is defined |
|---|---|---|
public function hasProperty($name, $checkVars = true)
{
return $this->canGetProperty($name, $checkVars) || $this->canSetProperty($name, false);
}
Defined in: yii\rest\UrlRule::init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
| public void init ( ) |
public function init()
{
if (empty($this->controller)) {
throw new InvalidConfigException('"controller" must be set.');
}
$controllers = [];
foreach ((array) $this->controller as $urlName => $controller) {
if (is_int($urlName)) {
$urlName = $this->pluralize ? Inflector::pluralize($controller) : $controller;
}
$controllers[$urlName] = $controller;
}
$this->controller = $controllers;
$this->prefix = trim((string)$this->prefix, '/');
parent::init();
}
Defined in: yii\web\CompositeUrlRule::iterateRules()
Iterates through specified rules and calls createUrl() for each of them.
See also createUrl().
| protected boolean|string iterateRules ( $rules, $manager, $route, $params ) | ||
| $rules | yii\web\UrlRuleInterface[] |
Rules to iterate. |
| $manager | yii\web\UrlManager |
The URL manager |
| $route | string |
The route. It should not have slashes at the beginning or the end. |
| $params | array |
The parameters |
| return | boolean|string |
The created URL, or |
|---|---|---|
protected function iterateRules($rules, $manager, $route, $params)
{
/* @var $rule UrlRule */
foreach ($rules as $rule) {
$url = $rule->createUrl($manager, $route, $params);
if ($url !== false) {
$this->createStatus = UrlRule::CREATE_STATUS_SUCCESS;
return $url;
}
if (
$this->createStatus === null
|| !method_exists($rule, 'getCreateUrlStatus')
|| $rule->getCreateUrlStatus() === null
) {
$this->createStatus = null;
} else {
$this->createStatus |= $rule->getCreateUrlStatus();
}
}
return false;
}
Defined in: yii\rest\UrlRule::parseRequest()
Parses the given request and returns the corresponding route and parameters.
| public array|boolean parseRequest ( $manager, $request ) | ||
| $manager | yii\web\UrlManager |
The URL manager |
| $request | yii\web\Request |
The request component |
| return | array|boolean |
The parsing result. The route and the parameters are returned as an array. If false, it means this rule cannot be used to parse this path info. |
|---|---|---|
public function parseRequest($manager, $request)
{
$pathInfo = $request->getPathInfo();
if (
$this->prefix !== ''
&& strpos($this->prefix, '<') === false
&& strpos($pathInfo . '/', $this->prefix . '/') !== 0
) {
return false;
}
foreach ($this->rules as $urlName => $rules) {
if (strpos($pathInfo, $urlName) !== false) {
foreach ($rules as $rule) {
/* @var $rule WebUrlRule */
$result = $rule->parseRequest($manager, $request);
if (YII_DEBUG) {
Yii::debug([
'rule' => method_exists($rule, '__toString') ? $rule->__toString() : get_class($rule),
'match' => $result !== false,
'parent' => self::className(),
], __METHOD__);
}
if ($result !== false) {
return $result;
}
}
}
}
return false;
}