PackageManager

MMO\core · 1 symbol · generated 30 Sep 2026

class

PackageManager

## Structure of the manifest: mmo.json the packages manager will try to find a mmo.json in the current folder or one of its parent in auto mode.

class MMO\core\PackageManager extends MMO\core\classes\aModule

Namespace: MMO\core
Extends: aModule

(disable auto mode by setting a path in the manifest property or false) A manifest file is a json with the following information: - name: the library's name (ex: mmo.xxx) - namespace: the root namespace of the library (ex: MMO\xxx) - version: the library's current version (using semantic versioning specification (SemVer)) - dependencies: a map of library's name and version (ex: {"mmo.core": "20.0"}) - sources: (default [src]) a list of file and folder to add to the package - documentations: (default [docs]) a list of folder where the documentation is. You SHOULD have a folder releaseNotes inside one of this folder containing markdown files for the releases notes - bootstrap: (default src/bootstrap.php) the bootstrap file for the library - urls: [{name} => [{version} => {url}]] or [{folder}] - {url}: the manifest's url. - hooks: [{name} => {callback}] - {callback}: the function to call ## Hooks - pre-build: call before building the package. arguments: (manifest, filename). You can return a different manifest or null. - post-build: call after building the package. arguments: (manifest, filename). No return expected. - package: call when a project is built into a package - load: called by the package manifest itself when it loads its data

Index

	compression
	discoverFolders
	manifests
	manifestUrls
	packagesFolder
	phar
	project
	projectManifest
	urls
	addUrl($name, $version, $url)	Register one more place a package's manifest can be found (`readManifest` discovers these automatically from a manifest's own `urls` entry).
	buildDependencies($dependencies, $folder, $name, $version, $options)	Build all dependencies linked to a package
	buildProject($manifest, $additionalPackages, $folder, $options)	Build a project from a manifest
	DefaultConfig() static
	discoverUrls($folder, $depth)	Discover url reading package*.phar and mmo.json
	enablePhar($value)	Enable phar packages
	fetchBuild($filename, $name, $version, $options)	Fetch a package or build it in the manifest folder and copy it to the destination
	getCompression()
	getDependencies($name, $version, $packageVersions)	Get the dependencies needed for a package
	getManifest($name, $version)	Get a manifest by name and version
	getManifestByNamespace($ns, $version, $included)
	getManifests()
	getProject()
	getProjectBuildFolder($manifest)
	getProjectManifest()
	getUrl($name, $version)
	getUrls()
	hasUrl($name)
	inc($name, $version)	Include a package and every one of its (not-yet-included) dependencies, in dependency order: `require`s each one's bootstrap file and merges its returned configuration (`mergeI…`
	includedVersion($name, $versionConstraint)
	incVersion($manifest, $where, $inc, $save)	Increment manifest version and update indexes
	isIncluded($name, $versionConstraint)
	isPharEnabled()
	loopIncluded()
	loopManifestByNamespace($ns, $version, $included)
	loopManifestByVersions($name, $versionConstraint)	Tells if a manifest exists and returns its version
	readManifest($url)	Read manifest and trigger manifest-read hook
	setCompression($compression)
	setProject($url)	Set the main manifest (mmo.json) to load for the project
	__construct($config)	Includes this framework's own package (`mmo.core`), then discovers sibling `.phar` packages if running from one itself.

Properties9

compression

protected int $compression = 0

Type: int

discoverFolders

#[MMO\core\attributes\Serialize(false)] protected array $discoverFolders = []

Type: array

manifests

#[MMO\core\attributes\Serialize(false)] protected array $manifests = []

Type: array

manifestUrls

#[MMO\core\attributes\Serialize(false)] protected array $manifestUrls = []

Type: array

packagesFolder

protected string $packagesFolder = 'packages'

Type: string

phar

protected bool $phar = true

Type: bool

project

#[MMO\core\attributes\Serialize(unserialize: 'setProject', order: 10)] protected ?string $project = null

Type: null | string

projectManifest

#[MMO\core\attributes\Serialize(false)] protected ?MMO\core\helpers\PackageManifest $projectManifest = null

Type: null | PackageManifest

urls

#[MMO\core\attributes\Serialize(false)] protected array $urls = []

Type: array

Methods30

addUrl($name, $version, $url)

PackageManager.php:211

Register one more place a package's manifest can be found (readManifest discovers these automatically from a manifest's own urls entry).

function addUrl(string $name, string $version, string $url): void

$name	string
$version	string
$url	string
returns	void

buildDependencies($dependencies, $folder, $name, $version, $options)

PackageManager.php:615

Build all dependencies linked to a package

protected function buildDependencies( array &$dependencies, string $folder, string $name, string $version = '*', array &$options = [] ): void

$dependencies	array
$folder	string	the folder to build the phar into (MUST end with '/')
$name	string	the name of the package
$version = '*'	string	the version to build
$options = []	array	options passed to the package's hook and used to determine if a package needs to be built * if a package's namespace is a key, the boolean associated value force/prevent the build of the package * ex: $options['MMO\\core'] = false will prevent package `mmo.core` to be built
returns	void

