# Scaffolder

> 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.

[API reference](/docs/api/index.md) › [Scaffold](/docs/extensions/scaffold/reference/index.md) › [Scaffold](/docs/extensions/scaffold/reference/scaffold/index.md) › Scaffolder

| final readonly class | `PHPForge\Scaffold\Scaffold\Scaffolder` |
| --- | --- |
| Source | [`src/Scaffold/Scaffolder.php`](https://github.com/php-forge/scaffold/blob/main/src/Scaffold/Scaffolder.php#L17) |

Applies every authorized provider's files to the project inside a Composer run by converting Composer's packages
for the Composer-free [`ScaffoldRunner`](/docs/extensions/scaffold/reference/scaffold/scaffoldrunner/index.md).

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`__construct()`](#method-__construct) | Creates the Composer adapter for a scaffold run. | `Scaffolder` |
| [`scaffold()`](#method-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` |

## Method details

### __construct() <span id="method-__construct"></span>

```php
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**

| Parameter | Type | Description |
| --- | --- | --- |
| `$loader` | [`PHPForge\Scaffold\Manifest\ManifestLoader`](/docs/extensions/scaffold/reference/manifest/manifestloader/index.md) | Loads provider manifests into file mappings. |
| `$applier` | [`FileApplier`](/docs/extensions/scaffold/reference/scaffold/fileapplier/index.md) | Validates and applies each mapping. |
| `$lockFile` | [`PHPForge\Scaffold\Scaffold\Lock\LockFile`](/docs/extensions/scaffold/reference/scaffold/lock/lockfile/index.md) | Lock file of the project. |
| `$out` | [`PHPForge\Scaffold\Console\OutputWriter`](/docs/extensions/scaffold/reference/console/outputwriter/index.md) | Output sink for notices and warnings. |
| `$summary` | [`ScaffoldSummary`](/docs/extensions/scaffold/reference/scaffold/scaffoldsummary/index.md) | Counters that the runs of this scaffolder update. |

### scaffold() <span id="method-scaffold"></span>

```php
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**

| Parameter | Type | Description |
| --- | --- | --- |
| `$config` | [`PHPForge\Scaffold\Config\ProjectConfig`](/docs/extensions/scaffold/reference/config/projectconfig/index.md) | Consumer settings of the root package. |
| `$installedPackages` | `Composer\Package\PackageInterface[]` | Packages installed in the project. |
| `$projectRoot` | `string` | Absolute path to the project root. |
| `$vendorDir` | `string` | Absolute path to the vendor directory, used for providers missing from `$installPaths`. |
| `$installPaths` | `array<string, string>` | Absolute install paths keyed by package name, as resolved by Composer's `InstallationManager`. |

**Throws**

- [`PHPForge\Scaffold\Exception\ScaffoldException`](/docs/extensions/scaffold/reference/exception/scaffoldexception/index.md): when the manifest of an allowed provider cannot be loaded.
- [`RuntimeException`](https://www.php.net/manual/en/class.runtimeexception.php): when the lock file cannot be read or written.