-
-
Notifications
You must be signed in to change notification settings - Fork 0
SynchronizeResult
Result object for packaged directory synchronization operations.
This value object tracks the outcome of a synchronization run by recording which links were created, which existing links or directories were preserved, and which broken links were removed before recreation. It also carries a failure flag so callers can distinguish successful runs from aborted or invalid synchronization attempts.
- Full name:
\FastForward\DevTools\Sync\SynchronizeResult - This class is marked as final and can't be subclassed
- This class is a Final class
Records the name of a link that was newly created.
public addCreatedLink(string $link): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$link |
string | Entry name identifying the created link |
Records the name of an entry that was preserved as-is.
public addPreservedLink(string $link): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$link |
string | Entry name identifying the preserved link or directory |
Records the name of a broken link that was removed before recreation.
public addRemovedBrokenLink(string $link): voidParameters:
| Parameter | Type | Description |
|---|---|---|
$link |
string | Entry name identifying the repaired broken link |
Marks the synchronization as failed.
public markFailed(): voidCallers SHOULD use this when a precondition or runtime error prevents the synchronization result from being considered successful.
Returns the names of links created during synchronization.
public getCreatedLinks(): list<string>Returns the names of links or directories preserved during synchronization.
public getPreservedLinks(): list<string>Returns the names of broken links removed during synchronization repair.
public getRemovedBrokenLinks(): list<string>Indicates whether the synchronization result represents a failed run.
public failed(): bool