buildProject($manifest, $additionalPackages, $folder, $options)

PackageManager.php:641

Build a project from a manifest

function buildProject( MMO\core\helpers\PackageManifest|string $manifest, array $additionalPackages = [], ?string $folder = null, array &$options = [] ): array

$manifest	PackageManifest \| string	if string, the filename of the manifest (eq: mmo.json)
$additionalPackages = []	array	packages to add to the project, same format as \MMO\inc(): `[package => version, ...]` or `[package, ...]` (version defaults to '*', the latest)
$folder = null	null \| string	the folder to build the packages into (if null use manifest folder ./packages )
$options = []	array	options to pass to the hook of each packages (WARNING: passed by reference)
returns	array	the list of packages and version built

DefaultConfig()

staticPackageManager.php:72

static function DefaultConfig(): array

returns array default configuration: $project is auto-detected by walking up from the running script's directory looking for an mmo.json (null if none is found up to the filesystem root).

discoverUrls($folder, $depth)

PackageManager.php:180

Discover url reading package*.phar and mmo.json

function discoverUrls(string $folder, int $depth = 1): self

$folder	string	a valid local folder
$depth = 1	int	the depth to look for in folder (default 1, direct manifest only). set to -1 to walk through every child folder
returns	self

enablePhar($value)

PackageManager.php:138

Enable phar packages

function enablePhar(bool $value = true): bool

$value = true	bool
returns	bool	the old value

fetchBuild($filename, $name, $version, $options)

PackageManager.php:573

Fetch a package or build it in the manifest folder and copy it to the destination

function fetchBuild( string $filename, string $name, string $version = '*', array &$options = [] ): string

$filename	string	the destination for the package
$name	string	the package's name
$version = '*'	string	the package's version
$options = []	array	options passed to the package's hook and used to determine if a package needs to be built if a package's namespace is a key, the boolean associated value force/prevent the build of the package ex: $options['MMO\\core'] = false will prevent package `mmo.core` to be built
returns	string	the version fetched

getCompression()

PackageManager.php:117

function getCompression(): int

returns int the compression mode used when building .phar packages (a \Phar::* constant, e.g. \Phar::NONE/\Phar::GZ).

getDependencies($name, $version, $packageVersions)

PackageManager.php:439

Get the dependencies needed for a package

function getDependencies(string $name, string $version = '*', array $packageVersions = []): array

$name	string
$version = '*'	string
$packageVersions = []	array	the versions of packages to prioritize
returns	array

getManifest($name, $version)

PackageManager.php:340

Get a manifest by name and version

function getManifest(string $name, string $version = '*'): ?MMO\core\helpers\PackageManifest

$name	string
$version = '*'	string
returns	null \| PackageManifest

getManifestByNamespace($ns, $version, $included)

PackageManager.php:393

function getManifestByNamespace(string $ns, ?string $version = null, ?bool $included = true): ?MMO\core\helpers\PackageManifest

$ns	string	must match exactly (unlike `loopManifestByNamespace`, no sub-namespace matching).
$version = null	null \| string
$included = true	null \| bool
returns	null \| PackageManifest	the first exact match, or null.

getManifests()

PackageManager.php:401

function getManifests(): array

returns array name => [version => PackageManifest] every manifest read so far (readManifest).

getProject()

PackageManager.php:163

function getProject(): ?string

returns null | string the project manifest's URL (setProject), or null if none is set.

getProjectBuildFolder($manifest)

PackageManager.php:628

function getProjectBuildFolder(MMO\core\helpers\PackageManifest $manifest): string

$manifest	PackageManifest
returns	string	where $manifest's built `.phar` dependencies are placed (`$packagesFolder`, relative to the manifest's own folder).

getProjectManifest()

PackageManager.php:168

function getProjectManifest(): ?MMO\core\helpers\PackageManifest

returns null | PackageManifest the project's own manifest (setProject), or null if none is set.

getUrl($name, $version)

PackageManager.php:226

function getUrl(string $name, string $version = '*'): array

$name	string
$version = '*'	string	a version constraint (`loopVersions`).
returns	array	every URL registered for a version of $name matching $version, most recent matching version first.
throws		if $name is entirely unknown.

getUrls()

PackageManager.php:206

function getUrls(): array

returns

array

name => [version => [url, ...]] every known manifest URL, whether or not its manifest has actually been read yet.

hasUrl($name)

PackageManager.php:216

function hasUrl(string $name): bool

$name	string
returns	bool	whether any URL is known for $name (at any version).

inc($name, $version)

PackageManager.php:485

Include a package and every one of its (not-yet-included) dependencies, in dependency order: requires each one's bootstrap file and merges its returned configuration (mergeInject) into the shared Configuration, unless an Inc listener stops the event for it.

function inc(string $name, string $version = '*'): void

$name	string
$version = '*'	string	a version constraint.
returns	void
throws		if $name (or one of its dependencies) can't be found.
throws		if an included package's folder can't be resolved (not a phar, not a local directory).

includedVersion($name, $versionConstraint)

PackageManager.php:408

