Symbols final class
Minn\Runtime\Symbols · public/minn/src/Minn/Runtime/Symbols.php · 391 lines
A static read of what a plugin's PHP calls: global functions and classes it uses but does not itself declare, minus the ones it guards with function_exists() or class_exists(). Checked against what the runtime provides, this decides whether a plugin loads at all.
The read is cached in the minn_runtime_symbols option, keeping only the reference's own names (all a verdict reads). An entry is trusted while the folder's fingerprint (its own time and its top-level files' newest) holds, for up to FULL_CHECK_EVERY seconds; then the whole folder is walked again, as an update replaces it. Installing, updating or activating a plugin walks its folder at once (recheck()). Walking every folder on every request cost hundreds of milliseconds on a site with many plugins.
Constants and properties
| private | MAX_FILES = 6000 | |
| private | SKIP_DIRS = array ( 0 => 'node_modules', 1 => 'tests', 2 => 'test', 3 => '.git', ) | |
| private | READER = 3 | Bumped whenever the token reader changes, so every cached scan is made again. |
| private | FULL_CHECK_EVERY = 300 | How long a cached entry is trusted on its fingerprint alone before the folder is walked again. |
| private | static ?array $pending |
Public
| static | missing(string $dir, Minn\Runtime\Options $options): array# | What a plugin folder needs that the runtime lacks, cached by mtime. @return array{functions: list<string>, classes: list<string>, redeclares: list<string>, files: int, truncated: bool} | |||
| static | recheck(string $dir, Minn\Runtime\Options $options): void# | The folder is walked again at its next check instead of trusted on its fingerprint: an install, an update or an activation never waits out the window. The walk still keeps the cached read when nothing changed. | |||
| static | redeclaresIn(string $file): array# | The functions one file declares in the global scope, unguarded, that the loaded runtime already defines: including that file would not compile. @return list<string> | |||
| static | missingAgainst(string $dir, Minn\Runtime\SymbolGap $gap): array# | The same read against an exported gap instead of the running engine, so a folder can be judged with no database, no options, and no facade loaded. @return array{functions: list<string>, classes: list<string>, redeclares: list<string>, files: int, truncated: bool} | |||
| static | survey(string $dir, Minn\Runtime\SymbolGap $gap, array $deadEnds): array# | What a folder needs and what it reaches that Minn answers with nothing, in one read, for a machine judging a site before the engine runs it (preflight): the gate's verdict against the gap given, and the dead ends it calls (the wp-admin screens, the editors, the Customizer, XML-RPC, what was left out), by area. A call the folder guards or answers itself is not counted, as the gate counts it.
@return array{functions: list<string>, classes: list<string>, redeclares: list<string>, files: int, truncated: bool, deadEnds: array<string, list<string>>} |
Internals 10
Private and protected methods: how the class does its work. Not a contract; they change whenever the code is tidied.
| private | keep(array $cache, Minn\Runtime\Options $options): void# | The cache changed this request: written once, when the request ends. | |||
| private | fingerprint(string $dir): string# | A folder's cheap fingerprint: its own time and its top-level PHP files' newest (an update replaces the folder; a version bumps the main file). | |||
| private | namesStamp(): string# | The reference names a reduced scan was kept against: a new interface (a WordPress update) makes every scan again. | |||
| private | reduced(array $scan): array# | A scan cut to the reference's own names, the only ones a verdict asks about.
@return array<string, mixed> | |||
| private | verdict(array $scan, int $files, Minn\Runtime\SymbolGap $gap): array# | Only the reference's own interface counts: a function or class the plugin needs from WordPress. Its own integrations with other plugins and PHP extensions are its business.
@return array{functions: list<string>, classes: list<string>, redeclares: list<string>, files: int, truncated: bool} | |||
| private | phpFiles(string $dir): array# | @return list<string> | |||
| private | scan(array $files): array# | Every file's tokens into one table: the functions called, the classes referenced, both minus what the folder declares itself or guards with an existence check.
@return array{calls: list<string>, classes: list<string>, declared: array<string, true>, declaredClasses: array<string, true>, guarded: array<string, true>, truncated: bool} | |||
| private | scanTokens(array $tokens, Minn\Runtime\SymbolTable $table): void# |
| |||
| private | noteName(array $tokens, int $i, bool $namespaced, Minn\Runtime\SymbolTable $table): void# | A name token: a class reference when it follows new / extends / implements / instanceof or precedes ::, a call when it precedes "(", and a guard when the call is an existence check on a literal.
| |||
| private | significant(array $tokens, int $from, int $step): ?array# | The nearest token in either direction that is not whitespace or a comment, as [id, text]. @param list<array|string> $tokens @return array{0: ?int, 1: string}|null
|
Nothing matches.