Skip to content
PHP Ecosystem
Explore

ReapplySummary

API reference › Scaffold › Services › ReapplySummary

final classPHPForge\Scaffold\Services\ReapplySummary
Sourcesrc/Services/ReapplySummary.php

Counts the outcomes of a reapply run and formats its summary line.

PropertyTypeDescriptionDefined by
$errorsintNumber of entries skipped for an error. Default: 0.ReapplySummary
$skippedarray<string, int>Number of entries skipped without an error, keyed by reason (ejected, orphaned, preserve, user-modified), in first-seen order. Default: [].ReapplySummary
$unchangedintNumber of entries whose destination already matched. Default: 0.ReapplySummary
$writtenintNumber of entries written, or that a dry run would write. Default: 0.ReapplySummary
MethodDescriptionDefined by
line()Returns the summary line, such as [scaffold] reapply: 3 written, 7 unchanged, 1 skipped (user-modified), 0 errors..ReapplySummary
skip()Counts an entry skipped without an error.ReapplySummary
public function line(bool $dryRun = false): string

Returns the summary line, such as [scaffold] reapply: 3 written, 7 unchanged, 1 skipped (user-modified), 0 errors..

Parameters

ParameterTypeDescription
$dryRunboolWhether the run only previewed the changes.

Returns

string: Summary line prefixed with [scaffold].

public function skip(string $reason): void

Counts an entry skipped without an error.

Parameters

ParameterTypeDescription
$reasonstringSkip reason: ejected, orphaned, preserve or user-modified.