SynchronizeResult
Result object for skill synchronization operations.
Description
Tracks the outcomes of a synchronization run, including newly created links, existing items that were preserved, and broken links that were removed. The failed flag indicates whether an error occurred during synchronization.
Properties
List of skill names for which new symlinks were created.
Indicates whether the synchronization encountered a failure.
List of skill names for which existing items were left unchanged.
List of skill names whose broken symlinks were removed during sync.
Methods
Records a skill for which a new symlink was created.
Records a skill whose existing item was preserved unchanged.
Records a skill whose broken symlink was removed during sync.
Indicates whether the synchronization encountered a failure.
Returns the list of skills for which new symlinks were created.
Returns the list of skills whose existing items were preserved.
Returns the list of skills whose broken symlinks were removed.
Marks the synchronization as failed due to an error condition.
List of skill names for which new symlinks were created.
private
array<int, string>
$createdLinks
=
[]
Indicates whether the synchronization encountered a failure.
private
bool
$failed
=
false
List of skill names for which existing items were left unchanged.
private
array<int, string>
$preservedLinks
=
[]
List of skill names whose broken symlinks were removed during sync.
private
array<int, string>
$removedBrokenLinks
=
[]
Records a skill for which a new symlink was created.
public
addCreatedLink(
string
$link) : void
Parameters
$link
:
string
Description
Name of the skill that received a new symlink
Records a skill whose existing item was preserved unchanged.
public
addPreservedLink(
string
$link) : void
Parameters
$link
:
string
Description
Name of the skill that was left in place
Records a skill whose broken symlink was removed during sync.
public
addRemovedBrokenLink(
string
$link) : void
Parameters
$link
:
string
Description
Name of the skill whose broken link was removed
Indicates whether the synchronization encountered a failure.
public
failed() : bool
Return values
Description
True if an error occurred, false otherwise
Returns the list of skills for which new symlinks were created.
public
getCreatedLinks() : array<int, string>
Return values
Description
Skill names of newly created links
Returns the list of skills whose existing items were preserved.
public
getPreservedLinks() : array<int, string>
Return values
Description
Skill names of preserved items
Returns the list of skills whose broken symlinks were removed.
public
getRemovedBrokenLinks() : array<int, string>
Return values
Description
Skill names of removed broken links
Marks the synchronization as failed due to an error condition.
public
markFailed() : void