{"$schema":"https://yii2-framework.github.io/docs/reference/reference.schema.json","schemaVersion":1,"package":"scaffold","title":"Scaffold","repository":"https://github.com/php-forge/scaffold","ref":"main","commit":"2dbcb1fe7272e1fa1272fd90edb4eb92246524a9","generatedAt":"2026-11-20","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/","types":{"PHPForge\\Scaffold\\Config\\InstalledPackages":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/config/installedpackages/","summary":"Represents the packages Composer installed in a project, read from its `vendor/composer/installed.php`.","methods":{"__construct":{"signature":"public function __construct(array<string, array{version: string|null, path: string|null}>|null $packages)","summary":"Creates an installed-package view from normalized Composer metadata, or an unknown view from `null`.","params":[{"name":"$packages","type":"array<string, array{version: string|null, path: string|null}>|null","description":"Installed packages keyed by name, with their pretty version and absolute install path, or `null` when the installed packages are unknown."}]},"detect":{"signature":"public static function detect(string $vendorDir, string $projectRoot): self","summary":"Reads the installed packages of the project from `<vendorDir>/composer/installed.php`, then from the `Composer\\InstalledVersions` runtime data when its root package is `$projectRoot`.","params":[{"name":"$vendorDir","type":"string","description":"Absolute path to the Composer vendor directory of the project."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."}],"return":{"type":"self","description":"Installed packages, or an unknown list when neither source describes the project."},"static":true},"fromRawData":{"signature":"public static function fromRawData(mixed $data): self","summary":"Builds the list from the array returned by a `vendor/composer/installed.php` file.","params":[{"name":"$data","type":"mixed","description":"Decoded installed data with a `versions` map; any other value yields an unknown list."}],"return":{"type":"self","description":"Installed packages that declare an install path, or an unknown list when `$data` is malformed."},"static":true},"has":{"signature":"public function has(string $name): bool","summary":"Returns whether `$name` is installed; `false` when the installed packages are unknown.","params":[{"name":"$name","type":"string","description":"Package name to look up."}],"return":{"type":"bool","description":"`true` when the package is installed, `false` when it is not installed or the list is unknown."}},"installPath":{"signature":"public function installPath(string $name): string|null","summary":"Returns the absolute install path of `$name`, or `null` when it is not installed or unknown.","params":[{"name":"$name","type":"string","description":"Package name to look up."}],"return":{"type":"string|null","description":"Absolute install path, or `null` when the package is not installed or the list is unknown."}},"isKnown":{"signature":"public function isKnown(): bool","summary":"Returns whether the installed packages are known.","return":{"type":"bool","description":"`true` when an installed package source describes the project, `false` otherwise."}},"version":{"signature":"public function version(string $name): string|null","summary":"Returns the installed pretty version of `$name`, or `null` when it is not installed or unknown.","params":[{"name":"$name","type":"string","description":"Package name to look up."}],"return":{"type":"string|null","description":"Pretty version, or `null` when it is missing, not installed, or the list is unknown."}}}},"PHPForge\\Scaffold\\Config\\ProjectConfig":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/config/projectconfig/","summary":"Represents the consumer settings read from the project `composer.json`: `extra.scaffold` and `config.vendor-dir`.","properties":{"allowedPackages":{"type":"list<string>","default":"[]","description":"Package names allowed to write scaffold files, in declaration order.","readonly":true,"promoted":true},"auto":{"type":"bool","default":"true","description":"Whether the Composer hooks scaffold automatically.","readonly":true,"promoted":true},"declared":{"type":"bool","default":"false","description":"Whether `extra.scaffold` is an object.","readonly":true,"promoted":true},"ignoredEntries":{"type":"int","default":"0","description":"Number of non-string `allowed-packages` entries that were ignored.","readonly":true,"promoted":true},"vendorDir":{"type":"string|null","default":"null","description":"Non-empty `config.vendor-dir` as written in `composer.json`, or `null` when unset.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(list<string> $allowedPackages = [], bool $auto = true, int $ignoredEntries = 0, bool $declared = false, string|null $vendorDir = null)","summary":"Creates consumer settings from scaffold configuration and the configured vendor-directory value.","params":[{"name":"$allowedPackages","type":"list<string>","default":"[]","optional":true,"description":"Package names allowed to write scaffold files, in declaration order."},{"name":"$auto","type":"bool","default":"true","optional":true,"description":"Whether the Composer hooks scaffold automatically."},{"name":"$ignoredEntries","type":"int","default":"0","optional":true,"description":"Number of non-string `allowed-packages` entries that were ignored."},{"name":"$declared","type":"bool","default":"false","optional":true,"description":"Whether `extra.scaffold` is an object."},{"name":"$vendorDir","type":"string|null","default":"null","optional":true,"description":"Non-empty `config.vendor-dir` as written in `composer.json`, or `null` when unset."}]},"fromComposerJson":{"signature":"public static function fromComposerJson(string $path): self","summary":"Reads the configuration from a `composer.json` file.","params":[{"name":"$path","type":"string","description":"Absolute path to the project `composer.json`."}],"return":{"type":"self","description":"Configuration from `extra.scaffold` and `config.vendor-dir`, or the defaults when they are absent."},"throws":[{"type":"RuntimeException","description":"when the file is missing, unreadable, or not a JSON object."}],"static":true},"fromExtra":{"signature":"public static function fromExtra(mixed[] $extra): self","summary":"Reads the configuration from the `extra` section of the root package; only an explicit `false` in `auto` disables the Composer hooks.","params":[{"name":"$extra","type":"mixed[]","description":"`extra` section of the root package."}],"return":{"type":"self","description":"Configuration from `extra.scaffold`, or the defaults when it is absent or not an object."},"static":true},"isAllowed":{"signature":"public function isAllowed(string $packageName): bool","summary":"Returns whether `$packageName` is listed in `allowed-packages`.","params":[{"name":"$packageName","type":"string","description":"Package name to check."}],"return":{"type":"bool","description":"`true` when the package is allowed to write scaffold files, `false` otherwise."}}}},"PHPForge\\Scaffold\\Config\\ProjectContext":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/config/projectcontext/","summary":"Represents the project that the scaffold commands inspect: its root, vendor directory, configuration and installed packages.","properties":{"config":{"type":"PHPForge\\Scaffold\\Config\\ProjectConfig","description":"Consumer settings from the project `composer.json`.","readonly":true,"promoted":true},"installed":{"type":"PHPForge\\Scaffold\\Config\\InstalledPackages","description":"Packages installed in the project.","readonly":true,"promoted":true},"projectRoot":{"type":"string","description":"Absolute path to the project root.","readonly":true,"promoted":true},"vendorDir":{"type":"string","description":"Absolute path to the Composer vendor directory.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(string $projectRoot, string $vendorDir, PHPForge\\Scaffold\\Config\\ProjectConfig $config, PHPForge\\Scaffold\\Config\\InstalledPackages $installed)","summary":"Creates a project context from its resolved filesystem and Composer metadata.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$vendorDir","type":"string","description":"Absolute path to the Composer vendor directory."},{"name":"$config","type":"PHPForge\\Scaffold\\Config\\ProjectConfig","description":"Consumer settings from the project `composer.json`."},{"name":"$installed","type":"PHPForge\\Scaffold\\Config\\InstalledPackages","description":"Packages installed in the project."}]},"create":{"signature":"public static function create(string $projectRoot): self","summary":"Creates the context of the project rooted at `$projectRoot` from its `composer.json` and installed packages.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."}],"return":{"type":"self","description":"Project context with the configuration and installed packages of the project."},"throws":[{"type":"RuntimeException","description":"when the project `composer.json` is missing or invalid."}],"static":true},"isInstalled":{"signature":"public function isInstalled(string $providerName, mixed $providerLock = null): bool","summary":"Returns whether the provider is installed: from the installed packages when known, otherwise from the existence of its resolved root directory.","params":[{"name":"$providerName","type":"string","description":"Provider package name."},{"name":"$providerLock","type":"mixed","default":"null","optional":true,"description":"Decoded `providers.<name>` entry of `scaffold-lock.json`, or `null` when absent."}],"return":{"type":"bool","description":"`true` when the provider is installed in the project, `false` otherwise."}},"providerRoot":{"signature":"public function providerRoot(string $providerName, mixed $providerLock = null): array{root: string, warning: string|null}","summary":"Resolves the root of a provider from its Composer install path, then its lock-recorded path inside the vendor directory, then `<vendorDir>/<providerName>`.","params":[{"name":"$providerName","type":"string","description":"Provider package name."},{"name":"$providerLock","type":"mixed","default":"null","optional":true,"description":"Decoded `providers.<name>` entry of `scaffold-lock.json`, or `null` when absent."}],"return":{"type":"array{root: string, warning: string|null}","description":"Provider root, and a warning when the lock-recorded path resolves outside the vendor directory."}},"providers":{"signature":"public function providers(array<string, mixed> $lockProviders): array{providers: array<string, PHPForge\\Scaffold\\Config\\ProviderPackage>, warnings: array<string, string>}","summary":"Returns the allowed providers that are installed, as descriptors whose `extra` the scaffold core reads from their `composer.json`.","params":[{"name":"$lockProviders","type":"array<string, mixed>","description":"`providers` map of `scaffold-lock.json`, used for recorded paths and, when the installed packages are unknown, recorded versions."}],"return":{"type":"array{providers: array<string, PHPForge\\Scaffold\\Config\\ProviderPackage>, warnings: array<string, string>}","description":"Providers keyed by name in `allowed-packages` order, and warnings about provider roots keyed by provider name."}}}},"PHPForge\\Scaffold\\Config\\ProjectRootFinder":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/config/projectrootfinder/","summary":"Finds the project root by walking up from a directory to the nearest one that contains the Composer manifest.","methods":{"find":{"signature":"public static function find(string $directory): string|null","summary":"Returns the nearest directory, starting at `$directory` and walking up, that contains the Composer manifest named by `PHPForge\\Scaffold\\Config\\VendorDirResolver::manifestName()`.","params":[{"name":"$directory","type":"string","description":"Absolute path of the directory where the search starts."}],"return":{"type":"string|null","description":"Absolute path of the project root, or `null` when the filesystem root is reached first or the absolute manifest does not exist."},"static":true}}},"PHPForge\\Scaffold\\Config\\ProviderPackage":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/config/providerpackage/","summary":"Represents an installed provider package as the scaffold core sees it, independent of Composer's package classes.","properties":{"extra":{"type":"mixed[]|null","default":"null","description":"`extra` section of the package, or `null` to read it from the `composer.json` at `$installPath`.","readonly":true,"promoted":true},"installPath":{"type":"string|null","description":"Absolute install path, or `null` for a package without files, such as a metapackage.","readonly":true,"promoted":true},"name":{"type":"string","description":"Composer package name.","readonly":true,"promoted":true},"prettyVersion":{"type":"string","description":"Installed version recorded in `scaffold-lock.json`.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(string $name, string $prettyVersion, string|null $installPath, mixed[]|null $extra = null)","summary":"Creates an installed provider descriptor.","params":[{"name":"$name","type":"string","description":"Composer package name."},{"name":"$prettyVersion","type":"string","description":"Installed version recorded in `scaffold-lock.json`."},{"name":"$installPath","type":"string|null","description":"Absolute install path, or `null` for a package without files, such as a metapackage."},{"name":"$extra","type":"mixed[]|null","default":"null","optional":true,"description":"`extra` section of the package, or `null` to read it from the `composer.json` at `$installPath`."}]}}},"PHPForge\\Scaffold\\Config\\VendorDirResolver":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/config/vendordirresolver/","summary":"Resolves the Composer vendor directory of a project from `COMPOSER_VENDOR_DIR`, then `config.vendor-dir` in the project manifest (`composer.json`, or the file named by `COMPOSER`), then `<project-root>/vendor`.","methods":{"manifestName":{"signature":"public static function manifestName(): string","summary":"Returns the file name of the project manifest: the `COMPOSER` environment variable when set, otherwise `composer.json`.","return":{"type":"string","description":"Manifest file name, relative to the project root unless the `COMPOSER` value is absolute."},"static":true},"manifestPath":{"signature":"public static function manifestPath(string $projectRoot): string","summary":"Returns the absolute path of the project manifest named by `PHPForge\\Scaffold\\Config\\VendorDirResolver::manifestName()`.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root directory."}],"return":{"type":"string","description":"Absolute path of the project manifest."},"static":true},"resolve":{"signature":"public static function resolve(string $projectRoot, string|null $configured = null): string","summary":"Returns the absolute path to the vendor directory for the project rooted at `$projectRoot`.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root directory."},{"name":"$configured","type":"string|null","default":"null","optional":true,"description":"`config.vendor-dir` of the project manifest, or `null` when unset."}],"return":{"type":"string","description":"Absolute path to the resolved vendor directory."},"static":true}}},"PHPForge\\Scaffold\\Console\\Application":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/application/","summary":"Runs the `status`, `providers`, `diff`, `eject`, `reapply`, `prune` and `sync` commands as the `vendor/bin/scaffold` console application.","extends":"Symfony\\Component\\Console\\Application","methods":{"__construct":{"signature":"public function __construct()","summary":"Creates the application and registers the scaffold commands."},"getDefaultInputDefinition":{"signature":"protected function getDefaultInputDefinition(): Symfony\\Component\\Console\\Input\\InputDefinition","summary":"Returns the default input definition with the global `--working-dir` (`-d`) option added.","return":{"type":"Symfony\\Component\\Console\\Input\\InputDefinition","description":"Symfony's default definition extended with `--working-dir`."},"visibility":"protected"},"resolveVersion":{"signature":"public static function resolveVersion(string $package = \\self::NAME): string","summary":"Returns the installed version of `$package` from Composer's runtime metadata, or `PHPForge\\Scaffold\\Console\\Application::FALLBACK_VERSION` when the metadata does not list it.","params":[{"name":"$package","type":"string","default":"\\self::NAME","optional":true,"description":"Composer package name to query; defaults to this application's package."}],"return":{"type":"string","description":"Installed pretty version (for example, `1.2.0` or `dev-main`), or the fallback version."},"static":true}},"constants":{"FALLBACK_VERSION":{"value":"'0.3.x-dev'","description":"Version reported when Composer's runtime metadata does not list the package."},"NAME":{"value":"'php-forge/scaffold'","description":"Application / Composer package name."}}},"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/abstractscaffoldcommand/","summary":"Runs a scaffold console command: validates its input, resolves the project root and reports a `RuntimeException` of the command body as a `[scaffold]` error.","extends":"Symfony\\Component\\Console\\Command\\Command","methods":{"execute":{"signature":"final protected function execute(Symfony\\Component\\Console\\Input\\InputInterface $input, Symfony\\Component\\Console\\Output\\OutputInterface $output): int","summary":"Validates the input, resolves the project root and runs `PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand::handle()`.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Command input that may carry the global `--working-dir` option."},{"name":"$output","type":"Symfony\\Component\\Console\\Output\\OutputInterface","description":"Console output that receives the command output and the error messages."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand::handle()`; `1` when the project root is not found or a runtime error is reported; `2` when the input is invalid."},"visibility":"protected"},"handle":{"signature":"abstract protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Runs the command body against the project root and returns its exit code.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Command input."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink of the command."},{"name":"$projectRoot","type":"string","description":"Absolute path of the directory containing the project `composer.json`."}],"return":{"type":"int","description":"Exit code of the command."},"throws":[{"type":"RuntimeException","description":"when the lock file or the project manifest cannot be read or written."}],"visibility":"protected","abstract":true},"validate":{"signature":"protected function validate(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out): bool","summary":"Returns whether the input is valid, writing the error to the error output when it is not.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Command input."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the error message."}],"return":{"type":"bool","description":"`true` when the command may run, `false` otherwise."},"visibility":"protected"}}},"PHPForge\\Scaffold\\Console\\Command\\DiffCommand":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/diffcommand/","summary":"Shows what applying the provider would change in a tracked file, or in every tracked file, as a unified diff.","extends":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","methods":{"configure":{"signature":"protected function configure(): void","summary":"Declares the optional `file` argument and the `--all` and `--exit-code` options.","return":{"type":"void"},"visibility":"protected"},"handle":{"signature":"protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Renders the diff of the given file, or of every file with `--all`.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `file` argument and the `--all` and `--exit-code` options."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the diff and the error messages."},{"name":"$projectRoot","type":"string","description":"Absolute path of the project root."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Services\\DiffService::run()`."},"visibility":"protected"},"validate":{"signature":"protected function validate(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out): bool","summary":"Returns whether exactly one of `file` and `--all` is given.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `file` argument and the `--all` option."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the error message."}],"return":{"type":"bool","description":"`true` when exactly one target is given, `false` otherwise."},"visibility":"protected"}},"inherited":{"methods":{"execute":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand"}}},"PHPForge\\Scaffold\\Console\\Command\\EjectCommand":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/ejectcommand/","summary":"Marks a file as ejected in `scaffold-lock.json` so scaffold stops managing it, without deleting it from disk.","extends":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","methods":{"configure":{"signature":"protected function configure(): void","summary":"Declares the `file` argument and the `--yes` option.","return":{"type":"void"},"visibility":"protected"},"handle":{"signature":"protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Ejects the given file, or previews the ejection without `--yes`.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `file` argument and the `--yes` option."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the ejection notice and the error messages."},{"name":"$projectRoot","type":"string","description":"Absolute path of the project root."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Services\\EjectService::run()`."},"visibility":"protected"}},"inherited":{"methods":{"execute":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","validate":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand"}}},"PHPForge\\Scaffold\\Console\\Command\\ProvidersCommand":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/providerscommand/","summary":"Lists all scaffold providers recorded in `scaffold-lock.json` with their file counts.","extends":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","methods":{"handle":{"signature":"protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Prints the provider table.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input that may carry the global `--working-dir` option."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the provider table and the error messages."},{"name":"$projectRoot","type":"string","description":"Absolute path of the project root."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Services\\ProvidersService::run()`."},"visibility":"protected"}},"inherited":{"methods":{"execute":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","validate":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand"}}},"PHPForge\\Scaffold\\Console\\Command\\PruneCommand":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/prunecommand/","summary":"Lists the files that no allowed provider ships anymore and, with `--force`, removes them from the lock and deletes the ones that hold only provider content.","extends":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","methods":{"configure":{"signature":"protected function configure(): void","summary":"Declares the `--force`, `--delete-modified` and `--exit-code` options.","return":{"type":"void"},"visibility":"protected"},"handle":{"signature":"protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Previews or prunes the orphaned entries.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `--force`, `--delete-modified` and `--exit-code` options."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the orphan report and the error messages."},{"name":"$projectRoot","type":"string","description":"Absolute path of the project root."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Services\\PruneService::run()`."},"visibility":"protected"}},"inherited":{"methods":{"execute":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","validate":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand"}}},"PHPForge\\Scaffold\\Console\\Command\\ReapplyCommand":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/reapplycommand/","summary":"Reapplies provider stubs to tracked files; `--force` also overwrites ejected, adopted, user-modified, `preserve`, `append` and `prepend` files.","extends":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","methods":{"configure":{"signature":"protected function configure(): void","summary":"Declares the optional `file` argument and the `--force`, `--provider`, `--dry-run` and `--exit-code` options.","return":{"type":"void"},"visibility":"protected"},"handle":{"signature":"protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Reapplies the matching tracked files.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `file` argument and the `--force`, `--provider`, `--dry-run` and `--exit-code` options."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the reapply report and the error messages."},{"name":"$projectRoot","type":"string","description":"Absolute path of the project root."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Services\\ReapplyService::run()`."},"visibility":"protected"}},"inherited":{"methods":{"execute":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","validate":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand"}}},"PHPForge\\Scaffold\\Console\\Command\\StatusCommand":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/statuscommand/","summary":"Displays the state of every scaffold-tracked file against the disk and the current provider stubs.","extends":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","methods":{"configure":{"signature":"protected function configure(): void","summary":"Declares the `--format` and `--exit-code` options.","return":{"type":"void"},"visibility":"protected"},"handle":{"signature":"protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Prints the status of the tracked files.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `--format` and `--exit-code` options."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the status table or JSON document and the error messages."},{"name":"$projectRoot","type":"string","description":"Absolute path of the project root."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Services\\StatusService::run()`."},"visibility":"protected"},"validate":{"signature":"protected function validate(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out): bool","summary":"Returns whether `--format` is `table` or `json`.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `--format` option."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the error message."}],"return":{"type":"bool","description":"`true` when the format is known, `false` otherwise."},"visibility":"protected"}},"inherited":{"methods":{"execute":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand"}}},"PHPForge\\Scaffold\\Console\\Command\\SyncCommand":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/command/synccommand/","summary":"Applies the allowed and installed providers to the project outside Composer, as `composer install` would.","extends":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","methods":{"configure":{"signature":"protected function configure(): void","summary":"Declares the `--dry-run`, `--exit-code` and `--force` options.","return":{"type":"void"},"visibility":"protected"},"handle":{"signature":"protected function handle(Symfony\\Component\\Console\\Input\\InputInterface $input, PHPForge\\Scaffold\\Console\\SymfonyOutputWriter $out, string $projectRoot): int","summary":"Synchronizes the project.","params":[{"name":"$input","type":"Symfony\\Component\\Console\\Input\\InputInterface","description":"Input with the `--dry-run`, `--exit-code` and `--force` options."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter","description":"Output sink that receives the sync report and the error messages."},{"name":"$projectRoot","type":"string","description":"Absolute path of the project root."}],"return":{"type":"int","description":"Exit code of `PHPForge\\Scaffold\\Services\\SyncService::run()`."},"visibility":"protected"}},"inherited":{"methods":{"execute":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand","validate":"PHPForge\\Scaffold\\Console\\Command\\AbstractScaffoldCommand"}}},"PHPForge\\Scaffold\\Console\\ComposerIoWriter":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/composeriowriter/","summary":"Adapts Composer IO to `PHPForge\\Scaffold\\Console\\OutputWriter`, so the Composer-free scaffold core can report through a Composer run.","implements":["PHPForge\\Scaffold\\Console\\OutputWriter"],"methods":{"__construct":{"signature":"public function __construct(Composer\\IO\\IOInterface $io)","summary":"Creates a writer for Composer IO.","params":[{"name":"$io","type":"Composer\\IO\\IOInterface","description":"Composer IO that receives the messages."}]},"writeStderr":{"signature":"public function writeStderr(string $message): void","summary":"Writes `$message` with `Composer\\IO\\IOInterface::writeError()`.","params":[{"name":"$message","type":"string","description":"Message without a trailing newline; the writer appends one."}],"return":{"type":"void"}},"writeStdout":{"signature":"public function writeStdout(string $message): void","summary":"Writes `$message` with `Composer\\IO\\IOInterface::write()`.","params":[{"name":"$message","type":"string","description":"Message without a trailing newline; the writer appends one."}],"return":{"type":"void"}}}},"PHPForge\\Scaffold\\Console\\DiffColorizer":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/diffcolorizer/","summary":"Colors unified diff lines with raw ANSI escape codes: the first two lines (file headers) in bold, hunk headers in cyan, added lines in green and removed lines in red.","methods":{"colorize":{"signature":"public function colorize(string $diff): string","summary":"Colors a unified diff whose first two lines are the `---` and `+++` file headers.","params":[{"name":"$diff","type":"string","description":"Unified diff with `\"\\n\"` line separators."}],"return":{"type":"string","description":"Diff with each styled line wrapped in ANSI escape codes; context lines stay unstyled."}}}},"PHPForge\\Scaffold\\Console\\ExitCode":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/exitcode/","summary":"Represents the exit codes that scaffold services return to the console commands.","backingType":"int","cases":{"Error":{"value":"1","description":"Reports a failure such as an untracked file, an unsafe lock entry, a missing stub, a read error, or a `reapply` filter that matches no tracked file."},"Ok":{"value":"0","description":"Reports success, including previews and runs that change nothing."}}},"PHPForge\\Scaffold\\Console\\Message":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/message/","summary":"Represents the message templates of the console output written by the scaffold plugin.","traits":["PHPForge\\Scaffold\\MessageTemplate"],"backingType":"string","cases":{"COMMAND_CWD_UNRESOLVABLE":{"value":"'[scaffold] Unable to determine current working directory.'","description":"Error when the current working directory cannot be determined."},"COMMAND_FILE_ERROR":{"value":"'[scaffold] \"%s\": %s'","description":"Error when a tracked file cannot be previewed."},"COMMAND_FILE_NOT_TRACKED":{"value":"'[scaffold] \"%s\" is not tracked in scaffold-lock.json.'","description":"Error when a file is not tracked in the lock file."},"COMMAND_MANIFEST_NOT_FOUND":{"value":"'[scaffold] No %s found in \"%s\" or any parent directory.'","description":"Error when no Composer manifest is found in the start directory or any of its parents."},"COMMAND_PROVIDER_NOT_ALLOWED":{"value":"'[scaffold] \"%s\": provider \"%s\" is not in extra.scaffold.allowed-packages; ' . 'skipped.'","description":"Error when the provider of a lock entry is not in `allowed-packages`."},"COMMAND_UNSAFE_ENTRY":{"value":"'[scaffold] Unsafe lock entry for \"%s\": %s'","description":"Error when a lock entry fails path validation."},"COMMAND_WORKING_DIR_NOT_FOUND":{"value":"'[scaffold] Working directory \"%s\" does not exist.'","description":"Error when the `--working-dir` directory does not exist."},"DIFF_CREATED_EMPTY":{"value":"'[scaffold] %s: would be created empty.'","description":"Notice when applying the provider would create an empty file."},"DIFF_EJECTED":{"value":"'[scaffold] %s: ejected; scaffold does not manage it (see reapply --force).'","description":"Notice when the requested file is ejected."},"DIFF_LINE_ENDINGS_ONLY":{"value":"'[scaffold] %s: differs only in line endings.'","description":"Notice when a file differs from the provider only in its line endings."},"DIFF_MANIFEST_NOT_LOADED":{"value":"'[scaffold] \"%s\": the manifest of provider \"%s\" could not be loaded; skipped.'","description":"Error when the manifest of the provider of a tracked file could not be loaded."},"DIFF_NO_CHANGES":{"value":"'[scaffold] %s: no changes.'","description":"Notice when applying the provider would not change a file."},"DIFF_ORPHAN":{"value":"'[scaffold] %s: orphan; no allowed provider ships it anymore.'","description":"Notice when no allowed provider ships a tracked file anymore."},"DIFF_PREVIEW_HEADER":{"value":"'[scaffold] %s (%s, %s): changes applying the provider would make%s'","description":"Header printed before the diff of a file that applying the provider would change."},"DIFF_TARGET_AMBIGUOUS":{"value":"'[scaffold] Pass either a file or --all.'","description":"Error when neither or both of a file and `--all` are given."},"EJECT_ALREADY_EJECTED":{"value":"'[scaffold] \"%s\" is already ejected.'","description":"Notice when the file is already ejected."},"EJECT_CONFIRMATION_REQUIRED":{"value":"'[scaffold] Would eject \"%s\": it will not be managed until reapplied with ' . '--force. Run with --yes to confirm.'","description":"Notice that previews an ejection that still needs `--yes`."},"EJECT_EJECTED":{"value":"'[scaffold] Ejected \"%s\": it will not be managed until reapplied with --force. The file was ' . 'not deleted from disk.'","description":"Notice when a file is ejected."},"FRAGMENT_COMMAND":{"value":"'%s: '","description":"Fragment that names the command in a summary line."},"FRAGMENT_CONFLICT":{"value":"'conflict'","description":"Fragment that labels a conflict count."},"FRAGMENT_CONFLICT_FILE":{"value":"'file has'","description":"Fragment that names one file with untaken provider updates."},"FRAGMENT_CONFLICT_FILES":{"value":"'files have'","description":"Fragment that names several files with untaken provider updates."},"FRAGMENT_COUNT":{"value":"'%d %s'","description":"Fragment that pairs a count with its label."},"FRAGMENT_COUNT_UNCHANGED":{"value":"'%d unchanged'","description":"Fragment that counts unchanged files."},"FRAGMENT_COUNT_WRITTEN":{"value":"'%d %s written'","description":"Fragment that counts written files."},"FRAGMENT_DRY_RUN":{"value":"' --dry-run'","description":"Fragment that marks a dry run."},"FRAGMENT_ENTRIES_LACK":{"value":"'entries lack'","description":"Fragment that names several lock entries without `stub-hash`."},"FRAGMENT_ENTRY_LACKS":{"value":"'entry lacks'","description":"Fragment that names one lock entry without `stub-hash`."},"FRAGMENT_ERROR":{"value":"'error'","description":"Fragment that labels one error."},"FRAGMENT_ERRORS":{"value":"'errors'","description":"Fragment that labels several errors."},"FRAGMENT_FILE":{"value":"'file'","description":"Fragment that labels one file."},"FRAGMENT_FILES":{"value":"'files'","description":"Fragment that labels several files."},"FRAGMENT_ORPHAN":{"value":"'orphan'","description":"Fragment that labels an orphan count."},"FRAGMENT_OUTDATED":{"value":"'outdated'","description":"Fragment that labels an outdated count."},"FRAGMENT_PARENTHESIZED":{"value":"' (%s)'","description":"Fragment that appends a parenthesized detail."},"FRAGMENT_PRESERVE_PREVIEW":{"value":"' (preserve: applied only with reapply --force)'","description":"Fragment that marks the preview of an existing `preserve` file."},"FRAGMENT_UNKNOWN_PROVIDER":{"value":"'?'","description":"Fragment that stands for an unknown provider."},"FRAGMENT_USER_MODIFIED_PREVIEW":{"value":"' (user-modified: scaffold skips it; use reapply --force)'","description":"Fragment that marks the preview of a user-modified file."},"FRAGMENT_WARNING":{"value":"'warning'","description":"Fragment that labels one warning."},"FRAGMENT_WARNINGS":{"value":"'warnings'","description":"Fragment that labels several warnings."},"FRAGMENT_WOULD_BE_WRITTEN":{"value":"'would be written'","description":"Fragment that labels the files a dry run would write."},"FRAGMENT_WRITTEN":{"value":"'written'","description":"Fragment that labels the written files."},"PROVIDERS_NONE":{"value":"'[scaffold] No providers tracked in scaffold-lock.json.'","description":"Notice when the lock file tracks no provider."},"PRUNE_DELETED":{"value":"'[scaffold] Deleted \"%s\"%s.'","description":"Notice when an orphan file is deleted."},"PRUNE_DIRECTORY_REMOVE_FAILED":{"value":"'[scaffold] Could not remove empty directory \"%s\".'","description":"Warning when an empty parent directory cannot be removed."},"PRUNE_DRY_RUN_SUMMARY":{"value":"'[scaffold] prune --dry-run: %d would be removed, %d would be kept (modified), %d %s; ' . 'run with --force to apply.'","description":"Summary line of a `prune` dry run."},"PRUNE_ENTRY_DROPPED":{"value":"'[scaffold] Dropped the entry of \"%s\" (%s).'","description":"Notice when the lock entry of a missing or unsafe orphan is dropped."},"PRUNE_FILE_DELETE_FAILED":{"value":"'[scaffold] Could not delete \"%s\".'","description":"Error when an orphan file cannot be deleted."},"PRUNE_KEPT":{"value":"'[scaffold] Kept \"%s\" (%s); it is yours now and no longer tracked.'","description":"Notice when a modified orphan file is kept and no longer tracked."},"PRUNE_NO_ORPHANS":{"value":"'[scaffold] No orphaned files.'","description":"Notice when there is no orphan file."},"PRUNE_SUMMARY":{"value":"'[scaffold] prune: %d removed, %d kept (modified), %d %s.'","description":"Summary line of a `prune` run."},"REAPPLY_ALREADY_UP_TO_DATE":{"value":"'[scaffold] \"%s\" is already up to date.'","description":"Notice when an `append` or `prepend` file already holds the provider content."},"REAPPLY_APPLIED":{"value":"'[scaffold] Reapplied \"%s\".'","description":"Notice when a file is reapplied."},"REAPPLY_EJECTED":{"value":"'[scaffold] \"%s\" is ejected. Use --force to manage it again.'","description":"Warning when an ejected file is skipped."},"REAPPLY_FAILED":{"value":"'[scaffold] Could not reapply \"%s\": %s Skipping.'","description":"Error when an `append` or `prepend` file cannot be reapplied."},"REAPPLY_MERGE_STRATEGY_UNKNOWN":{"value":"'[scaffold] Unknown merge strategy \"%s\" for \"%s\"; using the default for its ' . 'name.'","description":"Warning when a lock entry records an unknown merge strategy."},"REAPPLY_NO_MATCH":{"value":"'[scaffold] No tracked files matched the given filter.'","description":"Error when no tracked file matches the file or provider filter."},"REAPPLY_ORPHANED":{"value":"'[scaffold] \"%s\" is orphaned; run \"vendor/bin/scaffold prune\" to review.'","description":"Warning when an orphaned file is skipped."},"REAPPLY_PRESERVE":{"value":"'[scaffold] \"%s\" uses mode \"preserve\". Use --force to overwrite.'","description":"Warning when an existing `preserve` file is skipped."},"REAPPLY_STUB_NOT_FOUND":{"value":"'[scaffold] Stub not found: \"%s\". Skipping.'","description":"Error when the provider stub of a file does not exist."},"REAPPLY_SUMMARY":{"value":"'[scaffold] reapply%s: %d %s, %d unchanged, %d skipped%s, %d %s.'","description":"Summary line of a `reapply` run."},"REAPPLY_UNSAFE_ENTRY":{"value":"'[scaffold] Unsafe lock entry for \"%s\": %s Skipping.'","description":"Error when a lock entry fails path validation and is skipped."},"REAPPLY_USER_MODIFIED":{"value":"'[scaffold] \"%s\" is user-modified. Use --force to overwrite.'","description":"Warning when a user-modified file is skipped."},"SCAFFOLD_ADOPTED_SKIPPED":{"value":"'[scaffold] User-modified file skipped: \"%s\".'","description":"Warning when an adopted `replace` file is skipped."},"SCAFFOLD_ALLOWED_ENTRY_IGNORED":{"value":"'[scaffold] Non-string entry in allowed-packages ignored.'","description":"Warning when a non-string `allowed-packages` entry is ignored."},"SCAFFOLD_APPLY_FAILED":{"value":"'[scaffold] Error applying \"%s\": %s'","description":"Error when a file mapping fails to apply."},"SCAFFOLD_AUTO_DISABLED":{"value":"'[scaffold] Auto-scaffold disabled via \"extra.scaffold.auto\"; run ' . '\"vendor/bin/scaffold\" manually.'","description":"Notice when `extra.scaffold.auto` disables the Composer hooks."},"SCAFFOLD_CONFIG_MISSING":{"value":"'[scaffold] No extra.scaffold configuration found. Skipping scaffold.'","description":"Notice when the root package has no `extra.scaffold` configuration."},"SCAFFOLD_CONFLICTS":{"value":"'[scaffold] %d %s provider updates you have not taken (conflict); run ' . '\"vendor/bin/scaffold diff --all\".'","description":"Warning when user-modified files skip provider updates."},"SCAFFOLD_NO_ALLOWED_PACKAGES":{"value":"'[scaffold] No allowed-packages configured. Skipping scaffold.'","description":"Notice when `allowed-packages` is empty or missing."},"SCAFFOLD_ORPHAN_ENTRY":{"value":"'[scaffold]   %s (%s)'","description":"Line that lists one orphaned file with its provider."},"SCAFFOLD_ORPHAN_HEADER":{"value":"'[scaffold] %d orphaned %s no allowed provider ships anymore; run ' . '\"vendor/bin/scaffold prune\" to review.'","description":"Warning that announces the orphaned files with the `prune` hint."},"SCAFFOLD_ORPHAN_MORE":{"value":"'[scaffold]   ... and %d more'","description":"Line that counts the orphaned files left out of the list."},"SCAFFOLD_OVERRIDE":{"value":"'[scaffold] \"%s\" from \"%s\" overrides \"%s\" (last provider in allowed-packages wins).'","description":"Notice when a later provider overrides the destination of an earlier one."},"SCAFFOLD_PERMISSIONS_COPY_FAILED":{"value":"'Could not copy permissions from \"%s\" to \"%s\".'","description":"Warning when the source permissions cannot be copied onto the destination."},"SCAFFOLD_PREFIXED":{"value":"'[scaffold] %s'","description":"Line that prefixes a message with `[scaffold]`."},"SCAFFOLD_PROVIDER_INSTALL_PATH_MISSING":{"value":"'[scaffold] Provider \"%s\" has no install path (metapackage); ' . 'skipping.'","description":"Warning when an allowed provider has no install path."},"SCAFFOLD_PROVIDER_MAPPINGS_EMPTY":{"value":"'[scaffold] Provider \"%s\" produced no file mappings; check its copy[] ' . 'entries and excludes.'","description":"Warning when a provider manifest produces no file mapping."},"SCAFFOLD_PROVIDER_NOT_INSTALLED":{"value":"'[scaffold] Provider \"%s\" is allowed but not installed; check ' . 'extra.scaffold.allowed-packages or require it.'","description":"Warning when an allowed provider is not installed."},"SCAFFOLD_PROVIDER_ROOT_OUTSIDE_VENDOR":{"value":"'[scaffold] Provider root for \"%s\" resolves outside vendor dir; using ' . 'default path.'","description":"Warning when the recorded provider root resolves outside the vendor directory."},"SCAFFOLD_SUMMARY":{"value":"'[scaffold] %s%s.'","description":"Summary line of a scaffold run."},"SCAFFOLD_UNTRACKED_OVERWRITTEN":{"value":"'Overwrote untracked existing file \"%1$s\"; review it with git diff or run ' . '\"scaffold eject %1$s --yes\" to keep your version.'","description":"Warning when an untracked existing file is overwritten."},"SCAFFOLD_USER_MODIFIED_SKIPPED":{"value":"'User-modified file skipped: \"%s\".'","description":"Warning when a user-modified `replace` file is skipped."},"SCAFFOLD_VENDOR_DIR_UNRESOLVABLE":{"value":"'[scaffold] Unable to resolve vendor-dir from Composer config; aborting ' . 'scaffold.'","description":"Error when the vendor directory cannot be resolved from the Composer configuration."},"STATUS_FORMAT_UNKNOWN":{"value":"'[scaffold] Unknown format \"%s\"; use \"table\" or \"json\".'","description":"Error when `--format` is neither `table` nor `json`."},"STATUS_NO_FILES":{"value":"'[scaffold] No files tracked in scaffold-lock.json.'","description":"Notice when the lock file tracks no file."},"STATUS_PROVIDER_DRIFT":{"value":"'[scaffold] %s: lock %s, installed %s (run composer install).'","description":"Warning when the locked provider version differs from the installed one."},"STATUS_STUB_HASH_MISSING":{"value":"'[scaffold] %d %s stub-hash; run composer install to refresh.'","description":"Notice when lock entries lack `stub-hash`."},"STATUS_SUMMARY":{"value":"'[scaffold] %d %s: %s.'","description":"Summary line of the status table."},"SYNC_ABORTED":{"value":"'[scaffold] Sync aborted: %s'","description":"Error when a `sync` run aborts."},"SYNC_DRY_RUN_SUMMARY":{"value":"'[scaffold] sync --dry-run: %d %s would change, %d unchanged, %d orphan, %d %s.'","description":"Summary line of a `sync` dry run."},"SYNC_NO_ALLOWED_PACKAGES":{"value":"'[scaffold] No allowed-packages configured. Nothing to sync.'","description":"Notice when `allowed-packages` is empty or missing."}}},"PHPForge\\Scaffold\\Console\\OutputWriter":{"kind":"interface","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/outputwriter/","summary":"Writes service messages to standard output or standard error, appending one newline per message.","methods":{"writeStderr":{"signature":"abstract public function writeStderr(string $message): void","summary":"Writes `$message` to the standard error stream followed by a trailing newline.","params":[{"name":"$message","type":"string","description":"Message without a trailing newline; the writer appends one."}],"return":{"type":"void"},"abstract":true},"writeStdout":{"signature":"abstract public function writeStdout(string $message): void","summary":"Writes `$message` to the standard output stream followed by a trailing newline.","params":[{"name":"$message","type":"string","description":"Message without a trailing newline; the writer appends one."}],"return":{"type":"void"},"abstract":true}}},"PHPForge\\Scaffold\\Console\\SymfonyOutputWriter":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/symfonyoutputwriter/","summary":"Writes service messages to a Symfony Console output in raw mode, so stub content such as `<?php ?>` is never parsed as style tags.","implements":["PHPForge\\Scaffold\\Console\\OutputWriter"],"methods":{"__construct":{"signature":"public function __construct(Symfony\\Component\\Console\\Output\\OutputInterface $output)","summary":"Creates a writer for a Symfony Console output.","params":[{"name":"$output","type":"Symfony\\Component\\Console\\Output\\OutputInterface","description":"Console output that receives the messages and, through its error output when it is a `Symfony\\Component\\Console\\Output\\ConsoleOutputInterface`, the standard error messages."}]},"isDecorated":{"signature":"public function isDecorated(): bool","summary":"Returns whether the console output supports ANSI decoration.","return":{"type":"bool","description":"`true` when the main output is decorated, `false` otherwise."}},"writeStderr":{"signature":"public function writeStderr(string $message): void","summary":"Writes `$message` and a newline to the error output, or to the main output when no error output is available.","params":[{"name":"$message","type":"string","description":"Message without a trailing newline; the writer appends one."}],"return":{"type":"void"}},"writeStdout":{"signature":"public function writeStdout(string $message): void","summary":"Writes `$message` and a newline to the main output.","params":[{"name":"$message","type":"string","description":"Message without a trailing newline; the writer appends one."}],"return":{"type":"void"}}}},"PHPForge\\Scaffold\\Console\\Table":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/console/table/","summary":"Renders a plain-text table whose columns are as wide as their longest cell and separated by two spaces.","methods":{"render":{"signature":"public static function render(list<string> $headers, list<list<string>> $rows): list<string>","summary":"Returns the header line, a dash separator as wide as the table, and one line per row.","params":[{"name":"$headers","type":"list<string>","description":"Column headers."},{"name":"$rows","type":"list<list<string>>","description":"Rows with one cell per header."}],"return":{"type":"list<string>","description":"Lines without trailing newlines or trailing spaces."},"static":true}}},"PHPForge\\Scaffold\\EventSubscriber":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/eventsubscriber/","summary":"Listens to Composer script events and triggers the scaffold workflow.","implements":["Composer\\EventDispatcher\\EventSubscriberInterface"],"methods":{"getSubscribedEvents":{"signature":"public static function getSubscribedEvents(): array<string, string>","summary":"Returns the Composer script events handled by this subscriber.","return":{"type":"array<string, string>","description":"Event name => handler method."},"static":true},"onPostCreateProject":{"signature":"public function onPostCreateProject(Composer\\Script\\Event $event): void","summary":"Runs the scaffold workflow for `post-create-project-cmd`, unless `post-install-cmd` or `post-update-cmd` already fired in this process.","params":[{"name":"$event","type":"Composer\\Script\\Event","description":"The Composer event object."}],"return":{"type":"void"}},"onPostInstall":{"signature":"public function onPostInstall(Composer\\Script\\Event $event): void","summary":"Runs the scaffold workflow for `post-install-cmd`.","params":[{"name":"$event","type":"Composer\\Script\\Event","description":"The Composer event object."}],"return":{"type":"void"}},"onPostUpdate":{"signature":"public function onPostUpdate(Composer\\Script\\Event $event): void","summary":"Runs the scaffold workflow for `post-update-cmd`.","params":[{"name":"$event","type":"Composer\\Script\\Event","description":"The Composer event object."}],"return":{"type":"void"}}}},"PHPForge\\Scaffold\\Exception\\Message":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/exception/message/","summary":"Represents the message templates of the exceptions thrown by the scaffold plugin.","traits":["PHPForge\\Scaffold\\MessageTemplate"],"backingType":"string","cases":{"CONFIG_MANIFEST_INVALID_JSON":{"value":"'Project manifest \"%s\" is not valid JSON: %s.'","description":"Error when the project manifest is not valid JSON."},"CONFIG_MANIFEST_NOT_FOUND":{"value":"'Project manifest \"%s\" not found.'","description":"Error when the project manifest does not exist."},"CONFIG_MANIFEST_NOT_OBJECT":{"value":"'Project manifest \"%s\" does not contain a JSON object.'","description":"Error when the project manifest does not decode to a JSON object."},"CONFIG_MANIFEST_UNREADABLE":{"value":"'Could not read project manifest \"%s\".'","description":"Error when the project manifest cannot be read."},"FILESYSTEM_FAILED":{"value":"'%s Reason: %s.'","description":"Error when a native filesystem call fails, followed by the PHP warning it raised."},"LOCK_CONFLICT_MARKERS":{"value":"'Lock file \"%s\" contains Git conflict markers and is not valid JSON (%s). Resolve the ' . 'merge conflict and run the command again.'","description":"Error when the lock file holds Git conflict markers and is not valid JSON."},"LOCK_ENCODE_FAILED":{"value":"'Could not encode lock file \"%s\": %s.'","description":"Error when the lock file contents cannot be encoded as JSON."},"LOCK_HASH_FAILED":{"value":"'Could not hash file \"%s\".'","description":"Error when a file cannot be hashed."},"LOCK_INVALID_JSON":{"value":"'Lock file \"%s\" is not valid JSON: %s.'","description":"Error when the lock file is not valid JSON."},"LOCK_MODE_UNKNOWN":{"value":"'Unknown mode \"%s\" in scaffold-lock.json.'","description":"Error when a lock entry records an unknown mode."},"LOCK_NOT_OBJECT":{"value":"'Lock file \"%s\" does not contain a valid JSON object.'","description":"Error when the lock file does not decode to a JSON object."},"LOCK_UNREADABLE":{"value":"'Could not read lock file \"%s\".'","description":"Error when the lock file cannot be read."},"LOCK_UNWRITABLE":{"value":"'Could not write lock file \"%s\".'","description":"Error when the lock file cannot be written."},"MANIFEST_COPY_EMPTY":{"value":"'Manifest \"copy\" must declare at least one path.'","description":"Error when the manifest `copy` list is empty."},"MANIFEST_COPY_ENTRY_INVALID":{"value":"'Manifest \"copy\" entries must be either a string or an object with \"from\" and ' . '\"to\" keys.'","description":"Error when a manifest `copy` entry is neither a string nor a `from`/`to` object."},"MANIFEST_COPY_ENTRY_NOT_FOUND":{"value":"'Scaffold copy entry \"%s\" does not exist under provider root \"%s\".'","description":"Error when a manifest `copy` entry does not exist under the provider root."},"MANIFEST_COPY_MISSING":{"value":"'Manifest is missing required key \"copy\" or it is not an array.'","description":"Error when the manifest lacks the `copy` key or it is not an array."},"MANIFEST_COPY_NOT_LIST":{"value":"'Manifest \"copy\" must be a sequential list of entries, not an associative object.'","description":"Error when the manifest `copy` value is an associative object instead of a list."},"MANIFEST_ENTRY_ABSOLUTE":{"value":"'Manifest \"%s\" entry \"%s\" must be a relative path.'","description":"Error when a manifest path entry is absolute."},"MANIFEST_ENTRY_EMPTY":{"value":"'Manifest \"%s\" entries must be non-empty strings.'","description":"Error when a manifest path entry is not a non-empty string."},"MANIFEST_ENTRY_TRAVERSAL":{"value":"'Manifest \"%s\" entry \"%s\" must not contain path traversal segments.'","description":"Error when a manifest path entry contains traversal segments."},"MANIFEST_EXCLUDE_NOT_ARRAY":{"value":"'Manifest \"exclude\" must be an array when present.'","description":"Error when the manifest `exclude` value is not an array."},"MANIFEST_KEY_UNKNOWN":{"value":"'Manifest contains unknown key \"%s\". Allowed keys: %s.'","description":"Error when the manifest declares an unknown key."},"MANIFEST_MAP_NOT_OBJECT":{"value":"'Manifest \"%s\" must be an object when present.'","description":"Error when the manifest `modes` or `merge` key is not an object."},"MANIFEST_MAP_VALUE_INVALID":{"value":"'Manifest \"%s\" value for pattern \"%s\" has invalid %s \"%s\". Allowed: %s.'","description":"Error when a manifest `modes` or `merge` value is not one of the allowed values."},"MANIFEST_MAP_VALUE_NOT_STRING":{"value":"'Manifest \"%s\" value for pattern \"%s\" must be a string.'","description":"Error when a manifest `modes` or `merge` value is not a string."},"MANIFEST_PROVIDER_FILE_NOT_FOUND":{"value":"'Provider \"%s\": %s not found at \"%s\".'","description":"Error when a provider file does not exist."},"MANIFEST_PROVIDER_FILE_NOT_OBJECT":{"value":"'Provider \"%s\": %s \"%s\" must decode to an object.'","description":"Error when a provider file does not decode to a JSON object."},"MANIFEST_PROVIDER_FILE_UNREADABLE":{"value":"'Provider \"%s\": could not read %s \"%s\".'","description":"Error when a provider file cannot be read."},"MANIFEST_REFERENCE_EMPTY":{"value":"'Provider \"%s\": \"manifest\" must be a non-empty string.'","description":"Error when the provider `manifest` reference is not a non-empty string."},"MANIFEST_REFERENCE_NOT_RELATIVE":{"value":"'Provider \"%s\": \"manifest\" must be a relative path inside the provider ' . 'root.'","description":"Error when the provider `manifest` reference points outside the provider root."},"MODE_COPY_FAILED":{"value":"'Could not copy \"%s\" to \"%s\".'","description":"Error when a source file cannot be copied to its destination."},"MODE_DESTINATION_UNREADABLE":{"value":"'Could not read destination file \"%s\".'","description":"Error when the destination file cannot be read."},"MODE_SOURCE_UNREADABLE":{"value":"'Could not read source file \"%s\".'","description":"Error when the source file cannot be read."},"MODE_WRITE_FAILED":{"value":"'Could not write to \"%s\".'","description":"Error when the destination file cannot be written."},"PACKAGE_NOT_ALLOWED":{"value":"'Package \"%s\" is not authorized to scaffold files. Add it to ' . 'extra.scaffold.allowed-packages.'","description":"Error when a package is not in the scaffold allowlist."},"PATH_ABSOLUTE":{"value":"'Absolute path is not allowed in %s: \"%s\".'","description":"Error when a path is absolute."},"PATH_DIRECTORY_CREATE_FAILED":{"value":"'Could not create directory \"%s\".'","description":"Error when a directory cannot be created."},"PATH_PROJECT_ROOT_INACCESSIBLE":{"value":"'Project root does not exist or is not accessible: \"%s\".'","description":"Error when the project root does not exist or is not accessible."},"PATH_PROVIDER_ROOT_INACCESSIBLE":{"value":"'Provider root does not exist or is not accessible: \"%s\".'","description":"Error when the provider root does not exist or is not accessible."},"PATH_RESERVED":{"value":"'Destination \"%s\" is reserved for the scaffold lock file.'","description":"Error when a destination addresses the scaffold lock file."},"PATH_SYMLINK_ESCAPE":{"value":"'%s path escapes the root via symlink: \"%s\".'","description":"Error when a path escapes its root through a symlink."},"PATH_SYMLINK_UNRESOLVABLE":{"value":"'%s path is a symlink that cannot be resolved: \"%s\".'","description":"Error when a symlink in a path cannot be resolved."},"PATH_TRAVERSAL":{"value":"'Path traversal detected in %s: \"%s\".'","description":"Error when a path contains traversal segments."},"PROVIDER_INSTALL_PATH_MISSING":{"value":"'Provider \"%s\" has no install path.'","description":"Error when a resolved provider has no install path."},"REGEX_FAILED":{"value":"'Regular expression failed: %s.'","description":"Error when a PCRE function fails."},"SCAFFOLD_ABORTED":{"value":"'[scaffold] Scaffolding aborted: %s'","description":"Error when the scaffold workflow aborts on an unexpected failure."},"SCAFFOLD_FILES_FAILED":{"value":"'[scaffold] %d %s while scaffolding; see the messages above.'","description":"Error when one or more files fail while scaffolding."},"SCAFFOLD_FRAGMENT_FAILED_FILE":{"value":"'file failed'","description":"Fragment that names a single failed file."},"SCAFFOLD_FRAGMENT_FAILED_FILES":{"value":"'files failed'","description":"Fragment that names several failed files."},"SCAFFOLD_MANIFEST_LOAD_FAILED":{"value":"'[scaffold] Failed to load manifest for \"%s\": %s'","description":"Error when a provider manifest cannot be loaded."},"SERVICE_CURRENT_FILE_UNREADABLE":{"value":"'Could not read current file \"%s\".'","description":"Error when the current project file cannot be read."},"SERVICE_STATUS_ENCODE_FAILED":{"value":"'Could not encode the status report: %s.'","description":"Error when the status report cannot be encoded as JSON."},"SERVICE_STUB_NOT_FOUND":{"value":"'Stub not found: \"%s\".'","description":"Error when a provider stub does not exist."},"SERVICE_STUB_UNREADABLE":{"value":"'Could not read stub \"%s\".'","description":"Error when a provider stub cannot be read."}}},"PHPForge\\Scaffold\\Exception\\ScaffoldException":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/exception/scaffoldexception/","summary":"Represents a scaffold failure that must fail the Composer command or the console command that triggered it.","extends":"RuntimeException"},"PHPForge\\Scaffold\\Filesystem":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/filesystem/","summary":"Runs native filesystem calls and turns the PHP warning of a failed call into a `RuntimeException`.","methods":{"copy":{"signature":"public static function copy(string $source, string $destination, string $failure): void","summary":"Copies a file, overwriting the destination.","params":[{"name":"$source","type":"string","description":"Absolute path to the source file."},{"name":"$destination","type":"string","description":"Absolute path to the destination file."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the file cannot be copied."}],"static":true},"copyPermissions":{"signature":"public static function copyPermissions(string $source, string $destination, string $failure): void","summary":"Copies the permission bits of a file, masked by the current `umask`, onto another file.","params":[{"name":"$source","type":"string","description":"Absolute path to the file whose permissions are copied."},{"name":"$destination","type":"string","description":"Absolute path to the file that receives the permissions."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the permissions cannot be read or set."}],"static":true},"hash":{"signature":"public static function hash(string $path, string $failure): string","summary":"Returns the hexadecimal SHA-256 hash of a file.","params":[{"name":"$path","type":"string","description":"Absolute path to the file."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"string","description":"Hexadecimal SHA-256 hash of the file content."},"throws":[{"type":"RuntimeException","description":"when the file cannot be read."}],"static":true},"isEmptyDirectory":{"signature":"public static function isEmptyDirectory(string $directory, string $failure): bool","summary":"Returns whether a directory holds no entry.","params":[{"name":"$directory","type":"string","description":"Absolute path to the directory."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"bool","description":"`true` when the directory has no entry besides `.` and `..`, `false` otherwise."},"throws":[{"type":"RuntimeException","description":"when the directory cannot be read."}],"static":true},"mkdir":{"signature":"public static function mkdir(string $directory, string $failure): void","summary":"Creates a directory and its missing parents.","params":[{"name":"$directory","type":"string","description":"Absolute path to the directory."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the directory cannot be created."}],"static":true},"read":{"signature":"public static function read(string $path, string $failure): string","summary":"Returns the content of a file.","params":[{"name":"$path","type":"string","description":"Absolute path to the file."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"string","description":"Content of the file."},"throws":[{"type":"RuntimeException","description":"when the file cannot be read."}],"static":true},"readLink":{"signature":"public static function readLink(string $path, string $failure): string","summary":"Returns the target of a symbolic link.","params":[{"name":"$path","type":"string","description":"Absolute path to the symbolic link."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"string","description":"Target of the link, as stored in the link."},"throws":[{"type":"RuntimeException","description":"when the link cannot be read."}],"static":true},"remove":{"signature":"public static function remove(string $path, string $failure): void","summary":"Deletes a file.","params":[{"name":"$path","type":"string","description":"Absolute path to the file."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the file cannot be deleted."}],"static":true},"removeDirectory":{"signature":"public static function removeDirectory(string $directory, string $failure): void","summary":"Removes an empty directory.","params":[{"name":"$directory","type":"string","description":"Absolute path to the directory."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the directory cannot be removed."}],"static":true},"write":{"signature":"public static function write(string $path, string $content, string $failure): void","summary":"Writes content to a file, creating or truncating it.","params":[{"name":"$path","type":"string","description":"Absolute path to the file."},{"name":"$content","type":"string","description":"Content to write."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the file cannot be written."}],"static":true},"writeAtomic":{"signature":"public static function writeAtomic(string $path, string $content, string $failure): void","summary":"Writes content to a temporary file next to `$path` and renames it over `$path`, removing the temporary file when the rename fails.","params":[{"name":"$path","type":"string","description":"Absolute path to the file."},{"name":"$content","type":"string","description":"Content to write."},{"name":"$failure","type":"string","description":"Message of the exception thrown on failure, before the PHP warning."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the temporary file cannot be written, renamed or removed."}],"static":true}}},"PHPForge\\Scaffold\\Manifest\\DefaultExcludes":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/manifest/defaultexcludes/","summary":"Lists the provider meta-files that `PHPForge\\Scaffold\\Manifest\\ManifestExpander` skips when it walks a `copy[]` directory; explicit file entries in `copy[]` bypass these patterns.","constants":{"PATTERNS":{"value":"['composer.json', 'composer.lock', 'vendor/**', '.git', '.git/**', '.github/**', '.gitattributes', '.gitignore', 'tests/**', 'phpunit.xml', 'phpunit.xml.dist', '.phpunit.cache/**', 'phpunit.cache/**', 'phpstan.neon', 'phpstan.neon.dist', 'phpstan.cache/**', '.editorconfig', '.php-cs-fixer.php', '.php-cs-fixer.dist.php', 'ecs.php', 'psalm.xml', 'psalm.xml.dist', 'infection.json5', 'infection.json', 'infection.log', '.infection/**', 'README.md', 'CHANGELOG.md', 'LICENSE', 'docs/**', 'scaffold.json', 'scaffold-lock.json', 'runtime/**', 'node_modules/**', '.idea/**', '.DS_Store']"}}},"PHPForge\\Scaffold\\Manifest\\FileMapping":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/manifest/filemapping/","summary":"Represents one provider file to apply: its source, destination, write mode and merge strategy.","properties":{"destination":{"type":"string","description":"Destination path relative to the project root, using forward slashes.","readonly":true,"promoted":true},"mergeStrategy":{"type":"PHPForge\\Scaffold\\Merge\\MergeStrategyKind|null","default":"null","description":"Merge strategy declared by the manifest `merge` map for the `append` mode, or `null` to resolve it from the destination basename.","readonly":true,"promoted":true},"mode":{"type":"PHPForge\\Scaffold\\Manifest\\FileMode","description":"Write mode applied to the destination.","readonly":true,"promoted":true},"providerName":{"type":"string","description":"Composer package name of the provider.","readonly":true,"promoted":true},"providerPath":{"type":"string","description":"Absolute path to the provider root on disk.","readonly":true,"promoted":true},"source":{"type":"string","description":"Source path relative to the provider root, using forward slashes.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(string $destination, string $source, PHPForge\\Scaffold\\Manifest\\FileMode $mode, string $providerName, string $providerPath, PHPForge\\Scaffold\\Merge\\MergeStrategyKind|null $mergeStrategy = null)","summary":"Creates a provider file mapping.","params":[{"name":"$destination","type":"string","description":"Destination path relative to the project root, using forward slashes."},{"name":"$source","type":"string","description":"Source path relative to the provider root, using forward slashes."},{"name":"$mode","type":"PHPForge\\Scaffold\\Manifest\\FileMode","description":"Write mode applied to the destination."},{"name":"$providerName","type":"string","description":"Composer package name of the provider."},{"name":"$providerPath","type":"string","description":"Absolute path to the provider root on disk."},{"name":"$mergeStrategy","type":"PHPForge\\Scaffold\\Merge\\MergeStrategyKind|null","default":"null","optional":true,"description":"Merge strategy declared by the manifest `merge` map for the `append` mode, or `null` to resolve it from the destination basename."}]}}},"PHPForge\\Scaffold\\Manifest\\FileMode":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/manifest/filemode/","summary":"Represents the write modes that a provider manifest assigns to destinations.","backingType":"string","cases":{"Append":{"value":"'append'","description":"Merges the provider entries missing from the destination on every run, creating the destination when missing."},"Prepend":{"value":"'prepend'","description":"Prepends the provider block on every run unless the destination already contains it."},"Preserve":{"value":"'preserve'","description":"Writes the destination only when it is missing; only `reapply --force` overwrites an existing file."},"Replace":{"value":"'replace'","description":"Overwrites the destination unless it changed since its recorded hash or was adopted from an existing file."}}},"PHPForge\\Scaffold\\Manifest\\Glob":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/manifest/glob/","summary":"Matches forward-slash paths against manifest glob patterns: `*` and `?` within one path segment, `**` across segments, single-level `{a,b}` alternatives, and byte-exact literals for everything else.","methods":{"lookup":{"signature":"public static function lookup(array<array-key, PHPForge\\Scaffold\\Manifest\\TValue> $map, string $path): PHPForge\\Scaffold\\Manifest\\TValue|null","summary":"Returns the value of the first key of `$map` that matches `$path`; an exact key wins over globs, which match in declaration order.","params":[{"name":"$map","type":"array<array-key, PHPForge\\Scaffold\\Manifest\\TValue>","description":"Values keyed by glob pattern; integer-like patterns are integer keys."},{"name":"$path","type":"string","description":"Relative path with forward slashes."}],"return":{"type":"PHPForge\\Scaffold\\Manifest\\TValue|null","description":"Value of the matching pattern, or `null` when no pattern matches."},"static":true},"matches":{"signature":"public static function matches(string $pattern, string $path): bool","summary":"Returns whether `$pattern` matches the whole of `$path`.","params":[{"name":"$pattern","type":"string","description":"Glob pattern to match against."},{"name":"$path","type":"string","description":"Relative path with forward slashes; this method does not convert backslashes."}],"return":{"type":"bool","description":"`true` when the pattern matches the full path, `false` otherwise."},"static":true},"matchesAny":{"signature":"public static function matchesAny(list<string> $patterns, string $path): bool","summary":"Returns whether any of `$patterns` matches the whole of `$path`.","params":[{"name":"$patterns","type":"list<string>","description":"Glob patterns."},{"name":"$path","type":"string","description":"Relative path with forward slashes."}],"return":{"type":"bool","description":"`true` when at least one pattern matches the path, `false` otherwise."},"static":true},"prunes":{"signature":"public static function prunes(list<string> $patterns, string $directory): bool","summary":"Returns whether a `<dir>/**` pattern of `$patterns` excludes every descendant of `$directory`, so a walk can skip it.","params":[{"name":"$patterns","type":"list<string>","description":"Glob patterns."},{"name":"$directory","type":"string","description":"Relative directory path with forward slashes."}],"return":{"type":"bool","description":"`true` when `$patterns` holds `<directory>/**`, `false` otherwise."},"static":true},"toRegex":{"signature":"public static function toRegex(string $pattern): string","summary":"Converts a glob pattern into an anchored PCRE regex, for example `#^config/[^/]*\\.php$#` for `config/*.php`.","params":[{"name":"$pattern","type":"string","description":"Glob pattern to convert."}],"return":{"type":"string","description":"PCRE regex with the `#` delimiter, anchored to match the full string."},"static":true}}},"PHPForge\\Scaffold\\Manifest\\ManifestExpander":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/manifest/manifestexpander/","summary":"Expands a validated manifest into file mappings; a later `copy[]` entry overrides an earlier one per destination.","methods":{"expand":{"signature":"public function expand(PHPForge\\Scaffold\\Manifest\\ValidatedManifest $manifest, string $providerPath, string $providerName): list<PHPForge\\Scaffold\\Manifest\\FileMapping>","summary":"Expands a validated manifest into the list of file mappings that the scaffolder must apply.","params":[{"name":"$manifest","type":"PHPForge\\Scaffold\\Manifest\\ValidatedManifest","description":"Validated manifest as returned by `PHPForge\\Scaffold\\Manifest\\ManifestSchema::validate()`."},{"name":"$providerPath","type":"string","description":"Absolute path to the provider root on disk."},{"name":"$providerName","type":"string","description":"Composer package name (used to attribute the mapping for provenance)."}],"return":{"type":"list<PHPForge\\Scaffold\\Manifest\\FileMapping>","description":"Concrete list of mappings, ready for the scaffolder."},"throws":[{"type":"RuntimeException","description":"when a path listed in `copy[]` does not exist on disk."}]}}},"PHPForge\\Scaffold\\Manifest\\ManifestLoader":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/manifest/manifestloader/","summary":"Loads a provider manifest, inline in `extra.scaffold` or in the provider file named by `extra.scaffold.manifest`, and expands it into file mappings.","methods":{"__construct":{"signature":"public function __construct(PHPForge\\Scaffold\\Manifest\\ManifestSchema $schema, PHPForge\\Scaffold\\Manifest\\ManifestExpander $expander)","summary":"Creates a loader with its schema validator and mapping expander.","params":[{"name":"$schema","type":"PHPForge\\Scaffold\\Manifest\\ManifestSchema","description":"Validates the manifest."},{"name":"$expander","type":"PHPForge\\Scaffold\\Manifest\\ManifestExpander","description":"Expands the validated manifest into file mappings."}]},"loadFromExtra":{"signature":"public function loadFromExtra(mixed[] $extra, string $packageName, string $packagePath): list<PHPForge\\Scaffold\\Manifest\\FileMapping>","summary":"Loads the provider manifest from the `extra` section of a provider package and expands it into file mappings, without Composer's package classes.","params":[{"name":"$extra","type":"mixed[]","description":"`extra` section of the provider package."},{"name":"$packageName","type":"string","description":"Composer package name of the provider."},{"name":"$packagePath","type":"string","description":"Absolute path to the provider root."}],"return":{"type":"list<PHPForge\\Scaffold\\Manifest\\FileMapping>","description":"File mappings; empty when `$extra` declares no `scaffold` object."},"throws":[{"type":"RuntimeException","description":"when the manifest file is missing or unreadable, the manifest is invalid, or a `copy[]` path does not exist."},{"type":"JsonException","description":"when the external manifest file is not valid JSON."}]},"loadFromPath":{"signature":"public function loadFromPath(string $packageName, string $packagePath): list<PHPForge\\Scaffold\\Manifest\\FileMapping>","summary":"Loads the provider manifest from the `composer.json` at the provider root and expands it into file mappings, exactly like `PHPForge\\Scaffold\\Manifest\\ManifestLoader::loadFromExtra()`.","params":[{"name":"$packageName","type":"string","description":"Composer package name of the provider."},{"name":"$packagePath","type":"string","description":"Absolute path to the provider root."}],"return":{"type":"list<PHPForge\\Scaffold\\Manifest\\FileMapping>","description":"File mappings; empty when the package declares no `extra.scaffold` object."},"throws":[{"type":"RuntimeException","description":"when the provider `composer.json` or the manifest file is missing, unreadable or invalid, or a `copy[]` path does not exist."},{"type":"JsonException","description":"when the provider `composer.json` or the external manifest file is not valid JSON."}]}}},"PHPForge\\Scaffold\\Manifest\\ManifestSchema":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/manifest/manifestschema/","summary":"Validates a provider manifest and normalises it into typed `copy`, `exclude`, `modes` and `merge` entries.","methods":{"validate":{"signature":"public function validate(mixed[] $raw, bool $inline = false): array{copy: list<array{from: string, to: string}>, exclude: list<string>, modes: array<array-key, PHPForge\\Scaffold\\Manifest\\FileMode>, merge: array<array-key, PHPForge\\Scaffold\\Merge\\MergeStrategyKind>}","summary":"Validates a raw decoded manifest array and returns the typed structure.","params":[{"name":"$raw","type":"mixed[]","description":"Decoded JSON content of the manifest (or the inline `extra.scaffold` array)."},{"name":"$inline","type":"bool","default":"false","optional":true,"description":"`true` when `$raw` is the inline `extra.scaffold` block, which may also carry the consumer-side keys `manifest`, `allowed-packages` and `auto`."}],"return":{"type":"array{copy: list<array{from: string, to: string}>, exclude: list<string>, modes: array<array-key, PHPForge\\Scaffold\\Manifest\\FileMode>, merge: array<array-key, PHPForge\\Scaffold\\Merge\\MergeStrategyKind>}","description":"Typed manifest with `copy[]` entries normalised to `{from, to}` form, `modes` values resolved to `PHPForge\\Scaffold\\Manifest\\FileMode` cases and `merge` values resolved to `PHPForge\\Scaffold\\Merge\\MergeStrategyKind` cases."},"throws":[{"type":"RuntimeException","description":"when the manifest structure is invalid or contains an unknown key."}]}}},"PHPForge\\Scaffold\\Merge\\AbstractLineMergeStrategy":{"kind":"class","modifiers":["abstract"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/abstractlinemergestrategy/","summary":"Provides the merge pipeline shared by the line-oriented strategies.","implements":["PHPForge\\Scaffold\\Merge\\MergeStrategy"],"methods":{"merge":{"signature":"public function merge(string $provider, string $consumer): PHPForge\\Scaffold\\Merge\\MergeResult","summary":"Adds the provider entries missing from the consumer.","params":[{"name":"$provider","type":"string","description":"Provider content whose missing entries are added."},{"name":"$consumer","type":"string","description":"Consumer content; an empty string stands for an absent file."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergeResult","description":"Merged content and whether it differs from the consumer."}},"plan":{"signature":"abstract protected function plan(list<string> $provider, list<string> $consumer): PHPForge\\Scaffold\\Merge\\MergePlan","summary":"Computes the insertions that make the consumer satisfy the provider.","params":[{"name":"$provider","type":"list<string>","description":"Provider lines."},{"name":"$consumer","type":"list<string>","description":"Consumer lines without terminators."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergePlan","description":"Lines to insert after a consumer line index (`-1` inserts at the top) and blocks to append at the end; both empty when the consumer already satisfies the provider."},"visibility":"protected","abstract":true}}},"PHPForge\\Scaffold\\Merge\\IniMergeStrategy":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/inimergestrategy/","summary":"Merges EditorConfig and INI files section by section; existing keys always keep the consumer value.","extends":"PHPForge\\Scaffold\\Merge\\AbstractLineMergeStrategy","implements":["PHPForge\\Scaffold\\Merge\\MergeStrategy"],"methods":{"plan":{"signature":"protected function plan(list<string> $provider, list<string> $consumer): PHPForge\\Scaffold\\Merge\\MergePlan","summary":"Plans missing preamble keys, missing keys inside existing sections and missing sections appended whole.","params":[{"name":"$provider","type":"list<string>","description":"Provider lines."},{"name":"$consumer","type":"list<string>","description":"Consumer lines without terminators."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergePlan","description":"Lines to insert after a consumer line index and blocks to append; both empty when satisfied."},"visibility":"protected"}},"inherited":{"methods":{"merge":"PHPForge\\Scaffold\\Merge\\AbstractLineMergeStrategy"}}},"PHPForge\\Scaffold\\Merge\\Lines":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/lines/","summary":"Splits, inspects and rebuilds text line by line while keeping the original end-of-line bytes.","methods":{"detectEol":{"signature":"public static function detectEol(string $content): string","summary":"Returns the dominant end-of-line sequence: `\"\\r\\n\"`, `\"\\r\"`, or `\"\\n\"` (also for content without one).","params":[{"name":"$content","type":"string","description":"Content to inspect."}],"return":{"type":"string","description":"`\"\\r\\n\"` when present, otherwise `\"\\r\"` when present, otherwise `\"\\n\"`."},"static":true},"endsWithEol":{"signature":"public static function endsWithEol(string $content): bool","summary":"Returns whether the content ends with an end-of-line sequence.","params":[{"name":"$content","type":"string","description":"Content to inspect."}],"return":{"type":"bool","description":"`true` when the content ends with `\"\\n\"` or `\"\\r\"`."},"static":true},"normalise":{"signature":"public static function normalise(string $content): string","summary":"Converts `\"\\r\\n\"` and `\"\\r\"` terminators to `\"\\n\"`.","params":[{"name":"$content","type":"string","description":"Content to normalise."}],"return":{"type":"string","description":"Content with `\"\\n\"` terminators only."},"static":true},"rebuild":{"signature":"public static function rebuild(list<array{string, string}> $segments, array<int, list<string>> $insertAfter, list<list<string>> $blocks, string $eol, bool $finalEol): string","summary":"Rebuilds consumer segments verbatim with inserted lines and appended blocks, each block after one blank line.","params":[{"name":"$segments","type":"list<array{string, string}>","description":"Consumer `[text, terminator]` segments."},{"name":"$insertAfter","type":"array<int, list<string>>","description":"Lines to insert after the segment with the given index; index `-1` inserts before the first segment."},{"name":"$blocks","type":"list<list<string>>","description":"Blocks of lines appended at the end, in order."},{"name":"$eol","type":"string","description":"End-of-line sequence used for inserted lines."},{"name":"$finalEol","type":"bool","description":"Whether the result must end with an end-of-line sequence."}],"return":{"type":"string","description":"Rebuilt content."},"static":true},"split":{"signature":"public static function split(string $content): list<string>","summary":"Splits content normalised to `\"\\n\"` into lines, ignoring the terminator of the last line.","params":[{"name":"$content","type":"string","description":"Content normalised to `\"\\n\"` terminators."}],"return":{"type":"list<string>","description":"Lines; empty for empty content."},"static":true},"splitRaw":{"signature":"public static function splitRaw(string $content): list<array{string, string}>","summary":"Splits raw content into lines that keep their original terminator.","params":[{"name":"$content","type":"string","description":"Content with any mix of `\"\\r\\n\"`, `\"\\r\"` and `\"\\n\"` terminators."}],"return":{"type":"list<array{string, string}>","description":"`[text, terminator]` pairs; the last terminator is empty when the content does not end with an end-of-line sequence."},"static":true}}},"PHPForge\\Scaffold\\Merge\\ListMergeStrategy":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/listmergestrategy/","summary":"Merges ignore-style list files (`.gitignore`, `.gitattributes` and similar) by entry, never by comment.","extends":"PHPForge\\Scaffold\\Merge\\AbstractLineMergeStrategy","implements":["PHPForge\\Scaffold\\Merge\\MergeStrategy"],"methods":{"plan":{"signature":"protected function plan(list<string> $provider, list<string> $consumer): PHPForge\\Scaffold\\Merge\\MergePlan","summary":"Plans missing entries under the consumer's matching comment header, or as new commented blocks at the end.","params":[{"name":"$provider","type":"list<string>","description":"Provider lines."},{"name":"$consumer","type":"list<string>","description":"Consumer lines without terminators."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergePlan","description":"Lines to insert after a consumer line index and blocks to append; both empty when satisfied."},"visibility":"protected"}},"inherited":{"methods":{"merge":"PHPForge\\Scaffold\\Merge\\AbstractLineMergeStrategy"}}},"PHPForge\\Scaffold\\Merge\\MergeResult":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/mergeresult/","summary":"Represents the outcome of a merge.","properties":{"changed":{"type":"bool","description":"Whether `$content` differs from the consumer content.","readonly":true,"promoted":true},"content":{"type":"string","description":"Merged content; byte-identical to the consumer when `$changed` is `false`.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(string $content, bool $changed)","summary":"Creates the result of a merge operation.","params":[{"name":"$content","type":"string","description":"Merged content; byte-identical to the consumer when `$changed` is `false`."},{"name":"$changed","type":"bool","description":"Whether `$content` differs from the consumer content."}]}}},"PHPForge\\Scaffold\\Merge\\MergeStrategy":{"kind":"interface","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/mergestrategy/","summary":"Merges provider content into consumer content without removing, reordering or overriding consumer content.","methods":{"merge":{"signature":"abstract public function merge(string $provider, string $consumer): PHPForge\\Scaffold\\Merge\\MergeResult","summary":"Adds the provider entries missing from the consumer.","params":[{"name":"$provider","type":"string","description":"Provider content whose missing entries are added."},{"name":"$consumer","type":"string","description":"Consumer content; an empty string stands for an absent file."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergeResult","description":"Merged content and whether it differs from the consumer."},"abstract":true}}},"PHPForge\\Scaffold\\Merge\\MergeStrategyKind":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/mergestrategykind/","summary":"Represents the merge strategies available to the `append` mode, as declared in a manifest `merge` map.","backingType":"string","cases":{"Ini":{"value":"'ini'","description":"Section-aware merge for EditorConfig and INI files (`PHPForge\\Scaffold\\Merge\\IniMergeStrategy`)."},"ListFile":{"value":"'list'","description":"Entry-based merge for ignore-style list files (`PHPForge\\Scaffold\\Merge\\ListMergeStrategy`)."},"Text":{"value":"'text'","description":"Line-based fallback merge that appends missing lines at the end (`PHPForge\\Scaffold\\Merge\\TextMergeStrategy`)."}}},"PHPForge\\Scaffold\\Merge\\StrategyResolver":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/strategyresolver/","summary":"Resolves the merge strategy of a destination from its kind, or from its basename with `text` as the fallback.","methods":{"for":{"signature":"public static function for(string $destination): PHPForge\\Scaffold\\Merge\\MergeStrategy","summary":"Returns the default strategy for a destination basename.","params":[{"name":"$destination","type":"string","description":"Destination path relative to the project root."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergeStrategy","description":"Strategy of the basename default kind."},"static":true},"forKind":{"signature":"public static function forKind(PHPForge\\Scaffold\\Merge\\MergeStrategyKind $kind): PHPForge\\Scaffold\\Merge\\MergeStrategy","summary":"Returns the strategy implementing a kind.","params":[{"name":"$kind","type":"PHPForge\\Scaffold\\Merge\\MergeStrategyKind","description":"Strategy kind."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergeStrategy","description":"New strategy instance for the kind."},"static":true}}},"PHPForge\\Scaffold\\Merge\\TextMergeStrategy":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/merge/textmergestrategy/","summary":"Merges plain text by appending the non-blank provider lines the consumer lacks, compared after right-trim.","extends":"PHPForge\\Scaffold\\Merge\\AbstractLineMergeStrategy","implements":["PHPForge\\Scaffold\\Merge\\MergeStrategy"],"methods":{"plan":{"signature":"protected function plan(list<string> $provider, list<string> $consumer): PHPForge\\Scaffold\\Merge\\MergePlan","summary":"Plans one block, appended at the end, with the missing provider lines in provider order.","params":[{"name":"$provider","type":"list<string>","description":"Provider lines."},{"name":"$consumer","type":"list<string>","description":"Consumer lines without terminators."}],"return":{"type":"PHPForge\\Scaffold\\Merge\\MergePlan","description":"No insertions, and one block of missing lines, or no block when the consumer has them all."},"visibility":"protected"}},"inherited":{"methods":{"merge":"PHPForge\\Scaffold\\Merge\\AbstractLineMergeStrategy"}}},"PHPForge\\Scaffold\\MessageTemplate":{"kind":"trait","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/messagetemplate/","summary":"Formats the `sprintf` template held by the backing value of a message enum case.","methods":{"getMessage":{"signature":"public function getMessage(int|string ...$argument): string","summary":"Returns the message template formatted with `$argument`.","params":[{"name":"$argument","type":"int|string","optional":true,"variadic":true,"description":"Values substituted into the template."}],"return":{"type":"string","description":"Formatted message."}},"plural":{"signature":"public static function plural(int $count, self $one, self $many): string","summary":"Returns the text of `$one` when `$count` is `1`, and the text of `$many` otherwise.","params":[{"name":"$count","type":"int","description":"Number of items the fragment counts."},{"name":"$one","type":"self","description":"Fragment for a single item."},{"name":"$many","type":"self","description":"Fragment for zero or several items."}],"return":{"type":"string","description":"Text of the fragment that agrees with `$count`."},"static":true}}},"PHPForge\\Scaffold\\Plugin":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/plugin/","summary":"Registers the `PHPForge\\Scaffold\\EventSubscriber` that scaffolds provider files after `composer install`, `composer update` and `composer create-project`.","implements":["Composer\\Plugin\\PluginInterface"],"methods":{"activate":{"signature":"public function activate(Composer\\Composer $composer, Composer\\IO\\IOInterface $io): void","summary":"Creates the event subscriber and registers it with Composer's event dispatcher.","params":[{"name":"$composer","type":"Composer\\Composer","description":"Composer instance whose event dispatcher receives the subscriber."},{"name":"$io","type":"Composer\\IO\\IOInterface","description":"Composer IO; unused."}],"return":{"type":"void"}},"deactivate":{"signature":"public function deactivate(Composer\\Composer $composer, Composer\\IO\\IOInterface $io): void","summary":"Removes the registered event subscriber from Composer's event dispatcher.","params":[{"name":"$composer","type":"Composer\\Composer","description":"Composer instance whose event dispatcher holds the subscriber."},{"name":"$io","type":"Composer\\IO\\IOInterface","description":"Composer IO; unused."}],"return":{"type":"void"}},"uninstall":{"signature":"public function uninstall(Composer\\Composer $composer, Composer\\IO\\IOInterface $io): void","summary":"Performs no cleanup; scaffolded files and `scaffold-lock.json` stay in the project.","params":[{"name":"$composer","type":"Composer\\Composer","description":"Composer instance; unused."},{"name":"$io","type":"Composer\\IO\\IOInterface","description":"Composer IO; unused."}],"return":{"type":"void"}}}},"PHPForge\\Scaffold\\Scaffold\\ExpectedState":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/expectedstate/","summary":"Represents the file mappings that the allowed and installed providers ship now, merged with the rule of `PHPForge\\Scaffold\\Scaffold\\ScaffoldRunner`.","properties":{"warnings":{"type":"list<string>","default":"[]","description":"Messages about provider roots and manifests, prefixed with `[scaffold]`.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(array<array-key, PHPForge\\Scaffold\\Manifest\\FileMapping> $mappings, list<string> $failedProviders = [], list<string> $warnings = [])","summary":"Creates an expected state from merged mappings and provider diagnostics.","params":[{"name":"$mappings","type":"array<array-key, PHPForge\\Scaffold\\Manifest\\FileMapping>","description":"Expected mappings keyed by destination."},{"name":"$failedProviders","type":"list<string>","default":"[]","optional":true,"description":"Allowed and installed providers whose manifest could not be loaded."},{"name":"$warnings","type":"list<string>","default":"[]","optional":true,"description":"Messages about provider roots and manifests, prefixed with `[scaffold]`."}]},"all":{"signature":"public function all(): array<array-key, PHPForge\\Scaffold\\Manifest\\FileMapping>","summary":"Returns every expected mapping keyed by destination, in `allowed-packages` and manifest order.","return":{"type":"array<array-key, PHPForge\\Scaffold\\Manifest\\FileMapping>","description":"Mappings keyed by destination; integer-like destinations (`\"123\"`) are integer keys."}},"build":{"signature":"public static function build(PHPForge\\Scaffold\\Config\\ProjectContext $context, array<string, mixed> $lockProviders, PHPForge\\Scaffold\\Manifest\\ManifestLoader $loader = new \\PHPForge\\Scaffold\\Manifest\\ManifestLoader(new \\PHPForge\\Scaffold\\Manifest\\ManifestSchema(), new \\PHPForge\\Scaffold\\Manifest\\ManifestExpander())): self","summary":"Loads the manifests of every allowed and installed provider, in `allowed-packages` order.","params":[{"name":"$context","type":"PHPForge\\Scaffold\\Config\\ProjectContext","description":"Project whose providers are loaded."},{"name":"$lockProviders","type":"array<string, mixed>","description":"`providers` map of `scaffold-lock.json`, used for recorded paths."},{"name":"$loader","type":"PHPForge\\Scaffold\\Manifest\\ManifestLoader","default":"new \\PHPForge\\Scaffold\\Manifest\\ManifestLoader(new \\PHPForge\\Scaffold\\Manifest\\ManifestSchema(), new \\PHPForge\\Scaffold\\Manifest\\ManifestExpander())","optional":true,"description":"Loads the provider manifests into file mappings."}],"return":{"type":"self","description":"Merged mappings, the providers whose manifest failed to load, and their warnings."},"static":true},"failedProviders":{"signature":"public function failedProviders(): list<string>","summary":"Returns the allowed and installed providers whose manifest could not be loaded.","return":{"type":"list<string>","description":"Provider names in `allowed-packages` order."}},"hasFailed":{"signature":"public function hasFailed(string $provider): bool","summary":"Returns whether the manifest of `$provider` could not be loaded.","params":[{"name":"$provider","type":"string","description":"Provider package name."}],"return":{"type":"bool","description":"`true` when the provider manifest failed to load, `false` otherwise."}},"mapping":{"signature":"public function mapping(string $destination): PHPForge\\Scaffold\\Manifest\\FileMapping|null","summary":"Returns the expected mapping of `$destination`, or `null` when no allowed and installed provider ships it.","params":[{"name":"$destination","type":"string","description":"Destination path relative to the project root."}],"return":{"type":"PHPForge\\Scaffold\\Manifest\\FileMapping|null","description":"Expected mapping, or `null` when no allowed and installed provider ships it."}},"orphanReport":{"signature":"public function orphanReport(array<array-key, array<array-key, mixed>> $files): list<string>","summary":"Returns the stderr lines that announce the orphans of `$files`: a header with the count and the `prune` hint, at most ten destinations with their provider, and the number of the others.","params":[{"name":"$files","type":"array<array-key, array<array-key, mixed>>","description":"`files` map of `scaffold-lock.json`."}],"return":{"type":"list<string>","description":"Lines prefixed with `[scaffold]`; empty when there is no orphan."}},"orphans":{"signature":"public function orphans(array<array-key, PHPForge\\Scaffold\\Scaffold\\TEntry> $files): array<array-key, PHPForge\\Scaffold\\Scaffold\\TEntry>","summary":"Returns the lock entries that no allowed and installed provider ships anymore; ejected entries and entries of a provider whose manifest could not be loaded are never orphans.","params":[{"name":"$files","type":"array<array-key, PHPForge\\Scaffold\\Scaffold\\TEntry>","description":"`files` map of `scaffold-lock.json`."}],"return":{"type":"array<array-key, PHPForge\\Scaffold\\Scaffold\\TEntry>","description":"Orphan entries keyed by destination, in lock order; integer-like destinations (`\"123\"`) are integer keys."}}}},"PHPForge\\Scaffold\\Scaffold\\FileApplier":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/fileapplier/","summary":"Applies a single file mapping after checking that its provider is in `allowed-packages` and validating its source and destination, reporting mode warnings through an `PHPForge\\Scaffold\\Console\\OutputWriter`.","methods":{"__construct":{"signature":"public function __construct(PHPForge\\Scaffold\\Config\\ProjectConfig $config, PHPForge\\Scaffold\\Security\\PathValidator $pathValidator, PHPForge\\Scaffold\\Console\\OutputWriter $out)","summary":"Creates an applier for validated provider mappings.","params":[{"name":"$config","type":"PHPForge\\Scaffold\\Config\\ProjectConfig","description":"Consumer settings that list the providers allowed to write files."},{"name":"$pathValidator","type":"PHPForge\\Scaffold\\Security\\PathValidator","description":"Validates destinations and sources."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink that receives mode warnings on stderr."}]},"apply":{"signature":"public function apply(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, string $projectRoot, PHPForge\\Scaffold\\Scaffold\\Modes\\ModeInterface $mode, string|null $hashAtScaffold): PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","summary":"Validates a file mapping and applies it with `$mode` against the canonical project and provider roots, writing the mode warning to stderr.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"File mapping to apply."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$mode","type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ModeInterface","description":"Write mode that applies the mapping."},{"name":"$hashAtScaffold","type":"string|null","description":"Hash recorded in the lock file, or `null` when the destination is untracked."}],"return":{"type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","description":"Outcome, destination hash and optional warning returned by the mode."},"throws":[{"type":"RuntimeException","description":"when the provider is not allowed, a path fails validation, or the mode cannot read, write or hash a file."}]}}},"PHPForge\\Scaffold\\Scaffold\\Lock\\Hasher":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/lock/hasher/","summary":"Computes the `sha256:<hex>` hashes that `scaffold-lock.json` records for scaffolded files.","methods":{"hash":{"signature":"public static function hash(string $absolutePath): string","summary":"Returns a `sha256:<hex>` hash of the file at the given path.","params":[{"name":"$absolutePath","type":"string","description":"Absolute path to the file."}],"return":{"type":"string","description":"Hash in the format `sha256:<hex>`."},"throws":[{"type":"RuntimeException","description":"when the file cannot be read."}],"static":true}}},"PHPForge\\Scaffold\\Scaffold\\Lock\\LockFile":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/lock/lockfile/","summary":"Reads and writes `scaffold-lock.json`, which records the provider and hashes of every scaffolded file.","methods":{"__construct":{"signature":"public function __construct(string $projectRoot)","summary":"Creates a lock-file store for a project.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root that holds `scaffold-lock.json`."}]},"exists":{"signature":"public function exists(): bool","summary":"Returns `true` when `scaffold-lock.json` exists on disk.","return":{"type":"bool","description":"`true` when the lock file exists, `false` otherwise."}},"getPath":{"signature":"public function getPath(): string","summary":"Returns the absolute path to `scaffold-lock.json`.","return":{"type":"string","description":"Absolute path to the lock file under the project root."}},"read":{"signature":"public function read(): array{providers: array<string, mixed>, files: array<array-key, PHPForge\\Scaffold\\Scaffold\\Lock\\LockEntry>}","summary":"Reads and returns the lock data, or a default empty structure when the file does not exist.","return":{"type":"array{providers: array<string, mixed>, files: array<array-key, PHPForge\\Scaffold\\Scaffold\\Lock\\LockEntry>}","description":"Lock data; integer-like destinations (`\"123\"`) come back as integer `files` keys."},"throws":[{"type":"RuntimeException","description":"when the file exists but cannot be read or decoded as a JSON object; the message names the file and the JSON error, and reports Git conflict markers when present."}]},"write":{"signature":"public function write(array<string, mixed> $data): void","summary":"Writes lock data atomically with `providers` and `files` as objects sorted by key, carrying over unknown top-level keys and the unknown keys of entries still present in `$data`.","params":[{"name":"$data","type":"array<string, mixed>","description":"Lock data to persist."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the data cannot be encoded, the existing lock cannot be read, or the file cannot be written."}]}}},"PHPForge\\Scaffold\\Scaffold\\MappingMerger":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/mappingmerger/","summary":"Merges provider file mappings by destination; a later provider overrides an earlier one for the same destination.","methods":{"merge":{"signature":"public static function merge(array<array-key, PHPForge\\Scaffold\\Manifest\\FileMapping> &$merged, list<PHPForge\\Scaffold\\Manifest\\FileMapping> $mappings): list<array{PHPForge\\Scaffold\\Manifest\\FileMapping, PHPForge\\Scaffold\\Manifest\\FileMapping}>","summary":"Adds `$mappings` to `$merged`, replacing the mapping already recorded for the same destination.","params":[{"name":"$merged","type":"array<array-key, PHPForge\\Scaffold\\Manifest\\FileMapping>","byReference":true,"description":"Mappings keyed by destination, updated in place; integer-like destinations (`\"123\"`) become integer keys."},{"name":"$mappings","type":"list<PHPForge\\Scaffold\\Manifest\\FileMapping>","description":"Mappings of the next provider, in manifest order."}],"return":{"type":"list<array{PHPForge\\Scaffold\\Manifest\\FileMapping, PHPForge\\Scaffold\\Manifest\\FileMapping}>","description":"Overrides across providers, as pairs of the new mapping and the mapping it replaced."},"static":true}}},"PHPForge\\Scaffold\\Scaffold\\Modes\\AppendMode":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/modes/appendmode/","summary":"Applies a file by merging the provider entries that the destination lacks, or by writing the source when the destination is missing.","implements":["PHPForge\\Scaffold\\Scaffold\\Modes\\ModeInterface"],"methods":{"apply":{"signature":"public function apply(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, string $projectRoot, string|null $hashAtScaffold): PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","summary":"Merges the source into the destination with the mapping's merge strategy, or the default strategy for the destination name, and writes only when the content changes.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"File mapping to apply."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$hashAtScaffold","type":"string|null","description":"Hash recorded in the lock file, or `null` when the destination is untracked; this mode ignores it."}],"return":{"type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","description":"`Written` with the new hash when the destination is missing or the merge changes it, `Skipped` with the current hash otherwise."},"throws":[{"type":"RuntimeException","description":"when a file cannot be read, written or hashed, or a directory cannot be created."}]}}},"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyOutcome":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/modes/applyoutcome/","summary":"Represents the outcome of applying a file mapping.","cases":{"Skipped":{"description":"The destination was left unchanged."},"Written":{"description":"The destination was created or rewritten."}}},"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/modes/applyresult/","summary":"Represents the result of applying a file mapping: its outcome, the destination hash and an optional warning.","properties":{"newHash":{"type":"string","description":"Hash of the destination after the operation, or an empty string when a user-modified destination was skipped.","readonly":true,"promoted":true},"outcome":{"type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyOutcome","description":"Whether the destination was written or left unchanged.","readonly":true,"promoted":true},"warning":{"type":"string|null","description":"Message for the user, or `null` when there is nothing to report.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyOutcome $outcome, string $newHash, string|null $warning)","summary":"Creates the result of applying a file mapping.","params":[{"name":"$outcome","type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyOutcome","description":"Whether the destination was written or left unchanged."},{"name":"$newHash","type":"string","description":"Hash of the destination after the operation, or an empty string when a user-modified destination was skipped."},{"name":"$warning","type":"string|null","description":"Message for the user, or `null` when there is nothing to report."}]}}},"PHPForge\\Scaffold\\Scaffold\\Modes\\ModeInterface":{"kind":"interface","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/modes/modeinterface/","summary":"Defines how a write mode applies a file mapping to the project.","methods":{"apply":{"signature":"abstract public function apply(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, string $projectRoot, string|null $hashAtScaffold): PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","summary":"Applies a file mapping to the project and returns the outcome, the destination hash and an optional warning.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"File mapping to apply."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$hashAtScaffold","type":"string|null","description":"Hash recorded in the lock file, or `null` when the destination is untracked."}],"return":{"type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","description":"Outcome, destination hash and optional warning of the operation."},"throws":[{"type":"RuntimeException","description":"when a file cannot be read, written or hashed, or a directory cannot be created."}],"abstract":true}}},"PHPForge\\Scaffold\\Scaffold\\Modes\\PrependMode":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/modes/prependmode/","summary":"Applies a file by prepending the source block unless the destination already contains it.","implements":["PHPForge\\Scaffold\\Scaffold\\Modes\\ModeInterface"],"methods":{"apply":{"signature":"public function apply(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, string $projectRoot, string|null $hashAtScaffold): PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","summary":"Prepends the source block, terminated with the destination end-of-line sequence, when the destination lacks it as a contiguous run of lines.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"File mapping to apply."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$hashAtScaffold","type":"string|null","description":"Hash recorded in the lock file, or `null` when the destination is untracked; this mode ignores it."}],"return":{"type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","description":"`Written` with the new hash when the block is prepended, `Skipped` with the current hash when the destination already contains it."},"throws":[{"type":"RuntimeException","description":"when a file cannot be read, written or hashed, or a directory cannot be created."}]},"prepend":{"signature":"public static function prepend(string $source, string|null $existing): string|null","summary":"Returns the destination content after prepending the source block, terminated with the destination end-of-line sequence, or `null` when the destination already contains the block as a contiguous run of lines.","params":[{"name":"$source","type":"string","description":"Provider content."},{"name":"$existing","type":"string|null","description":"Destination content, or `null` when the destination does not exist."}],"return":{"type":"string|null","description":"Content to write, or `null` when the destination already contains the block."},"static":true}}},"PHPForge\\Scaffold\\Scaffold\\Modes\\PreserveMode":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/modes/preservemode/","summary":"Applies a file only when the destination does not exist.","implements":["PHPForge\\Scaffold\\Scaffold\\Modes\\ModeInterface"],"methods":{"apply":{"signature":"public function apply(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, string $projectRoot, string|null $hashAtScaffold): PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","summary":"Copies the source when the destination is missing; otherwise returns `Skipped` with the current hash.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"File mapping to apply."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$hashAtScaffold","type":"string|null","description":"Hash recorded in the lock file, or `null` when the destination is untracked; this mode ignores it."}],"return":{"type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","description":"`Written` with the new hash and any permission warning when the destination is missing, `Skipped` with the current hash otherwise."},"throws":[{"type":"RuntimeException","description":"when a file cannot be read, written or hashed, or a directory cannot be created."}]}}},"PHPForge\\Scaffold\\Scaffold\\Modes\\ReplaceMode":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/modes/replacemode/","summary":"Applies a file by overwriting the destination unless it changed since its recorded hash.","implements":["PHPForge\\Scaffold\\Scaffold\\Modes\\ModeInterface"],"methods":{"apply":{"signature":"public function apply(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, string $projectRoot, string|null $hashAtScaffold): PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","summary":"Copies the source over the destination, skipping a destination whose hash differs from the recorded one and warning when it overwrites an untracked destination with different content.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"File mapping to apply."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$hashAtScaffold","type":"string|null","description":"Hash recorded in the lock file, or `null` when the destination is untracked."}],"return":{"type":"PHPForge\\Scaffold\\Scaffold\\Modes\\ApplyResult","description":"`Written` with the new hash and any warning, or `Skipped` with an empty hash and a warning when the destination is user-modified."},"throws":[{"type":"RuntimeException","description":"when a file cannot be read, written or hashed, or a directory cannot be created."}]}}},"PHPForge\\Scaffold\\Scaffold\\PathResolver":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/pathresolver/","summary":"Resolves absolute scaffold paths from roots and relative segments that callers have already validated with `PHPForge\\Scaffold\\Security\\PathValidator`.","methods":{"destination":{"signature":"public static function destination(string $projectRoot, string $destination): string","summary":"Joins a project root with a relative destination path using the platform separator.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root directory."},{"name":"$destination","type":"string","description":"Relative path to a destination file or directory inside the project, using forward slashes as separators."}],"return":{"type":"string","description":"Absolute path to the destination file or directory inside the project, with platform separators."},"static":true},"ensureDirectory":{"signature":"public static function ensureDirectory(string $absoluteFilePath): void","summary":"Creates the parent directory for the given absolute file path when it does not exist.","params":[{"name":"$absoluteFilePath","type":"string","description":"Absolute path to the file whose parent directory is created."}],"return":{"type":"void"},"throws":[{"type":"RuntimeException","description":"when the directory cannot be created."}],"static":true},"realpathOrFallback":{"signature":"public static function realpathOrFallback(string $path): string","summary":"Returns the canonical absolute path of `$path`, falling back to a trimmed copy when `realpath()` fails.","params":[{"name":"$path","type":"string","description":"Absolute or relative path to resolve."}],"return":{"type":"string","description":"Canonical absolute path or trimmed fallback."},"static":true},"resolveProviderRoot":{"signature":"public static function resolveProviderRoot(string $vendorDir, string $providerName, mixed $providerLock, string $projectRoot = ''): array{root: string, warning: string|null}","summary":"Resolves the absolute root of a provider from its lock-recorded path when that path, relative or absolute, stays inside the vendor directory, falling back to `<vendorDir>/<providerName>`.","params":[{"name":"$vendorDir","type":"string","description":"Absolute path to the Composer vendor directory."},{"name":"$providerName","type":"string","description":"Composer package name of the provider, used for the fallback root."},{"name":"$providerLock","type":"mixed","description":"Decoded `providers.<name>` entry of `scaffold-lock.json`, or `null` when absent."},{"name":"$projectRoot","type":"string","default":"''","optional":true,"description":"Absolute path to the project root that relative recorded paths are joined to; an empty string leaves them unexpanded."}],"return":{"type":"array{root: string, warning: string|null}","description":"Provider root, and a warning when the recorded path resolves outside the vendor directory."},"static":true},"source":{"signature":"public static function source(string $providerPath, string $source): string","summary":"Joins a provider root with a relative source path.","params":[{"name":"$providerPath","type":"string","description":"Absolute path to the provider root directory."},{"name":"$source","type":"string","description":"Relative path to a source file or directory inside the provider, using forward slashes as separators."}],"return":{"type":"string","description":"Absolute path to the source file or directory inside the provider."},"static":true},"syncPermissions":{"signature":"public static function syncPermissions(string $source, string $destination): string|null","summary":"Copies the source permission bits, masked by the current `umask`, onto the destination so executable stubs stay executable, and reports a failure instead of raising a PHP warning.","params":[{"name":"$source","type":"string","description":"Absolute path to the source file."},{"name":"$destination","type":"string","description":"Absolute path to the destination file."}],"return":{"type":"string|null","description":"Warning without the `[scaffold]` prefix when the permissions could not be read or set, or `null` on success."},"static":true}}},"PHPForge\\Scaffold\\Scaffold\\ScaffoldRunner":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/scaffoldrunner/","summary":"Applies the files of every allowed and installed provider to the project and records them in `scaffold-lock.json`, without depending on Composer's IO or package classes.","methods":{"__construct":{"signature":"public function __construct(PHPForge\\Scaffold\\Manifest\\ManifestLoader $loader, PHPForge\\Scaffold\\Scaffold\\FileApplier $applier, PHPForge\\Scaffold\\Scaffold\\Lock\\LockFile $lockFile, PHPForge\\Scaffold\\Console\\OutputWriter $out, PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary $summary)","summary":"Creates a runner and its mode implementations.","params":[{"name":"$loader","type":"PHPForge\\Scaffold\\Manifest\\ManifestLoader","description":"Loads provider manifests into file mappings."},{"name":"$applier","type":"PHPForge\\Scaffold\\Scaffold\\FileApplier","description":"Validates and applies each mapping."},{"name":"$lockFile","type":"PHPForge\\Scaffold\\Scaffold\\Lock\\LockFile","description":"Lock file of the project."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink: notices on stdout, warnings and errors on stderr."},{"name":"$summary","type":"PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary","description":"Counters that the runs of this runner update."}]},"run":{"signature":"public function run(PHPForge\\Scaffold\\Config\\ProjectConfig $config, array<string, PHPForge\\Scaffold\\Config\\ProviderPackage> $providers, string $projectRoot, bool $force = false): PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary","summary":"Applies the files of every provider listed in `allowed-packages` and installed, and records them in `scaffold-lock.json`; a later provider overrides an earlier one per destination, and ejected files stay untouched.","params":[{"name":"$config","type":"PHPForge\\Scaffold\\Config\\ProjectConfig","description":"Consumer settings that list the allowed providers in order."},{"name":"$providers","type":"array<string, PHPForge\\Scaffold\\Config\\ProviderPackage>","description":"Installed packages keyed by package name."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$force","type":"bool","default":"false","optional":true,"description":"Whether to overwrite user-modified and adopted `replace` destinations."}],"return":{"type":"PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary","description":"Counters of the run; a mapping that fails to apply is reported, counted in `PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary::$errors`, and does not stop the run."},"throws":[{"type":"PHPForge\\Scaffold\\Exception\\ScaffoldException","description":"when the manifest of an allowed and installed provider cannot be loaded; the message is written to stderr first and nothing is applied."},{"type":"RuntimeException","description":"when the lock file cannot be read or written."}]}}},"PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/scaffoldsummary/","summary":"Counts the outcomes of a scaffold run and formats its one-line summary.","properties":{"conflict":{"type":"int","default":"0","description":"Number of `replace` destinations skipped as user-modified although their provider stub changed since the last apply."},"errors":{"type":"int","default":"0","description":"Number of errors written to the error output: manifests that failed to load and mappings that failed to apply."},"orphan":{"type":"int","default":"0","description":"Number of lock entries that no allowed and installed provider ships anymore."},"outdated":{"type":"int","default":"0","description":"Number of existing `preserve` destinations kept although their provider stub changed since the last apply."},"unchanged":{"type":"int","default":"0","description":"Number of mappings whose destination was left unchanged, ejected files included."},"warnings":{"type":"int","default":"0","description":"Number of warnings written to the error output."},"written":{"type":"int","default":"0","description":"Number of destinations created or rewritten."}},"methods":{"format":{"signature":"public function format(string $command = ''): string","summary":"Returns the summary line, such as `[scaffold] 3 files written, 8 unchanged, 1 conflict, 1 warning.`, listing the `outdated`, `conflict`, `orphan`, warning and error counts only when they are not zero.","params":[{"name":"$command","type":"string","default":"''","optional":true,"description":"Command name inserted after the prefix, such as `sync` for `[scaffold] sync: ...`, or an empty string for none."}],"return":{"type":"string","description":"Summary line that starts with `[scaffold]` and ends with a period."}},"line":{"signature":"public function line(): string|null","summary":"Returns the summary line of `PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary::format()`, or `null` when nothing was written and nothing needs attention.","return":{"type":"string|null","description":"Summary line, or `null` when every counter except `unchanged` is zero."}}}},"PHPForge\\Scaffold\\Scaffold\\Scaffolder":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/scaffold/scaffolder/","summary":"Applies every authorized provider's files to the project inside a Composer run by converting Composer's packages for the Composer-free `PHPForge\\Scaffold\\Scaffold\\ScaffoldRunner`.","methods":{"__construct":{"signature":"public function __construct(PHPForge\\Scaffold\\Manifest\\ManifestLoader $loader, PHPForge\\Scaffold\\Scaffold\\FileApplier $applier, PHPForge\\Scaffold\\Scaffold\\Lock\\LockFile $lockFile, PHPForge\\Scaffold\\Console\\OutputWriter $out, PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary $summary)","summary":"Creates the Composer adapter for a scaffold run.","params":[{"name":"$loader","type":"PHPForge\\Scaffold\\Manifest\\ManifestLoader","description":"Loads provider manifests into file mappings."},{"name":"$applier","type":"PHPForge\\Scaffold\\Scaffold\\FileApplier","description":"Validates and applies each mapping."},{"name":"$lockFile","type":"PHPForge\\Scaffold\\Scaffold\\Lock\\LockFile","description":"Lock file of the project."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink for notices and warnings."},{"name":"$summary","type":"PHPForge\\Scaffold\\Scaffold\\ScaffoldSummary","description":"Counters that the runs of this scaffolder update."}]},"scaffold":{"signature":"public function scaffold(PHPForge\\Scaffold\\Config\\ProjectConfig $config, Composer\\Package\\PackageInterface[] $installedPackages, string $projectRoot, string $vendorDir, array<string, string> $installPaths = []): void","summary":"Applies the files of every installed provider listed in `allowed-packages` and records them in `scaffold-lock.json`; a later provider overrides an earlier one per destination, and ejected files stay untouched.","params":[{"name":"$config","type":"PHPForge\\Scaffold\\Config\\ProjectConfig","description":"Consumer settings of the root package."},{"name":"$installedPackages","type":"Composer\\Package\\PackageInterface[]","description":"Packages installed in the project."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$vendorDir","type":"string","description":"Absolute path to the vendor directory, used for providers missing from `$installPaths`."},{"name":"$installPaths","type":"array<string, string>","default":"[]","optional":true,"description":"Absolute install paths keyed by package name, as resolved by Composer's `InstallationManager`."}],"return":{"type":"void"},"throws":[{"type":"PHPForge\\Scaffold\\Exception\\ScaffoldException","description":"when the manifest of an allowed provider cannot be loaded."},{"type":"RuntimeException","description":"when the lock file cannot be read or written."}]}}},"PHPForge\\Scaffold\\Security\\PathValidator":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/security/pathvalidator/","summary":"Rejects source and destination paths that are absolute, contain `..` segments, escape their root through a symlink, or address the reserved `scaffold-lock.json`.","methods":{"hasTraversal":{"signature":"public static function hasTraversal(string $path): bool","summary":"Returns whether `$path` contains a `..` segment, splitting on forward slashes and backslashes.","params":[{"name":"$path","type":"string","description":"Path to check."}],"return":{"type":"bool","description":"`true` when a segment is `..`, `false` otherwise."},"static":true},"isAbsolute":{"signature":"public static function isAbsolute(string $path): bool","summary":"Returns whether `$path` starts with a directory separator or a Windows drive letter.","params":[{"name":"$path","type":"string","description":"Path to check."}],"return":{"type":"bool","description":"`true` when the path is absolute or drive-qualified, `false` otherwise."},"static":true},"validateDestination":{"signature":"public function validateDestination(string $destination, string $projectRoot): string","summary":"Validates that a destination path does not escape the project root.","params":[{"name":"$destination","type":"string","description":"Relative destination path declared in the manifest."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root directory."}],"return":{"type":"string","description":"Canonical absolute path of the project root."},"throws":[{"type":"RuntimeException","description":"when the project root does not exist, or the destination is absolute, contains `..`, escapes the root through a symlink, or is reserved."}]},"validateSource":{"signature":"public function validateSource(string $source, string $providerRoot): string","summary":"Validates that a source path does not escape the provider root.","params":[{"name":"$source","type":"string","description":"Relative source path declared in the manifest."},{"name":"$providerRoot","type":"string","description":"Absolute path to the provider root inside vendor."}],"return":{"type":"string","description":"Canonical absolute path of the provider root."},"throws":[{"type":"RuntimeException","description":"when the provider root does not exist, or the source is absolute, contains `..` or escapes the root through a symlink."}]}}},"PHPForge\\Scaffold\\Services\\ApplyPreview":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/applypreview/","summary":"Represents the content a destination has now and the content it would have after applying its provider mapping.","properties":{"current":{"type":"string","description":"Destination content on disk; an empty string when the destination does not exist.","readonly":true,"promoted":true},"exists":{"type":"bool","description":"Whether the destination exists on disk.","readonly":true,"promoted":true},"informational":{"type":"bool","default":"false","description":"Whether the destination is an existing `preserve` file that only `reapply --force` overwrites.","readonly":true,"promoted":true},"mapping":{"type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"Mapping that would be applied.","readonly":true,"promoted":true},"proposed":{"type":"string","description":"Destination content after applying the mapping.","readonly":true,"promoted":true},"userModified":{"type":"bool","default":"false","description":"Whether the destination is a `replace` file that scaffold skips because it changed since the last apply or was adopted.","readonly":true,"promoted":true}},"methods":{"__construct":{"signature":"public function __construct(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, bool $exists, string $current, string $proposed, bool $userModified = false, bool $informational = false)","summary":"Creates a preview of applying a provider mapping.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"Mapping that would be applied."},{"name":"$exists","type":"bool","description":"Whether the destination exists on disk."},{"name":"$current","type":"string","description":"Destination content on disk; an empty string when the destination does not exist."},{"name":"$proposed","type":"string","description":"Destination content after applying the mapping."},{"name":"$userModified","type":"bool","default":"false","optional":true,"description":"Whether the destination is a `replace` file that scaffold skips because it changed since the last apply or was adopted."},{"name":"$informational","type":"bool","default":"false","optional":true,"description":"Whether the destination is an existing `preserve` file that only `reapply --force` overwrites."}]},"changes":{"signature":"public function changes(): bool","summary":"Returns whether applying the mapping would create the destination or change its bytes.","return":{"type":"bool","description":"`true` when the destination is missing or its content differs from the proposed one, `false` otherwise."}},"differsOnlyInLineEndings":{"signature":"public function differsOnlyInLineEndings(): bool","summary":"Returns whether the current and proposed contents differ only in their line endings.","return":{"type":"bool","description":"`true` when the destination exists and its content equals the proposed one after normalising line endings, `false` otherwise."}}}},"PHPForge\\Scaffold\\Services\\ApplyPreviewer":{"kind":"class","modifiers":["final","readonly"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/applypreviewer/","summary":"Computes in memory what applying a provider mapping would write to its destination, without touching the disk.","methods":{"preview":{"signature":"public function preview(PHPForge\\Scaffold\\Manifest\\FileMapping $mapping, string $projectRoot, PHPForge\\Scaffold\\Services\\LockEntry|null $entry = null): PHPForge\\Scaffold\\Services\\ApplyPreview","summary":"Returns the current and proposed content of the mapping destination: the stub for `replace` and `preserve`, the merge result for `append`, and the prepended block for `prepend`.","params":[{"name":"$mapping","type":"PHPForge\\Scaffold\\Manifest\\FileMapping","description":"Validated mapping to preview."},{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$entry","type":"PHPForge\\Scaffold\\Services\\LockEntry|null","default":"null","optional":true,"description":"Lock entry of the destination, or `null` when it is untracked."}],"return":{"type":"PHPForge\\Scaffold\\Services\\ApplyPreview","description":"Current and proposed content of the destination, with its `replace` and `preserve` flags."},"throws":[{"type":"RuntimeException","description":"when the stub is missing or a file cannot be read or hashed."}]}}},"PHPForge\\Scaffold\\Services\\DiffService":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/diffservice/","summary":"Renders Git-compatible unified diffs of what applying the provider would change in tracked files.","methods":{"renderPreview":{"signature":"public function renderPreview(PHPForge\\Scaffold\\Services\\ApplyPreview $preview, PHPForge\\Scaffold\\Console\\OutputWriter $out, bool $decorated = false): bool","summary":"Writes the header and diff of one preview, `no changes`, or the line-ending notice.","params":[{"name":"$preview","type":"PHPForge\\Scaffold\\Services\\ApplyPreview","description":"Preview of the destination to render."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink."},{"name":"$decorated","type":"bool","default":"false","optional":true,"description":"Whether to wrap the diff lines in ANSI color escape codes."}],"return":{"type":"bool","description":"`true` when applying the mapping would create or change the destination, `false` otherwise."}},"run":{"signature":"public function run(PHPForge\\Scaffold\\Config\\ProjectContext $context, PHPForge\\Scaffold\\Console\\OutputWriter $out, string|null $file = null, bool $decorated = false, bool $exitCode = false): int","summary":"Renders what applying the provider would change in `$file`, or in every tracked, non-ejected file when `$file` is `null`, against the current disk content; orphans are reported, not diffed.","params":[{"name":"$context","type":"PHPForge\\Scaffold\\Config\\ProjectContext","description":"Project to inspect."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink."},{"name":"$file","type":"string|null","default":"null","optional":true,"description":"Destination path as recorded in `scaffold-lock.json`, or `null` for every file."},{"name":"$decorated","type":"bool","default":"false","optional":true,"description":"Whether to wrap the diff lines in ANSI color escape codes."},{"name":"$exitCode","type":"bool","default":"false","optional":true,"description":"Whether to return `1` when applying the provider would change any file."}],"return":{"type":"int","description":"`1` when the file is not tracked, an entry is unsafe, its provider is not allowed, or a file cannot be read, or with `$exitCode` when any file would change; `0` otherwise."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read."}]}}},"PHPForge\\Scaffold\\Services\\EjectService":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/ejectservice/","summary":"Marks a file entry as ejected in `scaffold-lock.json` so scaffold stops writing it; the file stays on disk.","methods":{"run":{"signature":"public function run(string $projectRoot, PHPForge\\Scaffold\\Console\\OutputWriter $out, string $file, bool $confirmed = false): int","summary":"Marks the entry of `$file` as ejected, or only previews the change when `$confirmed` is `false`.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink."},{"name":"$file","type":"string","description":"Destination path as recorded in `scaffold-lock.json`."},{"name":"$confirmed","type":"bool","default":"false","optional":true,"description":"Whether to write the ejection; `false` only previews it."}],"return":{"type":"int","description":"`0` on success, including previews and entries already ejected; `1` when the entry is not tracked."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read or written."}]}}},"PHPForge\\Scaffold\\Services\\FileStatus":{"kind":"enum","url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/filestatus/","summary":"Represents the state of a scaffold file, tracked in `scaffold-lock.json` or pending, as reported by the `status` command.","backingType":"string","cases":{"Conflict":{"value":"'conflict'","description":"The destination is a `replace` file changed by the consumer while the provider stub also changed."},"Ejected":{"value":"'ejected'","description":"The destination was ejected and scaffold no longer manages it."},"Error":{"value":"'error'","description":"The lock entry is unsafe, or the destination, stub or provider manifest cannot be read."},"Missing":{"value":"'missing'","description":"The destination is absent from disk."},"Modified":{"value":"'modified'","description":"The `replace` or `preserve` destination changed since the last apply."},"Orphan":{"value":"'orphan'","description":"No allowed and installed provider ships the destination anymore."},"Outdated":{"value":"'outdated'","description":"The provider stub changed since the last apply, or an `append`/`prepend` destination lacks provider content."},"Pending":{"value":"'pending'","description":"An allowed and installed provider ships the destination, but `scaffold-lock.json` has no entry for it yet."},"Synced":{"value":"'synced'","description":"The destination matches the last apply and the current provider stub."}},"methods":{"summaryOrder":{"signature":"public static function summaryOrder(): list<self>","summary":"Returns the states in the order the summary line lists them.","return":{"type":"list<self>","description":"Every state in summary order, from `synced` to `error`."},"static":true}}},"PHPForge\\Scaffold\\Services\\ProvidersService":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/providersservice/","summary":"Lists scaffold providers recorded in `scaffold-lock.json` with their file counts.","methods":{"getProviders":{"signature":"public function getProviders(string $projectRoot): array<string, int>","summary":"Returns the number of tracked files of every provider recorded in `scaffold-lock.json` under `$projectRoot`.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root."}],"return":{"type":"array<string, int>","description":"Map of provider package names to the number of files tracked for them."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read."}]},"run":{"signature":"public function run(string $projectRoot, PHPForge\\Scaffold\\Console\\OutputWriter $out): int","summary":"Renders the providers table for the project rooted at `$projectRoot`.","params":[{"name":"$projectRoot","type":"string","description":"Absolute path to the project root directory."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink used for stdout writes."}],"return":{"type":"int","description":"`0` on success."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read."}]}}},"PHPForge\\Scaffold\\Services\\PruneService":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/pruneservice/","summary":"Reports the orphaned entries of `scaffold-lock.json` and, when forced, removes them from the lock and deletes the orphaned files that hold only provider content.","methods":{"run":{"signature":"public function run(PHPForge\\Scaffold\\Config\\ProjectContext $context, PHPForge\\Scaffold\\Console\\OutputWriter $out, bool $force = false, bool $deleteModified = false, bool $exitCode = false): int","summary":"Previews or prunes the orphaned entries of the project lock, ending with a summary line.","params":[{"name":"$context","type":"PHPForge\\Scaffold\\Config\\ProjectContext","description":"Project to prune."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink."},{"name":"$force","type":"bool","default":"false","optional":true,"description":"Whether to remove the orphan entries from the lock and delete the unmodified orphan files."},{"name":"$deleteModified","type":"bool","default":"false","optional":true,"description":"Whether `$force` also deletes orphan files that hold consumer content."},{"name":"$exitCode","type":"bool","default":"false","optional":true,"description":"Whether a preview returns `1` when orphans exist."}],"return":{"type":"int","description":"`1` when a provider manifest cannot be loaded or a file or directory cannot be deleted, or with `$exitCode` when a preview finds orphans; `0` otherwise."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read or written."}]}}},"PHPForge\\Scaffold\\Services\\ReapplyService":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/reapplyservice/","summary":"Rewrites tracked files from their provider stubs; without `force` it merges `append` and `prepend` files and skips ejected, adopted, user-modified and existing `preserve` files; it always skips orphaned files.","methods":{"run":{"signature":"public function run(PHPForge\\Scaffold\\Config\\ProjectContext $context, PHPForge\\Scaffold\\Console\\OutputWriter $out, string $file = '', string $provider = '', bool $force = false, bool $dryRun = false, bool $exitCode = false): int","summary":"Reapplies the tracked files that match the filters and records their new hashes in `scaffold-lock.json`, or only prints what would change with `$dryRun`, ending with a summary line.","params":[{"name":"$context","type":"PHPForge\\Scaffold\\Config\\ProjectContext","description":"Project to reapply."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink."},{"name":"$file","type":"string","default":"''","optional":true,"description":"Destination path to reapply, or an empty string for every tracked file."},{"name":"$provider","type":"string","default":"''","optional":true,"description":"Provider package name to reapply, or an empty string for every provider."},{"name":"$force","type":"bool","default":"false","optional":true,"description":"Whether to overwrite every matching file with its stub, including ejected, adopted, user-modified, `preserve`, `append` and `prepend` files, and to clear the `ejected` and `adopted` flags."},{"name":"$dryRun","type":"bool","default":"false","optional":true,"description":"Whether to print the diff of every file that would change instead of writing anything."},{"name":"$exitCode","type":"bool","default":"false","optional":true,"description":"Whether a dry run returns `1` when any file would change."}],"return":{"type":"int","description":"`1` when a filter matches no tracked file or an entry was skipped for an error (unsafe entry, provider not allowed, missing stub, unknown mode, read, hash or write failure), or with `$dryRun` and `$exitCode` when any file would change; `0` otherwise, including user-modified, `preserve`, ejected and orphaned skips."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read or written."}]}}},"PHPForge\\Scaffold\\Services\\ReapplySummary":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/reapplysummary/","summary":"Counts the outcomes of a `reapply` run and formats its summary line.","properties":{"errors":{"type":"int","default":"0","description":"Number of entries skipped for an error."},"skipped":{"type":"array<string, int>","default":"[]","description":"Number of entries skipped without an error, keyed by reason (`ejected`, `orphaned`, `preserve`, `user-modified`), in first-seen order."},"unchanged":{"type":"int","default":"0","description":"Number of entries whose destination already matched."},"written":{"type":"int","default":"0","description":"Number of entries written, or that a dry run would write."}},"methods":{"line":{"signature":"public function line(bool $dryRun = false): string","summary":"Returns the summary line, such as `[scaffold] reapply: 3 written, 7 unchanged, 1 skipped (user-modified), 0 errors.`.","params":[{"name":"$dryRun","type":"bool","default":"false","optional":true,"description":"Whether the run only previewed the changes."}],"return":{"type":"string","description":"Summary line prefixed with `[scaffold]`."}},"skip":{"signature":"public function skip(string $reason): void","summary":"Counts an entry skipped without an error.","params":[{"name":"$reason","type":"string","description":"Skip reason: `ejected`, `orphaned`, `preserve` or `user-modified`."}],"return":{"type":"void"}}}},"PHPForge\\Scaffold\\Services\\StatusService":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/statusservice/","summary":"Reports the state of each file tracked in `scaffold-lock.json` against the disk and the current provider stubs, and the provider files not tracked yet as `pending`.","methods":{"run":{"signature":"public function run(PHPForge\\Scaffold\\Config\\ProjectContext $context, PHPForge\\Scaffold\\Console\\OutputWriter $out, bool $json = false, bool $exitCode = false): int","summary":"Renders the status of all files tracked in `scaffold-lock.json` of the project, as a table followed by a summary line or as a JSON document, with notices and provider version drift on stderr.","params":[{"name":"$context","type":"PHPForge\\Scaffold\\Config\\ProjectContext","description":"Project to inspect."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink."},{"name":"$json","type":"bool","default":"false","optional":true,"description":"Whether to print only the JSON document on stdout."},{"name":"$exitCode","type":"bool","default":"false","optional":true,"description":"Whether to return `1` when any file is neither `synced` nor `ejected`, `pending` included."}],"return":{"type":"int","description":"`1` when any file is in the `error` state, or with `$exitCode` when any file is neither `synced` nor `ejected`; `0` otherwise."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read or the JSON document cannot be encoded."}]}}},"PHPForge\\Scaffold\\Services\\SyncService":{"kind":"class","modifiers":["final"],"url":"https://yii2-framework.github.io/docs/extensions/scaffold/reference/services/syncservice/","summary":"Applies the allowed and installed providers to the project from the command line, with the same rules as a Composer `install` or `update`, or previews what applying them would change.","methods":{"run":{"signature":"public function run(PHPForge\\Scaffold\\Config\\ProjectContext $context, PHPForge\\Scaffold\\Console\\OutputWriter $out, bool $dryRun = false, bool $exitCode = false, bool $force = false, bool $decorated = false): int","summary":"Synchronizes the project with its providers and ends with a summary line; works with `auto: false` and creates `scaffold-lock.json` when it is missing.","params":[{"name":"$context","type":"PHPForge\\Scaffold\\Config\\ProjectContext","description":"Project to synchronize."},{"name":"$out","type":"PHPForge\\Scaffold\\Console\\OutputWriter","description":"Output sink."},{"name":"$dryRun","type":"bool","default":"false","optional":true,"description":"Whether to print what applying the providers would change instead of writing anything."},{"name":"$exitCode","type":"bool","default":"false","optional":true,"description":"Whether a dry run returns `1` when applying would write a file or record a new entry."},{"name":"$force","type":"bool","default":"false","optional":true,"description":"Whether to overwrite user-modified and adopted `replace` files, like `reapply --force`."},{"name":"$decorated","type":"bool","default":"false","optional":true,"description":"Whether a dry run colors its diffs."}],"return":{"type":"int","description":"`1` when a provider manifest cannot be loaded, a file fails to apply or the lock cannot be written, or with `$dryRun` and `$exitCode` when applying would change something; `0` otherwise."},"throws":[{"type":"RuntimeException","description":"when the lock file cannot be read."}]}}}}}
