\PayloadManifestParser
Class PayloadManifestParser
Synopsis
class PayloadManifestParser
{
- // constants
- const TYPE_FIELD = 'field';
- const TYPE_METHOD = 'method';
- const TYPE_RELATION = 'relation';
- // members
- private static string $key_transformer = 'LowerCamelCaseKeyTransformer';
- private KeyTransformer $keyTransformer;
- private $validationErrors;
- // methods
- public void __construct()
- public array|scalar getManifest()
- public array getValidationErrors()
- public void clearValidationErrors()
- private void validationError()
- private void required()
- private void missing()
- public bool canCommit()
- private array transform()
- private array parseEntry()
- public array commit()
Constants
Name | Value |
---|---|
TYPE_FIELD | 'field' |
TYPE_METHOD | 'method' |
TYPE_RELATION | 'relation' |
Members
private
- $keyTransformer — KeyTransformer
- $key_transformer — string
- $validationErrors — array
Methods
private
- missing() — Generates a human-readable error message if entries in a relation list are missing.
- parseEntry() — Parses one entry of the read payload manifest.
- required() — Generates a human-readable error message if a value is missing.
- transform() — Applies the transformer rules to parsed payload.
- validationError() — Lists a validation error if not present yet.
public
- __construct()
- canCommit() — Checks if payload can be commited.
- clearValidationErrors() — Resets errors array
- commit() — Generates commit-ready data.
- getManifest() — Obtains the read payload manifest for the given class.
- getValidationErrors()