function includedVersion(string $name, string $versionConstraint = '*'): ?string

$name	string
$versionConstraint = '*'	string
returns	null \| string	the version of $name currently included (`inc`), matching $versionConstraint, or null if none is.

incVersion($manifest, $where, $inc, $save)

PackageManager.php:540

Increment manifest version and update indexes

function incVersion( MMO\core\helpers\PackageManifest $manifest, int $where = MMO\core\versions\PATCH, int $inc = 1, bool $save = true ): string

$manifest	PackageManifest
$where = MMO\core\versions\PATCH	int
$inc = 1	int
$save = true	bool
returns	string	the new version

isIncluded($name, $versionConstraint)

PackageManager.php:416

function isIncluded(string $name, string $versionConstraint = '*'): bool

$name	string
$versionConstraint = '*'	string
returns	bool	whether a version of $name matching $versionConstraint is currently included (`inc`).

isPharEnabled()

PackageManager.php:129

function isPharEnabled(): bool

returns bool whether .phar packages can be loaded (enablePhar) -- defaults to true outside dev mode, or when this project itself runs from a phar.

loopIncluded()

PackageManager.php:421

function loopIncluded(): Generator

returns Generator every currently included manifest (one per distinct package name -- inc).

loopManifestByNamespace($ns, $version, $included)

PackageManager.php:377

function loopManifestByNamespace(string $ns, ?string $version = null, ?bool $included = null): Generator

$ns	string	a namespace prefix, e.g. 'MMO\core' (also matches sub-namespaces, e.g. 'MMO\core\server').
$version = null	null \| string	a version constraint, if only specific versions should match.
$included = null	null \| bool	if given, only match manifests that are (or aren't) currently included (`isIncluded`).
returns	Generator	every matching manifest.

loopManifestByVersions($name, $versionConstraint)

PackageManager.php:328

Tells if a manifest exists and returns its version

function loopManifestByVersions(string $name, string $versionConstraint = '*'): Generator

$name	string
$versionConstraint = '*'	string	a constraint on the version to look for
returns	Generator	($version => $manifest), most recent matching version first, among already-read manifests only (`readManifest` -- doesn't discover new ones).

readManifest($url)

PackageManager.php:243

Read manifest and trigger manifest-read hook

function readManifest(string $url): MMO\core\helpers\PackageManifest

$url	string	a url to mmo.json (phar works)
returns	PackageManifest

setCompression($compression)

PackageManager.php:122

function setCompression(int $compression): bool

$compression	int
returns	bool	whether the compression mode actually changed.

setProject($url)

PackageManager.php:149

Set the main manifest (mmo.json) to load for the project

function setProject(?string $url): void

$url	null \| string	a valid mmo.json (can be inside a phar)
returns	void

__construct($config)

PackageManager.php:98

Includes this framework's own package (mmo.core), then discovers sibling .phar packages if running from one itself.

protected function __construct(array &$config)

$config

array

Inherited members (46)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`verbosity`	aModule

Methods	Declared by	Description
`alert($message, $context)`	aModule	Action must be taken immediately.
`backtraces($message, $context)`	aModule	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`Configure($config)`	aModule	Merge $config into this module's configuration in the shared `Configuration`.
`critical($message, $context)`	aModule	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aModule	Detailed debug information.
`debugName()`	aModule	Human-readable identifier used as the default `{origin}` in this instance's log messages.
`emergency($message, $context)`	aModule	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aModule	Runtime errors that do not require immediate action but should typically be logged and monitored.
`getVerbosity()`	aModule
`info($message, $context)`	aModule	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`Instantiate($config)`	aModule	(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
`IsShared()`	aModule
`log($level, $message, $context)`	aModule	Logs with an arbitrary level.
`notice($message, $context)`	aModule	Normal but significant events.
`offsetExists($key)`	aModule	\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
`offsetGet($key)`	aModule	\ArrayAccess::offsetGet -- reads a property directly, unless it has a `#[Serialize(serialize: 'methodName')]` attribute, in which case that zero-argument method is called instead (e.g.
`offsetSet($key, $value)`	aModule	\ArrayAccess::offsetSet -- sets a property directly, unless it has a `#[Serialize(unserialize: 'methodName')]` attribute, in which case that method is called with $value instead (e.g.
`offsetUnset($key)`	aModule	\ArrayAccess::offsetUnset -- equivalent to `$module[$key] = null`.
`serialize($path, $serializer)`	aModule	\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
`setVerbosity($verb)`	aModule	Set the current verbosity mask, replacing whatever it was before.
`Shared()`	aModule	Get the shared instance, creating (and configuring) it on first call.
`testVerbosity($level)`	aModule	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`traitUnshare($serialize)`	aModule	Remove the shared instance, so the next `Shared()` call creates a fresh one.
`unserialize($data, $path, $instances)`	aModule	\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto `DefaultConfig`, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
`Unshare($serialize)`	aModule	Like `tSingleton::Unshare`, but also disconnects this module's instance from every event it was listening to (via `Event::DisconnectListeners`) before dropping it.
`warning($message, $context)`	aModule	Exceptional occurrences that are not errors.