ReapplySummary
API reference › Scaffold › Services › ReapplySummary
Counts the outcomes of a reapply run and formats its summary line.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$errors | int | Number of entries skipped for an error. Default: 0. | ReapplySummary |
$skipped | array<string, | Number of entries skipped without an error, keyed by reason (ejected, orphaned, preserve, user-modified), in first-seen order. Default: []. | ReapplySummary |
$unchanged | int | Number of entries whose destination already matched. Default: 0. | ReapplySummary |
$written | int | Number of entries written, or that a dry run would write. Default: 0. | ReapplySummary |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
line() | Returns the summary line, such as [scaffold] reapply: 3 written,. | ReapplySummary |
skip() | Counts an entry skipped without an error. | ReapplySummary |
Method details
Section titled “Method details”line()
Section titled “line() ”public function line(bool $dryRun = false): stringReturns the summary line, such as [scaffold] reapply: 3 written, 7 unchanged, 1 skipped (user-modified), 0 errors..
Parameters
| Parameter | Type | Description |
|---|---|---|
$dryRun | bool | Whether the run only previewed the changes. |
Returns
string: Summary line prefixed with [scaffold].
skip()
Section titled “skip() ”public function skip(string $reason): voidCounts an entry skipped without an error.
Parameters
| Parameter | Type | Description |
|---|---|---|
$reason | string | Skip reason: ejected, orphaned, preserve or user-modified. |