Class Salient\Sync\SyncSerializeRules

`<TEntity is SyncEntityInterface>`

`final`
`implements`	`SyncSerializeRulesInterface<TEntity>, Buildable<SyncSerializeRulesBuilder<TEntity>>`
`uses`	`HasBuilder, HasMutator`

Rules applied when serializing a sync entity

Rules can be applied to any combination of paths and class properties reachable from the entity, e.g. for a User entity that normalises property names:

<?php
[
    // Applied to '.Manager.OrgUnit'
    '.manager.org_unit',
    User::class => [
        // Ignored for '.Manager.OrgUnit' because a path-based rule applies,
        // but applied to '.OrgUnit', '.Staff[].OrgUnit', ...
        'org_unit',
    ],
];

Path-based rules apply to specific nodes in the object graph below the entity (only the OrgUnit of the user's manager in the example above), whereas class-based rules apply to every appearance of a class in the entity's object graph (the OrgUnit of every User object, including the one being serialized, in this example).

Each rule must be either a string containing the path or key to act upon, or an array with up to 3 values:

the path or key to act upon (string; required; must be the first value)
a new key for the value (int|string; optional)
a closure to return a new value for the key (Closure($value, $store, $rules): mixed; optional)

Optional values may be omitted.

If multiple rules apply to the same key, path-based rules take precedence over class-based ones, then later rules take precedence over earlier ones:

<?php
[
    // Ignored because it applies to the same path as the next rule
    '.manager.org_unit',
    // Applied to '.Manager.OrgUnit'
    [
        '.manager.org_unit',
        'org_unit_id',
        fn($ou) => $ou->Id,
    ],
    User::class => [
        // Ignored because it applies to the same property as the next rule
        'org_unit',
        // Ignored for '.Manager.OrgUnit' because a path-based rule applies,
        // but applied to '.OrgUnit', '.Staff[].OrgUnit', ...
        ['org_unit', 'org_unit_id'],
    ],
];

Located at Toolkit/Sync/SyncSerializeRules.php

Methods
`public`	`merge<T is TEntity>(static<T> $rules): static<T>` Merge with another instance, giving precedence to its values if there are any conflicts Merge with another instance, giving precedence to its values if there are any conflicts An exception is thrown if `$rules` does not apply to the same entity or one of its subclasses. Implements `Salient\Contract\Core\SerializeRulesInterface::merge()`	#
`public`	`getRemovableKeys(?string $class, ?string $baseClass, array $path): array` Get keys to remove from a serialized class at a given path Get keys to remove from a serialized class at a given path If `$baseClass` is given, rules applied to `$class` and its parents up to but not including `$baseClass` are considered, otherwise the only class-based rules considered are those applied to `$class`. Returns Keys and values are the same. Implements `Salient\Contract\Core\SerializeRulesInterface::getRemovableKeys()`	#
`public`	`getReplaceableKeys(?string $class, ?string $baseClass, array $path): array` Get keys to replace in a serialized class at a given path Get keys to replace in a serialized class at a given path If `$baseClass` is given, rules applied to `$class` and its parents up to but not including `$baseClass` are considered, otherwise the only class-based rules considered are those applied to `$class`. Returns Each key is mapped to an array with two values, one of which may be `null`: a new key for the value a closure to return a new value for the key Implements `Salient\Contract\Core\SerializeRulesInterface::getReplaceableKeys()`	#
`public`	`getEntity(): string` Get the entity to which the rules apply Get the entity to which the rules apply Implements `Salient\Contract\Core\SerializeRulesInterface::getEntity()`	#
`public`	`getDateFormatter(): ?DateFormatterInterface` Get a date formatter to serialize date and time values Get a date formatter to serialize date and time values Implements `Salient\Contract\Core\SerializeRulesInterface::getDateFormatter()`	#
`public`	`getIncludeMeta(): bool` Check if undeclared property values are serialized Check if undeclared property values are serialized Implements `Salient\Contract\Core\SerializeRulesInterface::getIncludeMeta()`	#
`public`	`getSortByKey(): bool` Check if serialized entities are sorted by key Check if serialized entities are sorted by key Implements `Salient\Contract\Core\SerializeRulesInterface::getSortByKey()`	#
`public`	`getMaxDepth(): int` Get the maximum depth of nested values Get the maximum depth of nested values Implements `Salient\Contract\Core\SerializeRulesInterface::getMaxDepth()`	#
`public`	`getDetectRecursion(): bool` Check if recursion is detected when serializing nested entities Check if recursion is detected when serializing nested entities Implements `Salient\Contract\Core\SerializeRulesInterface::getDetectRecursion()`	#
`public`	`getRecurseRules(): bool` Check if path-based rules are applied to nested instances of the entity Check if path-based rules are applied to nested instances of the entity Implements `Salient\Contract\Core\SerializeRulesInterface::getRecurseRules()`	#
`public`	`getForSyncStore(): bool` Check if values are being serialized for an entity store Check if values are being serialized for an entity store Implements `Salient\Contract\Sync\SyncSerializeRulesInterface::getForSyncStore()`	#
`public`	`getIncludeCanonicalId(): bool` Check if canonical identifiers of sync entities are serialized Check if canonical identifiers of sync entities are serialized Implements `Salient\Contract\Sync\SyncSerializeRulesInterface::getIncludeCanonicalId()`	#
`public`	`withDateFormatter(?DateFormatterInterface $formatter)` Get an instance that uses the given date formatter to serialize date and time values Get an instance that uses the given date formatter to serialize date and time values {@see DateTimeInterface} instances are serialized as ISO-8601 strings if no date formatter is provided. Implements `Salient\Contract\Core\SerializeRulesInterface::withDateFormatter()`	#
`public`	`withIncludeMeta(?bool $include = true)` Get an instance that serializes undeclared property values Get an instance that serializes undeclared property values Implements `Salient\Contract\Core\SerializeRulesInterface::withIncludeMeta()`	#
`public`	`withSortByKey(?bool $sort = true)` Get an instance that sorts serialized entities by key Get an instance that sorts serialized entities by key Implements `Salient\Contract\Core\SerializeRulesInterface::withSortByKey()`	#
`public`	`withMaxDepth(?int $depth)` Get an instance that limits the depth of nested values Get an instance that limits the depth of nested values Implements `Salient\Contract\Core\SerializeRulesInterface::withMaxDepth()`	#
`public`	`withDetectRecursion(?bool $detect = true)` Get an instance that detects recursion when serializing nested entities Get an instance that detects recursion when serializing nested entities If it would be impossible for a circular reference to arise during serialization, disable recursion detection to improve performance and reduce memory consumption. Implements `Salient\Contract\Core\SerializeRulesInterface::withDetectRecursion()`	#
`public`	`withRecurseRules(?bool $recurse = true)` Get an instance that applies path-based rules to nested instances of the entity Get an instance that applies path-based rules to nested instances of the entity Implements `Salient\Contract\Core\SerializeRulesInterface::withRecurseRules()`	#
`public`	`withForSyncStore(?bool $forSyncStore = true)` Get an instance that serializes values for an entity store Get an instance that serializes values for an entity store Implements `Salient\Contract\Sync\SyncSerializeRulesInterface::withForSyncStore()`	#
`public`	`withIncludeCanonicalId(?bool $include = true)` Get an instance that serializes canonical identifiers of sync entities Get an instance that serializes canonical identifiers of sync entities Implements `Salient\Contract\Sync\SyncSerializeRulesInterface::withIncludeCanonicalId()`	#

Methods used from Salient\Core\Concern\HasBuilder
`getBuilder(), build(), resolve()`

Namespaces

Classes

Class Salient\Sync\SyncSerializeRules

`<TEntity is SyncEntityInterface>`

Implements

Returns

Implements

Returns

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements

Implements