Hydration
Table of Contents
Classes
- CollectionOf
- Declares the item type of a `Collection` or `array` property for
{@see \App\Core\Utils\Hydrators\EntityHydrator}.
- ConditionallyUpdatable
- Column that a caller without the `updateColumns` privilege may still write via
`updateColumns`, but only when a named Api presenter method approves it.
- EntityOf
- Declares the target class of a single (ToOne) association for
{@see \App\Core\Utils\Hydrators\EntityHydrator}.
- ExternalAdminOnly
- Property or association that an external client may write only when its grant for the request
comes from a role with `privileged = 1`.
- ExternalReadonly
- Property that an external client (marker `$meta['__external']`) must not write, i.e. a
server-controlled field such as `paid`, `banned` or `approvedAt`.
- FieldAccess
- Field tier: who receives the field (`read`), who may fill it in when creating (`insert`) and
who may change it on an existing record (`update`, including `updateColumn(s)`).
- Identity
- Marks a property that is part of the entity identity (primary key) for
{@see \App\Core\Utils\Hydrators\EntityHydrator}.
- ParentRef
- Marks a single association that is a back-reference to the owning parent (Doctrine ManyToOne
with `inversedBy`), for {@see \App\Core\Utils\Hydrators\EntityHydrator}.
- PersonalData
- Marks a field that carries personal data, which a foreign unprivileged caller receives
according to the global mode {@see PersonalDataExposure}.
- PersonalDataOwner
- Names the field that holds the owner's id; the owner sees their own personal data in full
regardless of the {@see PersonalDataExposure} mode.
- PubliclyUpdatable
- Column that anyone, even without the `updateColumns` privilege, may write via `updateColumns`.
- Transient
- Property that {@see \App\Core\Utils\Hydrators\EntityHydrator} ignores completely, neither
extracting nor hydrating it.
Enums
- Audience
- Audience of a field: who receives it (`read`), who may fill it in when creating (`insert`) and
who may change it on an existing record (`update`).
- PersonalDataExposure
- Global mode of releasing personal data to foreign unprivileged callers, set by
`1/security.personalDataExposure`.
- PersonalDataKind
- How personal data is shown to a foreign unprivileged caller in mode
{@see PersonalDataExposure::Sanitized}. Vocabulary for {@see PersonalData}.