Documentation

RouterSingleMode extends Router

in package

• karmabunny
• router

Single mode router will match routes one-by-one.

Table of Contents

Constants

ATTR_ALL  : mixed = self::ATTR_ATTRIBUTES | self::ATTR_DOCS

Extract all attribute routes.

ATTR_ATTRIBUTES  : mixed = 1

Extract attribute (PHP8) routes.

ATTR_DOCS  : mixed = 2

Extract doc routes.

EXTRACT_ALL  : mixed = 3

Extract routes from both namespaces + attributes.

EXTRACT_ATTRIBUTES  : mixed = 2

Extract routes from attributes.

EXTRACT_CONVERT_REGEX  : mixed = 128

Convert extracted rule-style patterns to regex.

EXTRACT_NAMESPACES  : mixed = 1

Extract routes from method namespaces.

EXTRACT_NESTED_PREFIXES  : mixed = 1024

Add prefixes, but also permit multiple controllers per rule.

EXTRACT_NONE  : mixed = 0

Do not extract routes from classes.

EXTRACT_SHORT_NAMESPACES  : mixed = 512

Use only the class::method when extracting namespace rules.

EXTRACT_SORT_ATTRIBUTES  : mixed = 2048

Sort attributes by priority.

EXTRACT_WITH_PREFIXES  : mixed = 256

Add prefixes (from the route table) to the extracted extract routes.

METHODS  : mixed = ['HEAD', 'GET', 'OPTIONS', 'POST', 'PUT', 'PATC...

Some standard default methods.

MODE_CHUNKED  : mixed = 'chunked'

Use (fast) 'rule' patterns when parsing rules.

MODE_REGEX  : mixed = 'regex'

Use regex patterns when parsing rules.

MODE_SINGLE  : mixed = 'single'

Use (slow) 'rule' patterns when parsing rules.

MODES  : mixed = [self::MODE_SINGLE => \karmabunny\router\Modes\...

PATTERN_NAMED  : string = '(?<\1>[^/]+?)'

Replacement for rule variables.

PATTERN_WILD  : string = '(.+?)'

RULE_TEMPLATE  : string = '!\\\\{([a-z][a-z0-9_]*)\\\\}!i'

Match for rule variables like `{var}`, after `preg_quote`.

RULE_WILDCARD  : string = '!\\\\\\*+!'

Match for rule wildcards like `*`, after `preg_quote`.

Properties

$config  : RouterConfig

$patterns  : array<string|int, mixed>

$routes  : array<string, mixed>

$rule_inspector  : callable|null

Methods

compile()  : void

Create regex patterns from the route rules.

convertRuleToPattern()  : string

Convert rule patterns to a regex. This only performs the argument swaps.

create()  : Router

Create a router.

extractFromAttributes()  : array<string|int, mixed>

Find all the attribute routes on a target object/class.

extractFromNamespaces()  : array<string|int, mixed>

Find all the namespace routes on a target object/class.

extractRuleNames()  : array<string|int, string>

Determine the parameter names of a route pattern.

fillRuleValues()  : string

Insert parameters into a route pattern.

find()  : null|Action

Find a matching route.

getRoutes()  : array<string, mixed>

Get the currently loaded routes.

getRuleInspector()  : callable

Get the rule inspector function.

isCallable()  : bool

Is the 'target' callable?

load()  : array<string, mixed>

Load routes.

loadAttributes()  : void

Load attribute routes from a class.

loadFrom()  : void

Load magic routes from a class.

loadNamespaces()  : void

Load namespace routes from a class.

normalizeMatches()  : array<string|int, mixed>

Given an array of matches from `preg_match()` the named groups are duplicate entries. This will strip the numeric versions _and_ append non-named groups to the end of the array.

sortAttributes()  : void

Sort attributes by priority.

__construct()  : mixed

editNamespaceRule()  : string

Call the user-configured edit namespace rule config.

expandRule()  : string

Expand route patterns into full regex patterns.

extractAll()  : array<string, mixed>

Perform rule extractions, as appropriate.

insertPrefix()  : string

Insert a prefix.

## /Bloom/Controllers/ToolsController::dbSync($schema)
=> 'ACTION /tools/db-sync/{$schema}'

$route = $router->find($method, $path);
if (!$route) {
   $route = $router->find('ACTION', $path);
}

// Where 'a' + 'b' are names groups, 'm2' is numeric
$matches = [
   'a' => 'm1',
   'm1',
   'm2',
   'b' => 'm3',
   'm3',
];
// Normalise
$args = [
   'a' => 'm1',
   'b' => 'm3',
   'm2',
];