Skip to content
PHP Ecosystem
Explore

ConfigPanel

API reference › Debug › panels › ConfigPanel

Renders the application configuration and runtime environment captured by the Configuration collector.

Delegates the detail view to the framework-neutral ConfigPanel and keeps the brand-chip version readouts; data acquisition lives in ConfigCollector.

PropertyTypeDescriptionDefined by
$actionsarray<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-onlyarray<yii\base\Behavior<static>>List of behaviors attached to this component.yii\base\Component
$detail read-onlystringRendered panel markup.ConfigPanel
$extensions read-onlyarray<string, string>Extension versions keyed by package name, sorted alphabetically.ConfigPanel
$idstringPanel unique identifier, assigned by the container module on registration. Default: ''.yii\debug\Panel
$moduleyii\debug\Module|nullDebug module owning this panel. Default: null.yii\debug\Panel
$name read-onlystringPanel display name.ConfigPanel
$phpVersion read-onlystring|nullPHP version of the capture, or null when it was not recorded.ConfigPanel
$renderContextPHPForge\Debug\Panel\PanelRenderContext|nullPrepared render context, or null outside a debugger request.yii\debug\Panel
$tagstringTag of the request whose data this panel currently exposes. Default: ''.yii\debug\Panel
$toolbarData read-onlyarray<string, mixed>Toolbar envelope; [] to skip the panel.yii\debug\Panel
$toolbarIcon read-onlystringToolbar icon key.ConfigPanel
$url read-onlystringAbsolute URL to the panel detail view.yii\debug\Panel
$viewPath read-onlystringDirectory the panel views resolve against.yii\debug\Panel
$yiiVersion read-onlystring|nullYii version of the capture, or null when it was not recorded.ConfigPanel
$error protectedPHPForge\Debug\Storage\ExceptionSnapshot|nullException captured when the panel failed to produce or hydrate its snapshot. Default: null.yii\debug\Panel
MethodDescriptionDefined 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() staticReturns 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.ConfigPanel
getError()Returns the exception captured while collecting the panel payload, if any.yii\debug\Panel
getExtensions()Returns the installed-extensions roster as a sorted name => version map.ConfigPanel
getName()Returns the panel display name from the shared title enum.ConfigPanel
getPhpVersion()Returns the saved PHP version (php.version), or null when the snapshot is missing.ConfigPanel
getRenderContext()Returns the framework-neutral render context for the active debugger request, when one has been prepared.yii\debug\Panel
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.ConfigPanel
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
getYiiVersion()Returns the saved Yii framework version (application.yii), or null when the snapshot is missing.ConfigPanel
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 configuration snapshot backing this panel.ConfigPanel
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()Returns whether the panel should appear in the toolbar and sidebar navigation.yii\debug\Panel
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() protectedSuppresses the per-panel toolbar item: the configuration data is already surfaced through the Yii brand chip (links to this panel) and the dedicated PHP chip (links to php-info).ConfigPanel
public function getDetail(): string

Renders the detail view through the shared declarative presenter.

Returns

string: Rendered panel markup.

public function getExtensions(): array<string, string>

Returns the installed-extensions roster as a sorted name => version map.

Returns

array<string, string>: Extension versions keyed by package name, sorted alphabetically.

public function getName(): string

Returns the panel display name from the shared title enum.

Returns

string: Panel display name.

public function getPhpVersion(): string|null

Returns the saved PHP version (php.version), or null when the snapshot is missing.

Returns

string|null: PHP version of the capture, or null when it was not recorded.

public function getToolbarIcon(): string

Returns the icon key from the shared panel icon enum.

Returns

string: Toolbar icon key.

public function getYiiVersion(): string|null

Returns the saved Yii framework version (application.yii), or null when the snapshot is missing.

Returns

string|null: Yii version of the capture, or null when it was not recorded.

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

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

Parameters

ParameterTypeDescription
$payloadarray<string, mixed>Captured panel payload.

Throws

  • PHPForge\Debug\Storage\HydrationException: when the payload does not match the snapshot schema.
protected function getToolbarItems(): array<int, array<string, mixed>>

Suppresses the per-panel toolbar item: the configuration data is already surfaced through the Yii brand chip (links to this panel) and the dedicated PHP chip (links to php-info).

Returns

array<int, array<string, mixed>>: Always [].