RouterPanel

API reference › Debug › panels › RouterPanel

class	yii\debug\panels\RouterPanel
Extends	yii\debug\Panel » yii\base\Component » yii\base\BaseObject
Implements	yii\base\ViewContextInterface, yii\base\Configurable
Source	src/panels/RouterPanel.php

Renders the routing trace captured by the Router collector.

Delegates the detail view to the framework-neutral RouterPanel, feeding it the live URL rules and action routes; data acquisition lives in RouterCollector.

Properties

Property	Type	Description	Defined by
$actions	array<string, array<string, mixed>|class-string>	Standalone actions merged into the debug module’s Module::$actionMap, keyed by action ID. Default: [].	yii\debug\Panel
$behaviors read-only	array<yii\base\Behavior<static>>	List of behaviors attached to this component.	yii\base\Component
$detail read-only	string	Rendered panel markup.	RouterPanel
$id	string	Panel unique identifier, assigned by the container module on registration. Default: ''.	yii\debug\Panel
$module	yii\debug\Module|null	Debug module owning this panel. Default: null.	yii\debug\Panel
$name read-only	string	Panel display name.	RouterPanel
$renderContext	PHPForge\Debug\Panel\PanelRenderContext|null	Prepared render context, or null outside a debugger request.	yii\debug\Panel
$snapshot read-only	PHPForge\Debug\Panel\Router\RouterSnapshot|null	Captured routing trace, or null before hydration.	RouterPanel
$standalone	bool	Whether Router should retain its standalone toolbar and sidebar entries. Default: true.	RouterPanel
$tag	string	Tag of the request whose data this panel currently exposes. Default: ''.	yii\debug\Panel
$toolbarData read-only	array<string, mixed>	Toolbar envelope; [] to skip the panel.	yii\debug\Panel
$toolbarIcon read-only	string	Toolbar icon key.	RouterPanel
$url read-only	string	Absolute URL to the panel detail view.	yii\debug\Panel
$viewPath read-only	string	Directory the panel views resolve against.	yii\debug\Panel
$error protected	PHPForge\Debug\Storage\ExceptionSnapshot|null	Exception captured when the panel failed to produce or hydrate its snapshot. Default: null.	yii\debug\Panel

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\Component
__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
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
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
capture()	Captures the panel payload for the current request.	yii\debug\Panel
className() static	Returns the fully qualified name of this class.	yii\base\BaseObject
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
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getDetail()	Renders the detail view through the shared declarative presenter.	RouterPanel
getError()	Returns the exception captured while collecting the panel payload, if any.	yii\debug\Panel
getName()	Returns the panel display name from the shared title enum.	RouterPanel
getRenderContext()	Returns the framework-neutral render context for the active debugger request, when one has been prepared.	yii\debug\Panel
getSnapshot()	Returns the captured routing snapshot for composition by another panel.	RouterPanel
getToolbarData()	Returns the toolbar envelope wrapping the panel’s icon, items, and URL.	yii\debug\Panel
getToolbarIcon()	Returns the icon key from the shared panel icon enum.	RouterPanel
getTraceLine()	Builds a trace line for the toolbar through the shared Trace renderer, applying Module::$tracePathMappings and the configured Module::$traceLine template (or callable).	yii\debug\Panel
getUrl()	Returns the URL pointing to this panel’s detail view for the current request tag.	yii\debug\Panel
getViewPath()	Returns the directory under which the panel’s relative views resolve.	yii\debug\Panel
hasContent()	Returns whether the panel captured content for the loaded request.	yii\debug\Panel
hasError()	Returns true when setError() captured an exception during panel capture or hydration.	yii\debug\Panel
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
hydrate()	Decodes the captured payload into the typed routing snapshot backing this panel.	RouterPanel
init()	Initializes the object.	yii\base\BaseObject
isEnabled()	Indicates whether this panel is enabled and should be registered by the module.	yii\debug\Panel
isVisible()	Keeps explicitly configured Router panels standalone while allowing the built-in instance to act as a hidden compatibility data source for Request.	RouterPanel
moduleBound()	Completes module-dependent wiring after the container module binds $id and $module.	yii\debug\Panel
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
setError()	Records an exception thrown during capture or hydration so LogTarget can surface it in the UI.	yii\debug\Panel
setRenderContext()	Installs the framework-neutral render context prepared for this panel by the debugger action.	yii\debug\Panel
trigger()	Triggers an event.	yii\base\Component
getToolbarItems() protected	Builds the toolbar item with the resolved route as the value and the dispatched action in the tooltip.	RouterPanel

Method details

getDetail()

public function getDetail(): string

Renders the detail view through the shared declarative presenter.

Returns

string: Rendered panel markup.

getName()

public function getName(): string

Returns the panel display name from the shared title enum.

Returns

string: Panel display name.

getSnapshot()

public function getSnapshot(): PHPForge\Debug\Panel\Router\RouterSnapshot|null

Returns the captured routing snapshot for composition by another panel.

Returns

PHPForge\Debug\Panel\Router\RouterSnapshot|null: Captured routing trace, or null before hydration.

getToolbarIcon()

public function getToolbarIcon(): string

Returns the icon key from the shared panel icon enum.

Returns

string: Toolbar icon key.

hydrate()

public function hydrate(array<string, mixed> $payload): void

Decodes the captured payload into the typed routing snapshot backing this panel.

Parameters

Parameter	Type	Description
$payload	array<string, mixed>	Captured panel payload.

Throws

• PHPForge\Debug\Storage\HydrationException: when the payload does not match the snapshot schema.

isVisible()

public function isVisible(): bool

Keeps explicitly configured Router panels standalone while allowing the built-in instance to act as a hidden compatibility data source for Request.

Returns

bool: true when the panel renders on its own; false when it only feeds Request.

getToolbarItems()

protected function getToolbarItems(): array<int, array<string, mixed>>

Builds the toolbar item with the resolved route as the value and the dispatched action in the tooltip.

Returns

array<int, array<string, mixed>>: Single-element list with the route chip.