README

Debug Core

A framework-agnostic PHP core providing snapshots, storage, and the complete frontend for debugger adapters.

Features

Installation

Install an adapter, not this package. Debug Core is pulled in transitively:

• yii2-extensions/debug
• yii3/debug

If you develop an adapter:

composer require php-forge/debug-core

PHP 8.3 or later and the ctype, intl, and mbstring extensions are required.

Adapter boundary

The core owns snapshot capture, persistence, comparison, and the shared UI. A framework adapter remains responsible for:

• collecting framework data through PHPForge\Debug\CollectorInterface, the single collector contract shared with provider-owned collectors, and returning the persisted payload from capture();
• exposing the toolbar data endpoints and deciding when a response receives the toolbar;
• defining and publishing assets through its own framework;
• rendering the shared templates with its view component;
• routes, controllers, URL generation, panel metadata, and framework-specific panel views;
• implementing Routing\DebugUrlGeneratorInterface so portable renderers build panel links without a framework URL manager.

The adapter-facing API is documented in the source PHPDoc under src/.

Frontend development

The frontend source lives in resources/src and Vite builds it into resources/assets/dist. Two entries are built:

• resources/src/toolbar/index.js — the <yii-debug-toolbar> custom element. element.js owns the view state, the shadow skeleton, and the render cycle; it composes one controller per responsibility (loader.js, theme-controller.js, drawer.js) and renders through the stateless builders in render.js.
• resources/src/core/debug.js — the debugger page bootstrap. It resolves the theme, initializes the page controllers (theme.js, disclosure.js, live-filter.js, grid-navigation.js, tabs.js, deep-links.js, clipboard.js, features.js), and owns the keyboard precedence between the layers.

Rebuild and verify with:

npm install
npm run format:check
npm run lint:js
npm run lint:css
npm run test:js
npm run build
npm run check:size
npm run check:icons

check:icons compares the toolbar's inline glyphs with resources/assets/svg; the toolbar-only chrome glyphs (chevron-left, chevron-right, close, external-link) have no panel file by design and never fail --strict.

Package information

Code quality

Social networks

License