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.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$actions | array<string, | Standalone actions merged into the debug module’s Module::$actionMap, keyed by action ID. Default: []. | yii\ |
$behaviors read-only | array<yii\<static>> | List of behaviors attached to this component. | yii\ |
$detail read-only | string | Rendered panel markup. | ConfigPanel |
$extensions read-only | array<string, | Extension versions keyed by package name, sorted alphabetically. | ConfigPanel |
$id | string | Panel unique identifier, assigned by the container module on registration. Default: ''. | yii\ |
$module | yii\| | Debug module owning this panel. Default: null. | yii\ |
$name read-only | string | Panel display name. | ConfigPanel |
$phpVersion read-only | string| | PHP version of the capture, or null when it was not recorded. | ConfigPanel |
$renderContext | PHPForge\ | Prepared render context, or null outside a debugger request. | yii\ |
$tag | string | Tag of the request whose data this panel currently exposes. Default: ''. | yii\ |
$toolbarData read-only | array<string, | Toolbar envelope; [] to skip the panel. | yii\ |
$toolbarIcon read-only | string | Toolbar icon key. | ConfigPanel |
$url read-only | string | Absolute URL to the panel detail view. | yii\ |
$viewPath read-only | string | Directory the panel views resolve against. | yii\ |
$yiiVersion read-only | string| | Yii version of the capture, or null when it was not recorded. | ConfigPanel |
$error protected | PHPForge\ | Exception captured when the panel failed to produce or hydrate its snapshot. Default: null. | yii\ |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Constructor. | yii\ |
__call() | Calls the named method which is not a class method. | yii\ |
__clone() | This method is called after the object is created by cloning an existing one. | yii\ |
__get() | Returns the value of a component property. | yii\ |
__isset() | Checks if a property is set, i.e. defined and not null. | yii\ |
__set() | Sets the value of a component property. | yii\ |
__unset() | Sets a component property to be null. | yii\ |
attachBehavior() | Attaches a behavior to this component. | yii\ |
attachBehaviors() | Attaches a list of behaviors to the component. | yii\ |
behaviors() | Returns a list of behaviors that this component should behave as. | yii\ |
canGetProperty() | Returns a value indicating whether a property can be read. | yii\ |
canSetProperty() | Returns a value indicating whether a property can be set. | yii\ |
capture() | Captures the panel payload for the current request. | yii\ |
className() static | Returns the fully qualified name of this class. | yii\ |
detachBehavior() | Detaches a behavior from the component. | yii\ |
detachBehaviors() | Detaches all behaviors from the component. | yii\ |
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\ |
getBehavior() | Returns the named behavior object. | yii\ |
getBehaviors() | Returns all behaviors attached to this component. | yii\ |
getDetail() | Renders the detail view through the shared declarative presenter. | ConfigPanel |
getError() | Returns the exception captured while collecting the panel payload, if any. | yii\ |
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\ |
getToolbarData() | Returns the toolbar envelope wrapping the panel’s icon, items, and URL. | yii\ |
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\ |
getUrl() | Returns the URL pointing to this panel’s detail view for the current request tag. | yii\ |
getViewPath() | Returns the directory under which the panel’s relative views resolve. | yii\ |
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\ |
hasError() | Returns true when setError() captured an exception during panel capture or hydration. | yii\ |
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\ |
hasMethod() | Returns a value indicating whether a method is defined. | yii\ |
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\ |
hydrate() | Decodes the captured payload into the typed configuration snapshot backing this panel. | ConfigPanel |
init() | Initializes the object. | yii\ |
isEnabled() | Indicates whether this panel is enabled and should be registered by the module. | yii\ |
isVisible() | Returns whether the panel should appear in the toolbar and sidebar navigation. | yii\ |
moduleBound() | Completes module-dependent wiring after the container module binds $id and $module. | yii\ |
off() | Detaches an existing event handler from this component. | yii\ |
on() | Attaches an event handler to an event. | yii\ |
setError() | Records an exception thrown during capture or hydration so LogTarget can surface it in the UI. | yii\ |
setRenderContext() | Installs the framework-neutral render context prepared for this panel by the debugger action. | yii\ |
trigger() | Triggers an event. | yii\ |
getToolbarItems() protected | 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). | ConfigPanel |
Method details
Section titled “Method details”getDetail()
Section titled “getDetail() ”public function getDetail(): stringRenders the detail view through the shared declarative presenter.
Returns
string: Rendered panel markup.
getExtensions()
Section titled “getExtensions() ”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.
getName()
Section titled “getName() ”public function getName(): stringReturns the panel display name from the shared title enum.
Returns
string: Panel display name.
getPhpVersion()
Section titled “getPhpVersion() ”public function getPhpVersion(): string|nullReturns 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.
getToolbarIcon()
Section titled “getToolbarIcon() ”public function getToolbarIcon(): stringReturns the icon key from the shared panel icon enum.
Returns
string: Toolbar icon key.
getYiiVersion()
Section titled “getYiiVersion() ”public function getYiiVersion(): string|nullReturns 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.
hydrate()
Section titled “hydrate() ”public function hydrate(array<string, mixed> $payload): voidDecodes the captured payload into the typed configuration snapshot backing this panel.
Parameters
| Parameter | Type | Description |
|---|---|---|
$payload | array<string, | Captured panel payload. |
Throws
PHPForge\Debug\Storage\HydrationException: when the payload does not match the snapshot schema.
getToolbarItems()
Section titled “getToolbarItems() ”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 [].