Documentation

Kind
in package

Describes one resolvable kind of framework component: where it lives in userspace, inside a module, and inside the framework itself.

Table of Contents

$deepFiles  : bool
Whether files() enumerates recursively (false = flat glob, like routes).
$deepFind  : bool
Whether find() may fall back to the recursive per-root index.
$extensions  : array<string|int, mixed>
Extensions probed by find(), in order.
$frameworkSubPath  : string|null
Path under z_framework_root, or null when the framework ships none (seeds).
$moduleSubPath  : string
Root-relative path inside a module, e.g. "app/Controllers".
$name  : string
Kind identifier, e.g. "controllers".
$userspaceConfigKey  : string|null
Config key holding the userspace root (e.g. "z_controllers"), or null.
$userspacePath  : string|null
Fixed userspace root when no config key exists (e.g. "./app/Database/seed").
__construct()  : mixed
userspaceRoot()  : string

Properties

$deepFiles

Whether files() enumerates recursively (false = flat glob, like routes).

public bool $deepFiles = true

$deepFind

Whether find() may fall back to the recursive per-root index.

public bool $deepFind = true

$extensions

Extensions probed by find(), in order.

public array<string|int, mixed> $extensions = [".php"]

$frameworkSubPath

Path under z_framework_root, or null when the framework ships none (seeds).

public string|null $frameworkSubPath

$moduleSubPath

Root-relative path inside a module, e.g. "app/Controllers".

public string $moduleSubPath

$name

Kind identifier, e.g. "controllers".

public string $name

$userspaceConfigKey

Config key holding the userspace root (e.g. "z_controllers"), or null.

public string|null $userspaceConfigKey

$userspacePath

Fixed userspace root when no config key exists (e.g. "./app/Database/seed").

public string|null $userspacePath

Methods

__construct()

public __construct(string $name, string|null $userspaceConfigKey, string|null $userspacePath, string $moduleSubPath, string|null $frameworkSubPath[, array<string|int, mixed> $extensions = [".php"] ][, bool $deepFind = true ][, bool $deepFiles = true ]) : mixed
Parameters
$name : string
$userspaceConfigKey : string|null
$userspacePath : string|null
$moduleSubPath : string
$frameworkSubPath : string|null
$extensions : array<string|int, mixed> = [".php"]
$deepFind : bool = true
$deepFiles : bool = true
Return values
mixed —

userspaceRoot()

public userspaceRoot() : string
Return values
string —

Search results