Skip to content
PHP Ecosystem
Explore

Scaffolder

API reference › Scaffold › Scaffold › Scaffolder

final readonly classPHPForge\Scaffold\Scaffold\Scaffolder
Sourcesrc/Scaffold/Scaffolder.php

Applies every authorized provider’s files to the project inside a Composer run by converting Composer’s packages for the Composer-free ScaffoldRunner.

MethodDescriptionDefined by
__construct()Creates the Composer adapter for a scaffold run.Scaffolder
scaffold()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.Scaffolder
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)

Creates the Composer adapter for a scaffold run.

Parameters

ParameterTypeDescription
$loaderPHPForge\Scaffold\Manifest\ManifestLoaderLoads provider manifests into file mappings.
$applierFileApplierValidates and applies each mapping.
$lockFilePHPForge\Scaffold\Scaffold\Lock\LockFileLock file of the project.
$outPHPForge\Scaffold\Console\OutputWriterOutput sink for notices and warnings.
$summaryScaffoldSummaryCounters that the runs of this scaffolder update.
public function scaffold(PHPForge\Scaffold\Config\ProjectConfig $config, Composer\Package\PackageInterface[] $installedPackages, string $projectRoot, string $vendorDir, array<string, string> $installPaths = []): void

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.

Parameters

ParameterTypeDescription
$configPHPForge\Scaffold\Config\ProjectConfigConsumer settings of the root package.
$installedPackagesComposer\Package\PackageInterface[]Packages installed in the project.
$projectRootstringAbsolute path to the project root.
$vendorDirstringAbsolute path to the vendor directory, used for providers missing from $installPaths.
$installPathsarray<string, string>Absolute install paths keyed by package name, as resolved by Composer’s InstallationManager.

Throws