ArangoAnalyzersAction uses trait:short, trait:short, trait:short, \oihana\commands\traits\IOTrait

Manages the **custom** ArangoSearch analyzers of the database, from the declarative registry ({@see ArangoAnalyzersTrait}) — the analyzer counterpart of {@see ArangoViewsAction}.

Tags

author

Marc Alcaraz (ekameleon)

since

1.3.0

Table of Contents

Properties

$analyzers  : array<int, AnalyzerDefinition>|AnalyzerDefinition

The declared custom analyzers — a list of {@see AnalyzerDefinition} (a single one is tolerated in place of a one-element list).

$migrationsCollection  : string

The tracking collection name (one per database).

$migrationsNamespace  : string

The PHP namespace the version classes are declared in (e.g. `fr\bouney\migrations`).

$migrationsPath  : string|null

The directory holding the `Version*.php` migration files.

Methods

getAnalyzerDefinitions()  : array<int, AnalyzerDefinition>

Returns the declared analyzers normalized to a flat {@see AnalyzerDefinition} list: a lone `AnalyzerDefinition` becomes a one-element list, and any entry that is not an `AnalyzerDefinition` is dropped (defensive against a malformed declaration).

agent()  : string

The acting agent (`user@host`) stamped on the tracking documents — shared by the `migrate` runs and the `doctor --apply` journal.

analyzers()  : int

Manages the custom analyzers of the database.

buildDatabase()  : Database|null

Builds a best-effort {@see Database} HTTP client from the resolved connection settings, or null when no usable endpoint/database is available or the client cannot be constructed.

gitCommit()  : string|null

The current git commit hash, or null outside a git repository — the history link stamped on every tracking document.

resolveDatabase()  : Database|null

Builds the best-effort {@see Database} HTTP client of an action run: every connection setting reads its CLI option first (`--database` / `--endpoint` / `--user` / `--password`) and falls back on the command configuration ({@see ArangoConfigTrait}).

resolveFacade()  : ArangoDB|null

Builds the best-effort high-level {@see ArangoDB} façade of an action run, from the same resolved connection settings as {@see resolveDatabase()} — the migration engine hands this façade to every {@see \oihana\arango\migrations\Migration}. Null when no usable endpoint is configured or the façade cannot be constructed.

analyzersFix()  : int

Generates one ready-to-review **repair migration** per drifted analyzer — the deferred, versioned form of the `--sync --force` cascade. It writes files only and **never** touches the database.

analyzersList()  : int

Lists the custom analyzers of the database (built-in ones summarized as a count, since they are always present and not managed here).

analyzersPrune()  : int

Drops the **orphan** custom analyzers — on the server, declared by none — after confirmation (the opt-in `--prune` mode).

analyzersRenderOrphans()  : void

Prints the orphan custom analyzers — on the server but declared by none.

analyzersRenderReport()  : void

Prints one analyzer's {@see DiffReport} as a status line plus one indented line per change.

analyzersRepairBody()  : string

Builds the `up()` body of a repair migration for one drifted analyzer: the declared `type` + `properties` are dumped as a flat PHP literal (via {@see toPhpString()}) into a {@see RawAnalyzer}, wrapped in an {@see AnalyzerDefinition} and forced through `analyzerSync()` (path B — same-name drop + recreate + dependent-View rebuild).

analyzersReport()  : int

Walks the declared analyzers and reports (or provisions, in apply mode) their state, with the orphan custom analyzers as a footnote.

analyzersShortName()  : string

Strips the `dbname::` namespace prefix from an analyzer name.