RouterRules

API reference › Debug › models › router › RouterRules

class	`yii\debug\models\router\RouterRules`
Extends	`yii\base\Model` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\StaticInstanceInterface`, `IteratorAggregate`, `ArrayAccess`, `yii\base\Arrayable`, `yii\base\Configurable`
Uses traits	`yii\base\ArrayableTrait`, `yii\base\StaticInstanceTrait`
Source	`src/models/router/RouterRules.php`

Snapshots every URL rule registered on the application’s URL manager.

Recursively unwraps GroupUrlRule and UrlRule containers so the flat $rules list reflects the effective routing table exposed to the request.

Properties

Property	Type	Description	Defined by
`$activeValidators` read-only	`yii\validators\Validator[]`	The validators applicable to the current `$scenario`.	`yii\base\Model`
`$attributes`	`array<string, mixed>`	Attribute values (name => value).	`yii\base\Model`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$errors` read-only	`array<string, string[]>`	Errors for all attributes.	`yii\base\Model`
`$firstErrors` read-only	`array<string, string>`	The first errors.	`yii\base\Model`
`$iterator` read-only	`ArrayIterator<string, mixed>`	An iterator for traversing the items in the list.	`yii\base\Model`
`$prettyUrl`	`bool`	Whether `enablePrettyUrl` is enabled on the URL manager. Default: `false`.	`RouterRules`
`$rules`	`array<int, array<string, mixed>>`	Flattened URL rules. Default: `[]`.	`RouterRules`
`$scenario`	`string`	The scenario that this model is in.	`yii\base\Model`
`$strictParsing`	`bool`	Whether `enableStrictParsing` is enabled on the URL manager. Default: `false`.	`RouterRules`
`$suffix`	`string\|null`	Global URL suffix configured on the URL manager. Default: `null`.	`RouterRules`
`$validators` read-only	`ArrayObject<int,` `yii\validators\Validator>\|yii\validators\Validator[]`	All the validators declared in the model.	`yii\base\Model`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__call()`	Calls the named method which is not a class method.	`yii\base\Component`
`__clone()`	This method is called after the object is created by cloning an existing one.	`yii\base\Model`
`__get()`	Returns the value of a component property.	`yii\base\Component`
`__isset()`	Checks if a property is set, i.e. defined and not null.	`yii\base\Component`
`__set()`	Sets the value of a component property.	`yii\base\Component`
`__unset()`	Sets a component property to be null.	`yii\base\Component`
`activeAttributes()`	Returns the attribute names that are subject to validation in the current scenario.	`yii\base\Model`
`addError()`	Adds a new error to the specified attribute.	`yii\base\Model`
`addErrors()`	Adds a list of errors.	`yii\base\Model`
`afterValidate()`	This method is invoked after validation ends.	`yii\base\Model`
`attachBehavior()`	Attaches a behavior to this component.	`yii\base\Component`
`attachBehaviors()`	Attaches a list of behaviors to the component.	`yii\base\Component`
`attributeHints()`	Returns the attribute hints.	`yii\base\Model`
`attributeLabels()`	Returns the attribute labels.	`yii\base\Model`
`attributes()`	Returns the list of attribute names.	`yii\base\Model`
`beforeValidate()`	This method is invoked before validation starts.	`yii\base\Model`
`behaviors()`	Returns a list of behaviors that this component should behave as.	`yii\base\Component`
`canGetProperty()`	Returns a value indicating whether a property can be read.	`yii\base\Component`
`canSetProperty()`	Returns a value indicating whether a property can be set.	`yii\base\Component`
`className()` static	Returns the fully qualified name of this class.	`yii\base\BaseObject`
`clearErrors()`	Removes errors for all attributes or a single attribute.	`yii\base\Model`
`createValidators()`	Creates validator objects based on the validation rules specified in `rules()`.	`yii\base\Model`
`detachBehavior()`	Detaches a behavior from the component.	`yii\base\Component`
`detachBehaviors()`	Detaches all behaviors from the component.	`yii\base\Component`
`ensureBehaviors()`	Makes sure that the behaviors declared in `behaviors()` are attached to this component.	`yii\base\Component`
`extraFields()`	Returns the list of fields that can be expanded further and returned by `toArray()`.	`yii\base\ArrayableTrait`
`fields()`	Returns the list of fields that should be returned by default by `toArray()` when no specific fields are specified.	`yii\base\Model`
`formName()`	Returns the form name that this model class should use.	`yii\base\Model`
`generateAttributeLabel()`	Generates a user friendly attribute label based on the give attribute name.	`yii\base\Model`
`getActiveValidators()`	Returns the validators applicable to the current `$scenario`.	`yii\base\Model`
`getAttributeHint()`	Returns the text hint for the specified attribute.	`yii\base\Model`
`getAttributeLabel()`	Returns the text label for the specified attribute.	`yii\base\Model`
`getAttributes()`	Returns attribute values.	`yii\base\Model`
`getBehavior()`	Returns the named behavior object.	`yii\base\Component`
`getBehaviors()`	Returns all behaviors attached to this component.	`yii\base\Component`
`getErrors()`	Returns the errors for all attributes or a single attribute.	`yii\base\Model`
`getErrorSummary()`	Returns the errors for all attributes as a one-dimensional array.	`yii\base\Model`
`getFirstError()`	Returns the first error of the specified attribute.	`yii\base\Model`
`getFirstErrors()`	Returns the first error of every attribute in the model.	`yii\base\Model`
`getIterator()`	Returns an iterator for traversing the attributes in the model.	`yii\base\Model`
`getScenario()`	Returns the scenario that this model is used in.	`yii\base\Model`
`getValidators()`	Returns all the validators declared in `rules()`.	`yii\base\Model`
`hasErrors()`	Returns a value indicating whether there is any validation error.	`yii\base\Model`
`hasEventHandlers()`	Returns a value indicating whether there is any handler attached to the named event.	`yii\base\Component`
`hasMethod()`	Returns a value indicating whether a method is defined.	`yii\base\Component`
`hasProperty()`	Returns a value indicating whether a property is defined for this component.	`yii\base\Component`
`init()`	Scans the application on construction so the view model is ready before the panel renders.	`RouterRules`
`instance()` static	Returns static class instance, which can be used to obtain meta information.	`yii\base\StaticInstanceTrait`
`isAttributeActive()`	Returns a value indicating whether the attribute is active in the current scenario.	`yii\base\Model`
`isAttributeRequired()`	Returns a value indicating whether the attribute is required.	`yii\base\Model`
`isAttributeSafe()`	Returns a value indicating whether the attribute is safe for massive assignments.	`yii\base\Model`
`load()`	Populates the model with input data.	`yii\base\Model`
`loadMultiple()` static	Populates a set of models with the data from end user.	`yii\base\Model`
`off()`	Detaches an existing event handler from this component.	`yii\base\Component`
`offsetExists()`	Returns whether there is an element at the specified offset.	`yii\base\Model`
`offsetGet()`	Returns the element at the specified offset.	`yii\base\Model`
`offsetSet()`	Sets the element at the specified offset.	`yii\base\Model`
`offsetUnset()`	Sets the element value at the specified offset to null.	`yii\base\Model`
`on()`	Attaches an event handler to an event.	`yii\base\Component`
`onUnsafeAttribute()`	This method is invoked when an unsafe attribute is being massively assigned.	`yii\base\Model`
`rules()`	Returns the validation rules for attributes.	`yii\base\Model`
`safeAttributes()`	Returns the attribute names that are safe to be massively assigned in the current scenario.	`yii\base\Model`
`scenarios()`	Returns a list of scenarios and the corresponding active attributes.	`yii\base\Model`
`setAttributes()`	Sets the attribute values in a massive way.	`yii\base\Model`
`setScenario()`	Sets the scenario for the model.	`yii\base\Model`
`toArray()`	Converts the model into an array.	`yii\base\ArrayableTrait`
`trigger()`	Triggers an event.	`yii\base\Component`
`validate()`	Performs the data validation.	`yii\base\Model`
`validateMultiple()` static	Validates multiple models.	`yii\base\Model`
`extractFieldsFor()` protected	Extract nested fields from a fields collection for a given root field Nested fields are separated with dots (.). e.g: “item.id” The previous example would extract “id”.	`yii\base\ArrayableTrait`
`extractRootFields()` protected	Extracts the root field names from nested fields.	`yii\base\ArrayableTrait`
`resolveFields()` protected	Determines which fields can be returned by `toArray()`.	`yii\base\ArrayableTrait`
`scanGroupRule()` protected	Scans each nested rule of a group rule, tagging discovered entries as `'GROUP'`.	`RouterRules`
`scanRestRule()` protected	Scans the inner rule groups of a REST rule via reflection, tagging discovered entries as `'REST'`.	`RouterRules`
`scanRule()` protected	Records a single rule’s summary in `$rules`, recursing into group and REST rule containers.	`RouterRules`

Events

Event	Type	Description	Defined by
`EVENT_BEFORE_VALIDATE`	`yii\base\ModelEvent`	An event raised at the beginning of `validate()`. Event name: `'beforeValidate'`.	`yii\base\Model`
`EVENT_AFTER_VALIDATE`	`yii\base\Event`	An event raised at the end of `validate()` Event name: `'afterValidate'`.	`yii\base\Model`

Constants

Constant	Value	Description	Defined by
`SCENARIO_DEFAULT`	`'default'`	The name of the default scenario.	`yii\base\Model`

Property details

$rules

public array<int, array<string, mixed>> $rules = []

Flattened URL rules.

Each entry carries:

name — rule name, or rule class when no name is configured (string).
route — target route (string).
verb — HTTP verbs (array).
suffix — per-rule suffix (string).
mode — 'parsing only', 'creation only', or null.
type — 'REST', 'GROUP', or null.

Method details

init()

public function init(): void

Scans the application on construction so the view model is ready before the panel renders.

scanGroupRule()

protected function scanGroupRule(yii\web\GroupUrlRule $groupRule): void

Scans each nested rule of a group rule, tagging discovered entries as 'GROUP'.

Parameters

Parameter	Type	Description
`$groupRule`	`yii\web\GroupUrlRule`	Group rule whose children should be flattened.

Throws

ReflectionException: when reflection is needed for a nested REST rule and fails.

scanRestRule()

protected function scanRestRule(yii\rest\UrlRule $restRule): void

Scans the inner rule groups of a REST rule via reflection, tagging discovered entries as 'REST'.

Reads the protected rules property because UrlRule does not expose it directly.

Parameters

Parameter	Type	Description
`$restRule`	`yii\rest\UrlRule`	REST rule whose inner groups are scanned.

Throws

ReflectionException: when the rules property cannot be read.

scanRule()

protected function scanRule(object $rule, string|null $type = null): void

Records a single rule’s summary in $rules, recursing into group and REST rule containers.

Parameters

Parameter	Type	Description
`$rule`	`object`	Rule instance to summarize.
`$type`	`string\|null`	Origin tag, typically `'REST'`, `'GROUP'`, or `null` for top-level rules.

Throws

ReflectionException: when reflection over a REST rule’s inner rules property fails.