UrlRule

Type
Class
Namespace
craft\app\web
Inherits
craft\app\web\UrlRule » craft\web\UrlRule » yii\web\UrlRule » yii\base\BaseObject
Implements
yii\base\Configurable, yii\web\UrlRuleInterface
Since
3.0

View source

Public Properties

PropertyDescription
$createUrlStatusnull, integer – Status of the URL creation after the last createUrl() call.
$defaultsarray – The default GET parameters (name => value) that this rule provides.
$encodeParamsboolean – A value indicating if parameters should be url encoded.
$hoststring – The pattern used to parse and create the host info part of a URL (e.g. `http://example.
$modeinteger – A value indicating if this rule should be used for both request parsing and URL creation, parsing only, or creation only.
$namestring – The name of this rule.
$normalizeryii\web\UrlNormalizer, array, false, null – The configuration for \craft\app\web\UrlNormalizer used by this rule.
$paramsarray – Parameters that should be passed to the controller.
$patternstring – The pattern used to parse and create the path info part of a URL.
$routestring – The route to the controller action
$suffixstring – The URL suffix used for this rule.
$verbstring, array – The HTTP verb (e.g. GET, POST, DELETE) that this rule should match.

Protected Properties

PropertyDescription
$createStatusinteger, null – Status of the URL creation after the last createUrl() call.
$placeholdersarray – List of placeholders for matching parameters names.

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__toString()
__unset()Sets an object property to null.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
createUrl()Creates a URL according to the given route and parameters.
getCreateUrlStatus()Returns status of the URL creation after the last createUrl() call.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
parseRequest()Parses the given request and returns the corresponding route and parameters.

Protected Methods

MethodDescription
getNormalizer()
getParamRules()Returns list of regex for matching parameter.
hasNormalizer()
substitutePlaceholderNames()Iterates over $placeholders and checks whether each placeholder exists as a key in $matches array.

Constants

ConstantDescription
CREATE_STATUS_PARAMS_MISMATCHRepresents the unsuccessful URL generation by last createUrl() call, because of mismatched or missing parameters.
CREATE_STATUS_PARSING_ONLYRepresents the unsuccessful URL generation by last createUrl() call, because rule does not support creating URLs.
CREATE_STATUS_ROUTE_MISMATCHRepresents the unsuccessful URL generation by last createUrl() call, because of mismatched route.
CREATE_STATUS_SUCCESSRepresents the successful URL generation by last createUrl() call.
CREATION_ONLYSet $mode with this value to mark that this rule is for URL creation only.
PARSING_ONLYSet $mode with this value to mark that this rule is for URL parsing only.