PluginManifestInterface

Read-only accessor for a plugin's `milpa.json` manifest: identity, versioning, capability contracts ({@see getProvides()}, {@see getRequires()}, {@see getSuggests()}), and dependency/environment requirements. This is the primary source of plugin metadata when a manifest file exists; plugins without one fall back to `#[PluginMetadata]` attributes.

abstract public static function fromPath(string $manifestPath): self

Create a manifest from a milpa.json file path.

Parameters

abstract public function getName(): string

Vendor/package name (e.g., "acme/mail-plugin").

abstract public function getDisplayName(): string

Human-readable display name (e.g., "Mail Plugin").

abstract public function getDescription(): string

Short human-readable summary of what the plugin does.

abstract public function getVersion(): Milpa\app\ValueObjects\SemanticVersion

The plugin's parsed semantic version.

abstract public function getType(): string

Plugin type: Web, CLI, Mixed, Service.

abstract public function getNamespace(): string

PHP namespace (e.g., "Acme\Plugins\ExamplePlugin").

abstract public function getEntrypoint(): string

Main plugin file relative to plugin directory (e.g., "ExamplePlugin.php").

abstract public function getProvides(): array

The interfaces/services this plugin provides to the capability system.

Returns

Interfaces/services this plugin provides

abstract public function getRequires(): array

The interfaces/services this plugin cannot boot without.

Returns

Required interfaces/services (hard dependency)

abstract public function getSuggests(): array

The interfaces/services this plugin can use if available but does not strictly need.

Returns

Optional interfaces/services (soft dependency)

abstract public function getProvidedCapabilities(): array

The `provides` capabilities as typed records (id, interface, constraint), parsed from the canonical `capabilities.provides` key. Prefer this over {@see getProvides()} — it exposes the validated value objects rather than bare class-strings.

abstract public function getRequiredCapabilities(): array

The `requires` capabilities as typed records (hard dependencies).

abstract public function getSuggestedCapabilities(): array

The `suggests` capabilities as typed records (soft dependencies with an optional fallback).

abstract public function getComposerDependencies(): array

Composer packages this plugin depends on, beyond the framework itself.

Returns

Package => constraint (e.g., "symfony/mailer" => "^7.0")

abstract public function getPluginDependencies(): array

Other Milpa plugins this plugin depends on.

Returns

Plugin name => constraint (e.g., "acme/example-plugin" => "^2.0")

abstract public function getMinMilpaVersion(): ?string

The minimum Milpa/Milpa framework version this plugin requires, or null if unconstrained.

abstract public function getPhpVersion(): ?string

The PHP version constraint this plugin requires (e.g. ">=8.2"), or null if unconstrained.

abstract public function getEnvVars(): array

Environment variable names the plugin expects to be set.

Returns

Required environment variables

abstract public function getMigrationsDirectory(): ?string

Migrations directory name relative to plugin root (e.g., "Migrations").

abstract public function getAuthors(): array

The plugin's declared authors.

Returns

Author list with name/email

abstract public function toMetadataArray(): array

Convert to the legacy metadata-array shape (`Plugins::$plugins`) that some consumers still read instead of the typed accessors above.

abstract public function validate(): void

Validate the manifest. Throws on invalid data.

Throws

\InvalidArgumentException If required fields are missing or invalid

abstract public function getRawData(): array

Get the raw manifest data array.