SetupWizard

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

class

SetupWizard

php scripts/admin.php setup: the questions whose answers are a project's deployment, asked in the order deploying needs them, each one explained -- then the files those answers make, shown before they are written.

class MMO\admin\helpers\SetupWizard

Espace de noms: MMO\admin\helpers

It is a guide as much as a form. Every step says what it asks for, why it matters and what the tool does with it, so that whoever sets a project up for the first time ends up knowing how it deploys, not only holding a deploy.json. Run again on a project that has one, every question starts from what the files already say: ENTER all the way through changes nothing -- but what it found missing or disagreeing, and asked about first. What it writes, and how: - `deploy.json`, through [`JsonEditor`](https://mmoframework.fr/fr/documentation/mmo.admin/php/helpers/JsonEditor.md#jsoneditor): only the lines that change. Its comments document its keys and it is reviewed like code, so it is edited, never regenerated; a new one starts from mmo.admin's template. Every key of every server and target is written, the default of the ones nobody chose included, and each one has a comment saying what it does ([`Declaration`](https://mmoframework.fr/fr/documentation/mmo.admin/php/helpers/Declaration.md#declaration)): what a deployment does is all in plain sight. - `deploy.credentials.json`, when a server needs a secret: private (0600) from the moment it exists, and only once `.gitignore` ignores it. A secret found in deploy.json is offered a move there. - a `Host` entry of the project's `deploy.ssh.config` ([`SshConfig`](https://mmoframework.fr/fr/documentation/mmo.admin/php/helpers/SetupWizard.md#setupwizard-sshconfig)), for a server reached through an alias it does not declare yet -- copied from `~/.ssh/config` when that has one. Private and git-ignored too: everything the project needs is in the project folder, and nothing it writes is outside it. - what `init` writes and the project lacks, the `.gitignore` and `.gitattributes` rules it misses, the pre-commit hook (`core.hooksPath`), and the values of `scripts/bootstrap.php` and `scripts/apache2.conf` the answers decide ([`PhpConfigEditor`](https://mmoframework.fr/fr/documentation/mmo.admin/php/helpers/PhpConfigEditor.md#phpconfigeditor)). Nothing is written before the last step, which shows every change as a diff -- secrets masked -- and checks that deploy.json loads ([`Store`](https://mmoframework.fr/fr/documentation/mmo.admin/php/helpers/Store.md#store)) before asking. Nothing on a server is changed: reading a host key is the only connection it opens, and only when asked to. Answers are read through \MMO\core\shell's prompts, so a stream given to \MMO\core\shell\setInput() answers them as a person would: that is how it is tested.

$wizard = new SetupWizard('/var/www/acme/deploy.json', templateFolder: '/path/to/mmo.admin/templates'); $wizard->run(); // every step $wizard->run('targets'); // the targets alone, then the review

Index

	CANCELLED	the code of the eRuntime saying nobody answered: the run stops, and nothing is written.
	HOST_KEYS	the kind of a host key => the file holding it on the server, whose fingerprint `ssh-keygen -l` prints there.
	NAME	what a server, a project or a new target may be called: what a shell and a path take as they are.
	STEPS	step => what it is about, in the order deploying needs them.
	appends
	bootstrap
	commands
	committable
	credentialsData
	credentialsFilename
	credentialsText
	data
	dryRun
	filename
	folder
	git
	hosts
	original
	renames
	secrets
	settings
	sshConfig
	template
	templateFolder
	templates
	vhost
	webspaceRoots
	written
	address($row)
	aliasSettings($row)
	apply($changes)
	ask($question, $default, $validate)
	askAlias($server, $row, $was)
	askAuth($row, $secrets)
	askFingerprint($row)
	askHost($row)
	askList($question, $default, $validate)
	askManaged($row)
	askPort($question, $default)
	askRoot($server, $row, $secrets, $local)	The folder every relative path of a target on this server starts from.
	askVhost($template)	Make the vhost template take its paths and its server name from each target: `{public}`, `{folder}` and `{host}` (`Target::resolveTemplate`) -- one template, right for every target whatever it d…
	askWebspace($row, $folder, $before, $root)	What a target on a shared webspace needs that the others do not.
	bootstrapFilename()
	branch()
	changes()	Every file the answers change, in the order it is safe to write them: `.gitignore` before the credentials file exists, so git never sees it unignored.
	checkAgent()	Say whether an ssh agent is running and holds a key: `agent` needs both, and neither is in a file to check later.
	checkAttributes()
	checkCredentialsFile()
	checkHook()
	checkIgnored()
	checkKeys()	Deal, before anything else, with what would stop deploy.json from loading whatever the answers: a secret in it, and a key mmo.admin does not know.
	checkRef($ref)	Warn about a branch this repository does not have: the first release of the target would fail on it.
	closest($key, $known)
	conclude()	What to do next, in order, with the commands to type.
	credentialsText()
	debugName()
	declarationText()
	defaultKey()
	describeServer($row)
	directive($text, $pattern, $value)
	editServer($name)
	editTarget($name)
	entity($name, $row)
	expand($path)
	fingerprint($value)
	freeName($prefix, $taken)
	hasDatabase()
	hostKeyFile($type)
	ignoresNeeded()	The .gitignore rules the files about to be written need and nothing gives them: a private file is never written where git would take it, whichever step made it.
	ignoreText($rule)
	introduce($full)
	isExample($section, $name)
	isHost($host)
	isIgnored($file)
	isUrl($url)
	listServers()
	listTargets()
	load()
	manifest()
	mask($text)
	missingRules($template, $have)	The rules of the template a project's .gitattributes lacks.
	missingTemplates()
	moveSecret($path, $key, $what)
	need($answer)
	objectify($data)
	panelPath($path, $root)
	pick($question, $options, $default)
	pickName($question, $names, $default)
	privateFiles()
	protectedTags()
	readHostKey($host, $port)	Read the host key a server presents, the way the deployment's own connection will check it.
	readWebspaceRoot($server, $row, $secrets)
	reference($path)
	relative($filename)
	relativePaths($paths)
	relativeTo($root, $path, $default)
	removeServer($name)
	removeTarget($name)
	renameKey($values, $old, $new)
	review($changes)	Show every change: what is added, removed, run -- secrets masked.
	rules($text)
	run($only)	Ask, explain, show, write.
	saveServer($old, $new, $row, $secrets)
	saveTarget($old, $new, $row)
	secret($question)
	setting($key)
	sshConfig()
	step($step)
	stepFiles()
	stepInstall()	`installTemplates` and `postInstall`: the vhost `install` sets up on a server of yours -- and on no other.
	stepProject()
	stepScripts()
	stepServers()
	stepTargets()
	stepWrite()
	templateText($file)
	urlHost($url)
	userSshConfig()
	validate($changes)	Refuse what mmo.admin would refuse: a deploy.json that does not load, a PHP file that does not parse.
	valueAt($path)
	webspaceRoot($server, $row, $secrets)	The folder a webspace account lands in: what `pwd` prints there.
	withoutComments($value)
	write($filename, $text, $mode)	Write a file beside, then move it over: a file half written is never the one read.
	yes($question, $default)
	__construct($filename, $credentialsFilename, $templateFolder, $git, $sshConfig, $settings, $dryRun)

Constantes4

CANCELLED

the code of the eRuntime saying nobody answered: the run stops, and nothing is written.

const CANCELLED = 499

HOST_KEYS

the kind of a host key => the file holding it on the server, whose fingerprint ssh-keygen -l prints there.

const HOST_KEYS = […3 items]

NAME

what a server, a project or a new target may be called: what a shell and a path take as they are.

const NAME = '/^[a-zA-Z0-9][a-zA-Z0-9._-]*$/'

STEPS

step => what it is about, in the order deploying needs them.

const STEPS = […6 items]

Propriétés24

appends

protected array $appends = []

Type: array

bootstrap

protected array $bootstrap = []

Type: array

commands

protected array $commands = []

Type: array

committable

protected array $committable = []

Type: array

credentialsData

protected array $credentialsData = []

Type: array

credentialsFilename

protected ?string $credentialsFilename

Type: null | string

credentialsText

protected string $credentialsText = ''

Type: string

data

protected array $data = []

Type: array

dryRun

protected bool $dryRun

Type: bool

filename

protected string $filename

Type: string

folder

protected string $folder

Type: string

git

protected ?MMO\git\helpers\Repository $git

Type: null | Repository

hosts

protected array $hosts = []

Type: array

original

protected string $original = ''

Type: string

renames

protected array $renames = []

Type: array

secrets

protected array $secrets = []

Type: array

settings

protected array $settings

Type: array

sshConfig

protected ?MMO\admin\helpers\SshConfig $sshConfig

Type: null | SshConfig

template

protected array $template = []

Type: array

templateFolder

protected ?string $templateFolder

Type: null | string

templates

protected array $templates = []

Type: array

vhost

protected ?string $vhost = null

Type: null | string

webspaceRoots

protected array $webspaceRoots = []

Type: array

written

protected bool $written = false

Type: bool

Méthodes97

address($row)

SetupWizard.php:1689

protected function address(array $row): array

$row	array
retourne	array	string\|null, 1: int} a server's host and port, from deploy.json or from its alias.

