Store

MMO\admin\helpers · 1 symbole · générée le 27 Oct 2026

class

Store

Everything the deployment tooling knows, as entities: which projects exist, which machines they run on, which targets live on those machines, and what has actually been deployed to each.

class MMO\admin\helpers\Store

Espace de noms: MMO\admin\helpers
Voir: Target collections. The store NEVER writes this file, and no deployment does. A deployment topology is reviewed source, not application state, and a tool that can rewrite it is a tool that can quietly change where a release goes. SetupWizard edits it -- only once a person has answered and read the diff. 2. The history -- a JsonRepository at .mmo/deploy.history.json in the project (HISTORY), filled by sync -- and after every deployment -- from each target's own journal. This one is ordinary, writable state, and it is what the dashboard reads for a fleet-wide view without connecting to 27 machines to draw a page. It is this machine's record, not the project's: git-ignored, and readable by you alone., Credentials, and every ssh alias through SshConfig, from files beside the declaration git ignores. deploy.json is checked for secret-shaped keys on load (assertNoSecrets) and refuses to parse if it has any, so the previous pipeline's failure -- a production password committed to 31 branches -- cannot be repeated by someone taking the obvious shortcut.

Two stores in one, deliberately: 1. **The declaration** -- `deploy.json`, committed and code-reviewed, read into [`Project`](https://mmoframework.fr/fr/documentation/mmo.admin/php/entities/Project.md#project) / [`Server`](https://mmoframework.fr/fr/documentation/mmo.admin/php/entities/Server.md#server) / Nothing it reads or writes is outside the project folder. Everything secret is resolved through

$store = Store::FromFile('{root}/deploy.json'); $store->getTargets()->getById('demo'); $store->getDeployments()->query(['target' => 'demo'], sort: ['-date']);

Index

	HISTORY	where a project keeps this machine's deployment history, relative to the folder of `deploy.json`.
	SECRETS	keys that must never appear in the committed declaration, whatever level they appear at.
	credentials
	filename
	history
	historyFilename
	projectName
	projects
	servers
	sshConfig
	targets
	assertLoaded($entity, $what)	Refuse an entity whose data did not survive being loaded.
	assertNoSecrets($data, $path)	Refuse a declaration carrying anything secret-shaped, at any depth.
	assertRow($row, $class, $what)	Refuse a record carrying a key the entity does not declare.
	debugName()
	FromFile($filename, $credentialsFilename, $history, $sshConfigFilename) static
	getCredentials()
	getDeployments()
	getFilename()
	getHistory($target, $count)
	getHistoryFilename()
	getHistoryRepository()
	getProject($name)
	getProjectName()
	getProjects()
	getServer($name)
	getServers()
	getSshConfig()
	getTargets()
	hasHistory()
	loadProjects($data)
	loadServers($data)
	loadTargets($data)	Every target as it is written: nothing is inherited, so reading a target is reading what it is.
	mirror($entries)	Merge a target's own journal into the local history, skipping what is already there.
	saveHistory()	Write what `mirror` added.
	StateFilename($root) static	Where a project's synced history lives on this machine: `HISTORY`, in the project.
	stripComments($data)	Drop every `//`-prefixed key, at any depth.
	suggest($key, $known)
	__construct($data, $filename, $credentials, $stateFilename, $sshConfig)

Constantes2

HISTORY

where a project keeps this machine's deployment history, relative to the folder of deploy.json.

const HISTORY = '.mmo/deploy.history.json'

SECRETS

keys that must never appear in the committed declaration, whatever level they appear at.

const SECRETS = […9 items]

Propriétés9

credentials

protected ?MMO\admin\helpers\Credentials $credentials = null

Type: null | Credentials

filename

protected ?string $filename = null

Type: null | string

history

protected ?MMO\core\entities\JsonRepository $history = null

Type: null | JsonRepository

historyFilename

protected ?string $historyFilename = null

Type: null | string

projectName

protected ?string $projectName = null

Type: null | string

projects

protected MMO\core\entities\Collection $projects

Type: Collection

servers

protected MMO\core\entities\Collection $servers

Type: Collection

sshConfig

protected ?MMO\admin\helpers\SshConfig $sshConfig = null

Type: null | SshConfig

targets

protected MMO\core\entities\Collection $targets

Type: Collection

Méthodes28

assertLoaded($entity, $what)

Store.php:310

Refuse an entity whose data did not survive being loaded.

protected function assertLoaded(object $entity, string $what): void

An entity records a value it could not coerce in [`aEntity::getErrors`](https://mmoframework.fr/fr/documentation/mmo.core/php/classes/aEntity.md#aentity-geterrors) and carries on with the property at its default -- which, for a deployment declaration, is silence where there should be a stop. A `vars` map that failed to coerce leaves `{placeholders}` unresolved in a path; a `shared` list that failed leaves live data inside a release, to be deleted by the next prune. Neither is something to find out about on a server.

$entity	object
$what	string
retourne	void
lève

assertNoSecrets($data, $path)

Store.php:444

Refuse a declaration carrying anything secret-shaped, at any depth.

protected function assertNoSecrets(array $data, string $path = ''): void

This is the structural half of keeping credentials out of git: `.gitignore` and code review are both things a hurried person skips, and the previous pipeline shows what that costs. A tool that will not START with a password in its configuration cannot be talked into committing one.

$data	array
$path = ''	string
retourne	void
lève

assertRow($row, $class, $what)

Store.php:401

Refuse a record carrying a key the entity does not declare.

protected function assertRow(mixed $row, string $class, string $what): array

Silently ignoring unknown keys is what made the previous configuration dangerous rather than merely untidy: `"datbase"` produced a target with NO database, so `migrate` and `backup` quietly did nothing on it -- the tool reported success and the patches were simply never applied.

$row	mixed
$class	string	the entity class the record describes.
$what	string	how to name it in an error.
retourne	array	$row, unchanged.
lève

debugName()

Store.php:87

function debugName(): string

retourne

string

FromFile($filename, $credentialsFilename, $history, $sshConfigFilename)

staticStore.php:99

static function FromFile( string $filename, ?string $credentialsFilename = null, bool $history = true, ?string $sshConfigFilename = null ): static

$filename	string	the declaration, resolved through `filename`.
$credentialsFilename = null	null \| string	null: `deploy.credentials.json` beside the declaration (`Credentials::DefaultFilename`).
$history = true	bool	load/persist the synced deployment history as well.
$sshConfigFilename = null	null \| string	null: `deploy.ssh.config` beside the declaration (`SshConfig::DefaultFilename`).
retourne	static
lève		if the declaration does not exist.

getCredentials()

Store.php:134

function getCredentials(): ?MMO\admin\helpers\Credentials

retourne

null | Credentials

getDeployments()

Store.php:144

function getDeployments(): MMO\core\entities\Collection

retourne

Collection

the synced deployment history. @throws eNotFound when the store carries none.

getFilename()

Store.php:133

function getFilename(): ?string

retourne

null | string

getHistory($target, $count)

Store.php:249

function getHistory(?string $target = null, int $count = 20): array

$target = null	null \| string	only this target's entries.
$count = 20	int
retourne	array	the most recent mirrored deployments, newest first.

getHistoryFilename()

Store.php:136

function getHistoryFilename(): ?string

retourne

null | string

getHistoryRepository()

Store.php:152

function getHistoryRepository(): ?MMO\core\entities\JsonRepository

retourne

null | JsonRepository

getProject($name)

Store.php:185

function getProject(?string $name = null): ?MMO\admin\entities\Project

$name = null	null \| string
retourne	null \| Project	the named project, or the single implicit one.

getProjectName()

Store.php:137

function getProjectName(): ?string

retourne

null | string

getProjects()

Store.php:139

function getProjects(): MMO\core\entities\Collection

retourne

Collection

getServer($name)

Store.php:200

function getServer(string $name): MMO\admin\entities\Server

$name	string
retourne	Server
lève

getServers()

Store.php:140

function getServers(): MMO\core\entities\Collection

retourne

Collection

getSshConfig()

Store.php:135

function getSshConfig(): ?MMO\admin\helpers\SshConfig

retourne

null | SshConfig

getTargets()

Store.php:141

function getTargets(): MMO\core\entities\Collection

retourne

Collection

hasHistory()

Store.php:151

function hasHistory(): bool

retourne

bool

loadProjects($data)

Store.php:263

protected function loadProjects(array $data): void

$data	array
retourne	void

loadServers($data)

Store.php:279

protected function loadServers(array $data): void

$data	array
retourne	void

loadTargets($data)

Store.php:332

Every target as it is written: nothing is inherited, so reading a target is reading what it is.

protected function loadTargets(array $data): void

$data	array
retourne	void
lève

mirror($entries)

Store.php:224

Merge a target's own journal into the local history, skipping what is already there.

function mirror(iterable $entries): int

The target's journal is the truth -- it is written on the machine the deployment happened to, by the run that happened -- so this only ever adds. It never edits, never deletes, and never writes back to the target: a mirror that can change its source is not a mirror.

$entries	iterable	`Deployment`, from `Journal::all`.
retourne	int	how many entries were new.

saveHistory()

Store.php:161

Write what mirror added.

function saveHistory(): void

The file is created private -- its folder 0700, itself 0600 -- before anything is written in it: who deployed what, when and from where is this machine's business, and it is not shared through git either.

retourne

void

StateFilename($root)

staticStore.php:129

Where a project's synced history lives on this machine: HISTORY, in the project.

static function StateFilename(string $root): string

$root	string	the project's folder -- the one holding `deploy.json`.
retourne	string

stripComments($data)

Store.php:379

Drop every //-prefixed key, at any depth.

protected function stripComments(array $data): array

JSON has no comments, and a file that decides which machine a release lands on is exactly the kind of file that needs them. The convention costs nothing (`"//shared": "why these paths"` beside `"shared"`) and it means the strict key check below can stay strict: a key that is not a comment and not a declared property is a typo, and typos in this file are how a target quietly stops being backed up.

$data	array
retourne	array

suggest($key, $known)

Store.php:421

protected function suggest(string $key, array $known): string

$key	string
$known	array
retourne	string	' Did you mean [x]?' when a close-enough key exists, '' otherwise.

__construct($data, $filename, $credentials, $stateFilename, $sshConfig)

Store.php:66

function __construct( array $data = [], ?string $filename = null, ?MMO\admin\helpers\Credentials $credentials = null, ?string $stateFilename = null, ?MMO\admin\helpers\SshConfig $sshConfig = null )

$data = []	array	the decoded declaration ({project, projects, servers, targets}).
$filename = null	null \| string	for error messages only.
$credentials = null	null \| Credentials	resolved secrets, injected into every server.
$stateFilename = null	null \| string	where the synced history lives (null: no history).
$sshConfig = null	null \| SshConfig	the project's ssh aliases, injected into every server.