PackageManifest

MMO\core\helpers · 1 symbol · generated 30 Sep 2026

class

PackageManifest

Store mmoframework package informations

class MMO\core\helpers\PackageManifest implements JsonSerializable

Namespace: MMO\core\helpers
Implements: JsonSerializable

Hooks: - include(this, $config): triggered by package manager when the manifest configuration is included - load(this): triggered when new data are loaded into the manifest - pre-build(this, filename, $options): triggered before building the package - post-build(this, filename, $options): triggered after building the package - package(this, filename, $options): triggered by the package manager when the package is copied to a project packages folder (the filename is the real package's filename) - i18n(this, $language, $file): triggered when internationalization file is loaded

$m = new PackageManifest(['name' => 'my-pkg', 'version' => '1.0.0', 'filename' => '/path/to/manifest.json']); $m->incVersion(); $m->save();

Index

	bootstrap
	build
	demo
	dependencies
	description
	documentations
	filename
	hooks
	i18n
	icon
	included
	keywords
	languages
	links
	name
	namespace
	readme
	sources
	status
	tests
	title
	urls
	version
	addHook($hook, $callback)	Register a callback for $hook (see this class's own docblock for the list of hooks and when each fires).
	build($filename, $compression, $options)	Build package
	debugName()
	executeHook($name, $args)	Execute a hook in the manifest
	FromJsonFile($filename) static
	getAllDependencies()
	getBuildFilename()	Get the package absolute filename
	getBuildFolder()
	getDemoFolder()
	getDocumentationFolders()	Get a list of existing documentations folders
	getIconFilename()
	getReadmeFilename()
	getReleaseNotes()	Get a list of releases notes filename
	getShowcasePath($path)	Resolve one of the showcase paths (`$icon`, `$readme`, `$demo`) against the manifest's folder.
	getSkillFolders()	The agent skills this package holds: every real folder of its `.claude/skills/`, which
	getTestsFilename()
	getTitle()
	incVersion($where, $inc)	Bump `$version` in place.
	isPackageUpToDate()
	isPhar()
	isValid()	Tells if manifest is valid
	jsonSerialize()
	load($data)	Load data into the manifest
	loadJsonFile($filename)	Load (`load`) this manifest's data from a JSON file, also recording $filename itself (`$filename`).
	loadLanguage($language)	Load and register (with the shared `I18n` instance) this package's translations for $language, from
	loopSources($resolve)
	reload()	Re-read this manifest's own `$filename` from disk, discarding any in-memory changes.
	removeHook($hook, $callback)
	save($filename)	Write this manifest back out as JSON.
	toArray()	Get the manifest's data
	__construct($data)

Properties23

bootstrap

string $bootstrap = 'src/bootstrap.php'

Type: string

build

string $build = 'build/{name}.{version}.phar'

Type: string

demo

string $demo = 'demo/www'

Type: string

dependencies

array $dependencies = []

Type: array

description

string $description = ''

Type: string

documentations

array $documentations = ['docs']

Type: array

filename

string $filename

Type: string

hooks

array $hooks = []

Type: array

i18n

string $i18n = 'src/i18n'

Type: string

icon

string $icon = 'icon.svg'

Type: string

included

bool $included = false

Type: bool

keywords

array $keywords = []

Type: array

languages

protected ?array $languages = null

Type: null | array

name

string $name

Type: string

namespace

string $namespace

Type: string

readme

string $readme = 'README.md'

Type: string

sources

array $sources = ['src']

Type: array

status

string $status = 'stable'

Type: string

tests

string $tests = 'phpunit.xml'

Type: string

title

string $title = ''

Type: string

urls

array $urls = []

Type: array

version

string $version

Type: string

Methods31

addHook($hook, $callback)

PackageManifest.php:238

function addHook(string $hook, callable $callback): callable

$hook	string
$callback	callable	function(PackageManifest $manifest, mixed ...$args): void
returns	callable	$callback, for chaining (e.g. `$cb = $manifest->addHook(...)`, to later `removeHook` it)

build($filename, $compression, $options)

PackageManifest.php:333

Build package

function build( ?string $filename = null, int $compression = Phar::NONE, array $options = [] ): string

$filename = null	null \| string	the filename for the package if null use the `build` key in the manifest
$compression = Phar::NONE	int	one of the PHAR compression constant
$options = []	array	forwarded to the 'pre-build'/'post-build' hooks
returns	string	the package's filename

debugName()

PackageManifest.php:198

function debugName(): string

returns string e.g. 'my-pkg.1.0.0' NOTE: $name/$version are typed, non-nullable properties with no default, so a manifest that failed to load fully (e.g. an invalid config, see load) may not have them set yet. This is guarded with isset() because describe (used while rendering ANY exception whose $origin is this manifest, regardless of whether the message even mentions {origin}) calls debugName() unconditionally -- an unguarded access here used to turn a clear "unknown configuration" error into a confusing, unrelated "must not be accessed before initialization" one, masking the real problem.

executeHook($name, $args)

PackageManifest.php:266

Execute a hook in the manifest

function executeHook(string $name, mixed ...$args): bool

$name	string	the hook's name
...$args	mixed
returns	bool	true if hook was executed

$manifest->executeHook('i18n', 'fr-FR', $file);

FromJsonFile($filename)

staticPackageManifest.php:113

static function FromJsonFile(string $filename): static

$filename	string	a package.json-style manifest file
returns	static

getAllDependencies()

PackageManifest.php:446

function getAllDependencies(): array

returns array this package's full (transitive) dependency list, via PackageManager

getBuildFilename()

PackageManifest.php:286

Get the package absolute filename

function getBuildFilename(): string

returns

string

getBuildFolder()

PackageManifest.php:291

function getBuildFolder(): string

returns string the directory getBuildFilename lives in

getDemoFolder()

PackageManifest.php:418

function getDemoFolder(): ?string

returns null | string this package's demo document root ($demo), or null when it ships none

getDocumentationFolders()

PackageManifest.php:352

Get a list of existing documentations folders

function getDocumentationFolders(): array

returns

array

getIconFilename()

PackageManifest.php:408

function getIconFilename(): ?string

returns null | string this package's logo ($icon), or null when it ships none

getReadmeFilename()

PackageManifest.php:413

function getReadmeFilename(): ?string

returns null | string this package's readme ($readme), or null when it ships none

getReleaseNotes()

PackageManifest.php:432

Get a list of releases notes filename

function getReleaseNotes(): array

returns array every file under a 'releaseNotes' subfolder of each getDocumentationFolders entry

getShowcasePath($path)

PackageManifest.php:401

Resolve one of the showcase paths ($icon, $readme, $demo) against the manifest's folder.

protected function getShowcasePath(string $path): ?string

Nothing is ever created here: a package that ships no logo, no readme or no demo gets null, so whatever lists packages shows what is there instead of failing on what is not -- same contract as

See: getDocumentationFolders, which silently drops a folder that does not exist.

$path	string	a path relative to the manifest's folder, resolved through `filename()`
returns	null \| string	the absolute filename, or null when $path is empty or names nothing

getSkillFolders()

PackageManifest.php:372

The agent skills this package holds: every real folder of its .claude/skills/, which

function getSkillFolders(): array

A link is left out. Libraries link to the skill of the package that holds it (`mmoframework` is mmo.core's) rather than copying it, so following links would put that skill in every package.

See: MCPController serves and build puts in the package under the same name.

returns array string> .claude/skills/<skill> => its folder

$manifest->getSkillFolders(); // ['.claude/skills/mmoframework' => '/…/libs/core/.claude/skills/mmoframework']

getTestsFilename()

PackageManifest.php:424

function getTestsFilename(): ?string

returns null | string this package's phpunit configuration ($tests), or null when it ships no tests

getTitle()

PackageManifest.php:386

function getTitle(): string

returns

string

this package's human readable name, its short name when none was declared.

incVersion($where, $inc)

PackageManifest.php:172

Bump $version in place.

function incVersion(int $where = MMO\core\versions\PATCH, int $inc = 1): void

See: inc's own behavior)

$where = MMO\core\versions\PATCH	int	one of \MMO\core\versions\{MAJOR,MINOR,PATCH} -- only that single component is incremented, lower-precision components are NOT reset to 0 (see
$inc = 1	int
returns	void

$manifest->incVersion(); // '1.0.0' -> '1.0.1'

$manifest->incVersion(\MMO\core\versions\MINOR); // '1.0.1' -> '1.1.1' (patch is NOT reset)

isPackageUpToDate()

PackageManifest.php:311

function isPackageUpToDate(): bool

returns bool true if the built package (getBuildFilename) exists and is newer than every source file (always true for a .phar package, which is inherently self-consistent)

isPhar()

PackageManifest.php:177

function isPhar(): bool

returns bool true if $filename points inside a .phar archive

isValid()

PackageManifest.php:185

Tells if manifest is valid

function isValid(): bool

returns

bool

jsonSerialize()

PackageManifest.php:120

function jsonSerialize(): array

returns array same as toArray, for json_encode()

load($data)

PackageManifest.php:208

Load data into the manifest

function load(array $data): void

$data	array	every key MUST be a declared public property of this class
returns	void
throws		if $data contains an unknown key

loadJsonFile($filename)

PackageManifest.php:129

Load (load) this manifest's data from a JSON file, also recording $filename itself ($filename).

function loadJsonFile(string $filename): self

$filename	string
returns	self	$this, for chaining

loadLanguage($language)

PackageManifest.php:463

Load and register (with the shared I18n instance) this package's translations for $language, from

function loadLanguage(string $language): bool

See: $i18n. Translation files are discovered (and cached) on first call; each is a plain PHP file returning a translation array, include_once-d so it only actually runs once even across repeated calls.

$language	string	a language tag (e.g. 'fr-FR'), matched via `I18n::findLanguage` (so a broader match like 'fr' can still resolve to a more specific 'fr-FR' file, or vice versa)
returns	bool	true if a matching translation file was found (and loaded, or already had been)

$manifest->loadLanguage('fr-FR');

loopSources($resolve)

PackageManifest.php:300

function loopSources(bool $resolve = true): Generator

$resolve = true	bool	if true, each source is resolved to an absolute path (relative to this manifest's own directory); if false, the raw `$sources` entries are yielded as-is
returns	Generator	every entry of `$sources`, skipping inline-code ones (those starting with '=')

reload()

PackageManifest.php:141

Re-read this manifest's own $filename from disk, discarding any in-memory changes.

function reload(): self

returns	self	$this, for chaining
throws		if `$filename` was never set

removeHook($hook, $callback)

PackageManifest.php:249

function removeHook(string $hook, callable $callback): bool

$hook	string
$callback	callable	the exact callback previously passed to `addHook`
returns	bool	true if it was found (and removed)

$cb = $manifest->addHook('load', fn($m) => ...); $manifest->removeHook('load', $cb);

save($filename)

PackageManifest.php:153

Write this manifest back out as JSON.

function save(?string $filename = null): void

$filename = null	null \| string	defaults to `$filename`; if given and `$filename` wasn't set yet, it is also adopted as this manifest's own filename
returns	void
throws		if $filename is null and `$filename` was never set

toArray()

PackageManifest.php:221

Get the manifest's data

function toArray(): array

returns array every public property except $filename and $included (which are local bookkeeping, not part of the persisted manifest)

__construct($data)

PackageManifest.php:105

function __construct(array $data = [])

$data = [] array initial values, see load