Router

Framework router with config-backed module and locale route registration.

The router reads defaults, not-found targets, hostnames, and locales from the PhalconKit config service. It remains compatible with Phalcon's router API while exposing a small toArray() diagnostic snapshot through RouterInterface.

• Full name: \PhalconKit\Mvc\Router
• Parent class: Router
• This class implements: RouterInterface, \PhalconKit\Router\RouterInterface

See Also:

• https://docs.phalcon.io/latest/routing/

Properties

config

Config service used to build default, hostname, module, and locale routes.

public \PhalconKit\Config\ConfigInterface $config

Methods

getConfig

Return the config service attached to the router.

public getConfig(): \PhalconKit\Config\ConfigInterface

setConfig

Attach the config service used by route registration helpers.

public setConfig(\PhalconKit\Config\ConfigInterface $config): void

Parameters:

__construct

Create a config-aware router.

public __construct(bool $defaultRoutes = true, \PhalconKit\Config\ConfigInterface|null $config = null): mixed

Native Phalcon default routes are disabled so PhalconKit can register its own module-aware routes. When $defaultRoutes is true, route defaults are read immediately from config.

Parameters:

defaultRoutes

Register the default module route group from config.

public defaultRoutes(): void

The method applies configured defaults, configured not-found paths, extra slash handling, and locale-aware module routes.

hostnamesRoutes

Register hostname-specific module route groups.

public hostnamesRoutes(array<string,array<string,mixed>>|null $hostnames = null, array<string,mixed>|null $defaults = null): void

Each hostname entry must declare a string module; the remaining values are merged into the route defaults for that hostname.

Parameters:

Throws:

When a hostname entry does not declare a string module name. - ConfigurationException

modulesRoutes

Register route groups for modules known by the MVC application.

public modulesRoutes(\Phalcon\Mvc\Application $application, array<string,mixed>|null $defaults = null): void

The module namespace is inferred from the module class name, matching the framework module structure. Applications with custom namespaces can mount their own ModuleRoute instances when this convention is not appropriate.

Parameters:

Throws:

When a module definition is missing className. - ConfigurationException

toArray

Export the current router match state for diagnostics.

public toArray(): array<string,mixed>

Return Value:

Current namespace, module, controller, action, params, defaults, matches, and matched-route metadata.