aliasSettings($row)

SetupWizard.php:1682

protected function aliasSettings(array $row): array

$row	array
retourne	array	the deploy.ssh.config settings of a server's alias: the ones about to be added, or the file's.

apply($changes)

SetupWizard.php:1472

protected function apply(array $changes): void

$changes	array
retourne	void

ask($question, $default, $validate)

SetupWizard.php:1549

protected function ask(string $question, ?string $default = null, ?callable $validate = null): string

$question	string
$default = null	null \| string
$validate = null	null \| callable
retourne	string

askAlias($server, $row, $was)

SetupWizard.php:591

protected function askAlias(string $server, array &$row, string $was): void

$server	string
$row	array
$was	string
retourne	void

askAuth($row, $secrets)

SetupWizard.php:634

protected function askAuth(array &$row, array $secrets): array

$row	array	the server's declaration.
$secrets	array	what the credentials file holds for it.
retourne	array	what it will hold.

askFingerprint($row)

SetupWizard.php:698

protected function askFingerprint(array &$row): void

$row	array
retourne	void

askHost($row)

SetupWizard.php:621

protected function askHost(array &$row): void

$row	array
retourne	void

askList($question, $default, $validate)

SetupWizard.php:1553

protected function askList(string $question, array $default = [], ?callable $validate = null): array

