UrlRule
- Type
- Class
- Namespace
- craft\web
- Inherits
- craft\web\UrlRule » yii\web\UrlRule (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window), yii\web\UrlRuleInterface (opens new window)
- Since
- 3.0.0
View source (opens new window)
# Public Properties
# params
- Type
- array (opens new window)
- Default value
[]
Parameters that should be passed to the controller.
View source (opens new window)
# Protected Properties
Property | Description |
---|---|
createStatus (opens new window) | integer (opens new window), null (opens new window) – Status of the URL creation after the last createUrl() (opens new window) call. |
placeholders (opens new window) | array (opens new window) – List of placeholders for matching parameters names. |
# Public Methods
Method | Description |
---|---|
__call() (opens new window) | Calls the named method which is not a class method. |
__construct() | Constructor. |
__get() (opens new window) | Returns the value of an object property. |
__isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
__set() (opens new window) | Sets value of an object property. |
__toString() (opens new window) | |
__unset() (opens new window) | Sets an object property to null. |
canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
className() (opens new window) | Returns the fully qualified name of this class. |
createUrl() (opens new window) | Creates a URL according to the given route and parameters. |
getCreateUrlStatus() (opens new window) | Returns status of the URL creation after the last createUrl() (opens new window) call. |
hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
hasProperty() (opens new window) | Returns a value indicating whether a property is defined. |
init() (opens new window) | Initializes this rule. |
parseRequest() | Parses the given request and returns the corresponding route and parameters. |
# __construct()
Constructor.
View source (opens new window)
Arguments
$config
(array (opens new window))
# parseRequest()
Parses the given request and returns the corresponding route and parameters.
View source (opens new window)
Arguments
$manager
(yii\web\UrlManager (opens new window)) – The URL manager$request
(yii\web\Request (opens new window)) – The request component
Returns
array (opens new window), boolean (opens new window) – 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.
# Protected Methods
Method | Description |
---|---|
getNormalizer() (opens new window) | |
getParamRules() (opens new window) | Returns list of regex for matching parameter. |
hasNormalizer() (opens new window) | |
substitutePlaceholderNames() (opens new window) | Iterates over placeholders (opens new window) and checks whether each placeholder exists as a key in $matches array. |
# Constants
Constant | Description |
---|---|
CREATE_STATUS_PARAMS_MISMATCH | Represents the unsuccessful URL generation by last createUrl() (opens new window) call, because of mismatched or missing parameters. |
CREATE_STATUS_PARSING_ONLY | Represents the unsuccessful URL generation by last createUrl() (opens new window) call, because rule does not support creating URLs. |
CREATE_STATUS_ROUTE_MISMATCH | Represents the unsuccessful URL generation by last createUrl() (opens new window) call, because of mismatched route. |
CREATE_STATUS_SUCCESS | Represents the successful URL generation by last createUrl() (opens new window) call. |
CREATION_ONLY | Set mode (opens new window) with this value to mark that this rule is for URL creation only. |
PARSING_ONLY | Set mode (opens new window) with this value to mark that this rule is for URL parsing only. |
← UrlManager User →