$question	string
$default = []	array
$validate = null	null \| callable
retourne	array

askManaged($row)

SetupWizard.php:690

protected function askManaged(array &$row): void

$row	array
retourne	void

askPort($question, $default)

SetupWizard.php:1557

protected function askPort(string $question, int $default): int

$question	string
$default	int
retourne	int

askRoot($server, $row, $secrets, $local)

SetupWizard.php:796

The folder every relative path of a target on this server starts from.

protected function askRoot(string $server, array &$row, array $secrets, bool $local): void

On a webspace the host decides it, and prints it nowhere a person can copy it reliably (IONOS has moved it between contracts): it is read where it is true, with `pwd` ([`webspaceRoot`](https://mmoframework.fr/fr/documentation/mmo.admin/php/helpers/SetupWizard.md#setupwizard-webspaceroot)), and offered.

$server	string
$row	array	the server's declaration, which gets its `root`.
$secrets	array	what the credentials file will hold for it: how to get in, to read it.
$local	bool	it is this very machine: a root is optional.
retourne	void

askVhost($template)

SetupWizard.php:1213

Make the vhost template take its paths and its server name from each target: {public}, {folder} and {host} (Target::resolveTemplate) -- one template, right for every target whatever it declares -- and ask where the certificate is.

protected function askVhost(string $template): void

$template	string	the local template, as installTemplates names it.
retourne	void

askWebspace($row, $folder, $before, $root)

SetupWizard.php:999

What a target on a shared webspace needs that the others do not.

protected function askWebspace( array &$row, string $folder, MMO\admin\entities\Target $before, ?string $root ): void

$row	array	the target's declaration.
$folder	string	its folder, absolute.
$before	Target	what it was before this edit.
$root	null \| string	its server's root: how a panel names a folder.
retourne	void

bootstrapFilename()

SetupWizard.php:1710

protected function bootstrapFilename(): string

retourne

string

branch()

SetupWizard.php:1704

protected function branch(): ?string

retourne

null | string

the branch the project's working tree is on.

changes()

SetupWizard.php:1299

Every file the answers change, in the order it is safe to write them: .gitignore before the credentials file exists, so git never sees it unignored.

protected function changes(): array

retourne

array

array{label: string, old: string, new: string, mode?: int, secret?: bool, template?: bool}> by filename.

checkAgent()

SetupWizard.php:678

Say whether an ssh agent is running and holds a key: agent needs both, and neither is in a file to check later.

protected function checkAgent(): void

retourne

void

checkAttributes()

SetupWizard.php:392

protected function checkAttributes(): void

retourne

void

checkCredentialsFile()

SetupWizard.php:452

protected function checkCredentialsFile(): void

retourne

void

checkHook()

SetupWizard.php:433

protected function checkHook(): void

retourne

void

checkIgnored()

SetupWizard.php:342

protected function checkIgnored(): void

retourne

void

checkKeys()

SetupWizard.php:248

Deal, before anything else, with what would stop deploy.json from loading whatever the answers: a secret in it, and a key mmo.admin does not know.

protected function checkKeys(): void

retourne

void

checkRef($ref)

SetupWizard.php:1102

Warn about a branch this repository does not have: the first release of the target would fail on it.

protected function checkRef(string $ref): void

$ref	string
retourne	void

closest($key, $known)

SetupWizard.php:1743

protected function closest(string $key, array $known): ?string

$key	string
$known	array
retourne	null \| string	the key of $known closest to $key: a typo's fix.

conclude()

SetupWizard.php:1514

What to do next, in order, with the commands to type.

protected function conclude(): void

retourne

void

credentialsText()

SetupWizard.php:1404

protected function credentialsText(): ?string

retourne

null | string

the credentials file once the answers are in it, null when there is none and none is needed.

debugName()

SetupWizard.php:150

function debugName(): string

retourne

string

declarationText()

SetupWizard.php:1389

protected function declarationText(): string

retourne string deploy.json once the answers are in it: its own text, edited -- every key of every server and target written, and each one with a comment saying what it does (Declaration).

defaultKey()

SetupWizard.php:1721

protected function defaultKey(): ?string

retourne null | string the private key most people have, written with ~.

describeServer($row)

SetupWizard.php:535

protected function describeServer(array $row): string

$row	array
retourne	string	how a server is reached, how it lets you in, and whether its host key is pinned.

directive($text, $pattern, $value)

SetupWizard.php:1248

protected function directive(string $text, string $pattern, string $value): string

$text	string
$pattern	string
$value	string
retourne	string	$text with the value of the directive $pattern matches -- its first group kept -- replaced by $value.

editServer($name)

SetupWizard.php:548

protected function editServer(?string $name): void

$name	null \| string
retourne	void

editTarget($name)

SetupWizard.php:898

protected function editTarget(?string $name): void

$name	null \| string
retourne	void

entity($name, $row)

SetupWizard.php:1597

protected function entity(string $name, ?array $row = null): MMO\admin\entities\Target

$name	string
$row = null	null \| array	its declaration (null: the one it has).
retourne	Target	the target as the store would load it: its own values, on its server.

expand($path)

SetupWizard.php:1728

protected function expand(string $path): string

$path	string
retourne	string

fingerprint($value)

SetupWizard.php:780

protected function fingerprint(string $value): ?string

$value	string	a fingerprint as a tool prints it: `MD5:aa:bb...`, `AABB...`, with or without colons.
retourne	null \| string	lowercase hex pairs joined by colons -- what \MMO\core\server\SSH compares -- or null when it is not 32 (MD5) or 40 (SHA1) hex digits. A base64 fingerprint (`SHA256:...`) is not one the ssh2 extension can compute.

freeName($prefix, $taken)

SetupWizard.php:1737

protected function freeName(string $prefix, array $taken): string

$prefix	string
$taken	array
retourne	string	the first of `{prefix}1`, `{prefix}2`... that is not taken.

hasDatabase()

SetupWizard.php:1658

protected function hasDatabase(): bool

retourne

bool

hostKeyFile($type)

SetupWizard.php:767

protected function hostKeyFile(string $type): string

$type	string
retourne	string	where the server keeps the public key of that kind.

ignoresNeeded()

SetupWizard.php:1363

The .gitignore rules the files about to be written need and nothing gives them: a private file is never written where git would take it, whichever step made it.

protected function ignoresNeeded(): array

retourne

array

ignoreText($rule)

SetupWizard.php:370

protected function ignoreText(string $rule): string

$rule	string
retourne	string

introduce($full)

SetupWizard.php:221

protected function introduce(bool $full = true): void

$full = true	bool	every step follows: say what they are about. One step alone says only what it has to.
retourne	void

isExample($section, $name)

SetupWizard.php:1649

protected function isExample(string $section, string $name): bool

$section	string
$name	string
retourne	bool	whether a server or a target is still the template's example, untouched.

isHost($host)

SetupWizard.php:1772

protected function isHost(string $host): bool

$host	string
retourne	bool

isIgnored($file)

SetupWizard.php:375

protected function isIgnored(string $file): bool

$file	string
retourne	bool	whether git would leave $file, relative to the project, out of a commit.

isUrl($url)

SetupWizard.php:1768

protected function isUrl(string $url): bool

$url	string
retourne	bool

listServers()

SetupWizard.php:518

protected function listServers(): void

retourne

void

listTargets()

SetupWizard.php:880

protected function listTargets(): void

retourne

void

load()

SetupWizard.php:199

protected function load(): void

retourne

void

manifest()

SetupWizard.php:1696

protected function manifest(): array

retourne

array

the project's mmo.json, or nothing.

mask($text)

SetupWizard.php:1468

protected function mask(string $text): string

$text	string
retourne	string	$text with the value of every secret-shaped key replaced by `****`.

missingRules($template, $have)

SetupWizard.php:417

The rules of the template a project's .gitattributes lacks. A rule the template anchors to the root (/src/ export-ignore) is there when the project has it bare (src/ export-ignore): bare, it matches at any depth, the root included -- broader than the template asks, which is the project's own choice.

protected function missingRules(string $template, string $have): array

$template	string
$have	string
retourne	array	the template's rules, as the template writes them

missingTemplates()

SetupWizard.php:327

protected function missingTemplates(): array

retourne

array

file relative to the project => template, for every template file the project lacks.

moveSecret($path, $key, $what)

SetupWizard.php:289

protected function moveSecret(array $path, string $key, string $what): void

$path	array	where the secret is: a server's or a target's row.
$key	string
$what	string	how to name the row.
retourne	void

need($answer)

SetupWizard.php:1544

protected function need(mixed $answer): mixed

$answer	mixed	what a prompt returned.
retourne	mixed	$answer, once it is known not to be null.
lève		nobody answered: the input ended, or an invalid answer came from something that is not a terminal.

objectify($data)

SetupWizard.php:1608

protected function objectify(array $data): array

$data	array
retourne	array	$data with an empty object written `{}` where deploy.json has objects: `[]` is an empty list.

panelPath($path, $root)

SetupWizard.php:1097

protected function panelPath(string $path, ?string $root): string

$path	string
$root	null \| string
retourne	string	$path as a webspace panel names it: relative to the server's root, when it is under it.

pick($question, $options, $default)

SetupWizard.php:1561

protected function pick(string $question, array $options, string $default): string

$question	string
$options	array
$default	string
retourne	string

pickName($question, $names, $default)

SetupWizard.php:1571

protected function pickName(string $question, array $names, string|int|null $default = null): string

$question	string
$names	array	keys of the declaration -- PHP makes a name like `1` an int.
$default = null	string \| int \| null
retourne	string	one of $names -- the only one, without asking.

privateFiles()

SetupWizard.php:362

protected function privateFiles(): array

retourne

array

array{0: string, 1: string}> file relative to the project => [the .gitignore rule ignoring it, why it must be]: what the project keeps that cannot be shared. Kept in the project, private, and out of git -- never in a folder of the user's.

protectedTags()

SetupWizard.php:1654

protected function protectedTags(): array

retourne

array

the tags that protect a target.

readHostKey($host, $port)

SetupWizard.php:738

Read the host key a server presents, the way the deployment's own connection will check it.

protected function readHostKey(string $host, int $port): ?array

$host	string
$port	int
retourne	null \| array	string, sha1: string, md5: string}\|null null when it could not be read, and why is printed.

readWebspaceRoot($server, $row, $secrets)

SetupWizard.php:1068

protected function readWebspaceRoot(string $server, array $row, array $secrets): ?string

$server	string
$row	array
$secrets	array
retourne	null \| string	what `pwd` prints on it, null when that is not an absolute path.
lève		when it cannot be reached.

reference($path)

SetupWizard.php:1642

protected function reference(array $path): mixed

$path	array
retourne	mixed	a reference to the value of $data at $path.

relative($filename)

SetupWizard.php:1732

protected function relative(string $filename): string

$filename	string
retourne	string

relativePaths($paths)

SetupWizard.php:1777

protected function relativePaths(array $paths): ?string

$paths	array
retourne	null \| string	why these paths are not paths of a release, or null.

relativeTo($root, $path, $default)

SetupWizard.php:1089

protected function relativeTo(?string $root, ?string $path, string $default): string

$root	null \| string	the server's root.
$path	null \| string	a folder as deploy.json writes it (null: none yet).
$default	string	what to propose when there is none.
retourne	string	$path as it is best written: relative to the root when it is under it, its last folder under the root when it is outside it -- another account's path, a placeholder -- and as it is otherwise.

removeServer($name)

SetupWizard.php:839

protected function removeServer(string $name): void

$name	string
retourne	void

removeTarget($name)

SetupWizard.php:1120

protected function removeTarget(string $name): void

$name	string
retourne	void

renameKey($values, $old, $new)

SetupWizard.php:1622

protected function renameKey(array $values, string $old, string $new): array

$values	array
$old	string
$new	string
retourne	array	$values with the key $old named $new, where it was.

review($changes)

SetupWizard.php:1450

Show every change: what is added, removed, run -- secrets masked.

protected function review(array $changes): void

$changes	array
retourne	void

rules($text)

SetupWizard.php:424

protected function rules(string $text): array

$text	string
retourne	array	the rules of a .gitattributes text, spaces normalized.

run($only)

SetupWizard.php:158

Ask, explain, show, write.

function run(?string $only = null): bool

$only = null	null \| string	one step of `STEPS` alone -- followed by the review, which is where writing happens.
retourne	bool	whether anything was written.
lève		when $only names no step, or deploy.json is not JSON at all.

saveServer($old, $new, $row, $secrets)

SetupWizard.php:819

protected function saveServer(?string $old, string $new, array $row, array $secrets): void

$old	null \| string	its name so far (null for a new one).
$new	string
$row	array
$secrets	array
retourne	void

saveTarget($old, $new, $row)

SetupWizard.php:1110

protected function saveTarget(?string $old, string $new, array $row): void

$old	null \| string
$new	string
$row	array
retourne	void

secret($question)

SetupWizard.php:1581

protected function secret(string $question): string

$question	string
retourne	string

setting($key)

SetupWizard.php:1666

protected function setting(string $key): array

$key	string
retourne	array	a list setting of ProductionController, as it is configured.

sshConfig()

SetupWizard.php:1672

protected function sshConfig(): MMO\admin\helpers\SshConfig

retourne

SshConfig

step($step)

SetupWizard.php:186

protected function step(string $step): void

$step	string
retourne	void

stepFiles()

SetupWizard.php:307

protected function stepFiles(): void

retourne

void

stepInstall()

SetupWizard.php:1162

installTemplates and postInstall: the vhost install sets up on a server of yours -- and on no other.

protected function stepInstall(): void

retourne

void

stepProject()

SetupWizard.php:473

protected function stepProject(): void

retourne

void

stepScripts()

SetupWizard.php:1127

protected function stepScripts(): void

retourne

void

stepServers()

SetupWizard.php:492

protected function stepServers(): void

retourne

void

stepTargets()

SetupWizard.php:855

protected function stepTargets(): void

retourne

void

stepWrite()

SetupWizard.php:1254

protected function stepWrite(): void

retourne

void

templateText($file)

SetupWizard.php:1715

protected function templateText(string $file): ?string

$file	string
retourne	null \| string	a file of mmo.admin's templates, as it is.

urlHost($url)

SetupWizard.php:1757

protected function urlHost(string $url): ?string

$url	string
retourne	null \| string	the host of a url, its `{placeholders}` kept.

userSshConfig()

SetupWizard.php:1677

protected function userSshConfig(): ?MMO\admin\helpers\SshConfig

retourne

null | SshConfig

the user's own ~/.ssh/config: only ever read, for an alias to copy into the project.

validate($changes)

SetupWizard.php:1431

Refuse what mmo.admin would refuse: a deploy.json that does not load, a PHP file that does not parse.

protected function validate(array $changes): ?string

$changes	array	`changes`
retourne	null \| string	why, or null when everything is fine.

valueAt($path)

SetupWizard.php:1629

protected function valueAt(array $path): mixed

$path	array
retourne	mixed	the value of $data at $path, null when there is none.

webspaceRoot($server, $row, $secrets)

SetupWizard.php:1048

The folder a webspace account lands in: what pwd prints there.

protected function webspaceRoot(string $server, array $row, array $secrets): ?string

Read over the same ssh connection a deployment opens, with the answers given so far -- the alias about to be written, the password about to be stored. Read once per server; nothing else is run.

$server	string
$row	array	the server's declaration, as answered so far.
$secrets	array	what the credentials file will hold for it.
retourne	null \| string	null when it could not be read, and why is printed: the root is then asked plainly.

withoutComments($value)

SetupWizard.php:1785

protected function withoutComments(mixed $value): mixed

$value	mixed
retourne	mixed	$value without the keys starting with `//`, at any depth: comments, as `Store` reads them.

write($filename, $text, $mode)

SetupWizard.php:1496

Write a file beside, then move it over: a file half written is never the one read.

protected function write(string $filename, string $text, ?int $mode): void

$filename	string
$text	string
$mode	null \| int	applied BEFORE anything is written in it: a secret never sits in a file others can read. null: the mode it has, or the default for a new file.
retourne	void

yes($question, $default)

SetupWizard.php:1577

protected function yes(string $question, bool $default): bool

$question	string
$default	bool
retourne	bool

__construct($filename, $credentialsFilename, $templateFolder, $git, $sshConfig, $settings, $dryRun)

SetupWizard.php:131

function __construct( string $filename, ?string $credentialsFilename = null, ?string $templateFolder = null, ?MMO\git\helpers\Repository $git = null, ?MMO\admin\helpers\SshConfig $sshConfig = null, array $settings = [], bool $dryRun = false )

$filename	string	the project's deploy.json, which may not exist yet.
$credentialsFilename = null	null \| string	null: deploy.credentials.json beside it.
$templateFolder = null	null \| string	mmo.admin's `templates` (null: this library's).
$git = null	null \| Repository	the project's repository (null: the folder of deploy.json, if it is one).
$sshConfig = null	null \| SshConfig	null: the project's deploy.ssh.config, beside deploy.json.
$settings = []	array	what ProductionController is configured with: protectedTags, buildCommands, include, installTemplates, postInstall, repository (whether one is set), bootstrap (the file configuring it).
$dryRun = false	bool	ask everything, show every change, write nothing.