class RequestQueryStringPartialsResolver

Constants

private PARTIAL_TYPES

Methods

__construct(DataClassRepository $dataClasses)

Create a request query string partials resolver.

resolve(BaseData|ResponsableData|BaseDataCollectable|ResponsableData $data, Request $request, TransformationContextFactory $contextFactory)

Apply allowed request partials to a transformation context factory.

array
resolvePaths(mixed $value, string $type, DataClass $dataClass, array $allowedPartials)

Resolve valid property-name paths from one request value.

array
validateTree(PartialTree $partial, string $type, DataClass $dataClass, array $allowedPartials)

Validate a compiled partial tree against one data class.

findProperty(string $field, DataClass $dataClass)

Find a data property by its PHP or mapped output name.

DataClass|null
nestedDataClass(DataProperty $property)

Get the one nested data class represented by a property.

array|null
allowedPartials(string $type, DataClass $dataClass, array $allowedPartials)

Resolve one class-owned allowlist once for this response.

bool
allowsAll(array|null $allowed)

Determine whether an allowlist permits every property.

bool
allows(array|null $allowed, string $property)

Determine whether an allowlist permits one property.

Details

at line 26
__construct(DataClassRepository $dataClasses)

Create a request query string partials resolver.

Parameters

DataClassRepository $dataClasses

at line 36
TransformationContextFactory resolve(BaseData|ResponsableData|BaseDataCollectable|ResponsableData $data, Request $request, TransformationContextFactory $contextFactory)

Apply allowed request partials to a transformation context factory.

at line 82
protected array resolvePaths(mixed $value, string $type, DataClass $dataClass, array $allowedPartials)

Resolve valid property-name paths from one request value.

Parameters

mixed $value
string $type
DataClass $dataClass
array $allowedPartials

Return Value

array

at line 126
protected array validateTree(PartialTree $partial, string $type, DataClass $dataClass, array $allowedPartials)

Validate a compiled partial tree against one data class.

Parameters

PartialTree $partial
string $type
DataClass $dataClass
array $allowedPartials

Return Value

array

at line 186
protected DataProperty|null findProperty(string $field, DataClass $dataClass)

Find a data property by its PHP or mapped output name.

Parameters

string $field
DataClass $dataClass

Return Value

DataProperty|null

at line 202
protected DataClass|null nestedDataClass(DataProperty $property)

Get the one nested data class represented by a property.

Parameters

DataProperty $property

Return Value

DataClass|null

at line 217
protected array|null allowedPartials(string $type, DataClass $dataClass, array $allowedPartials)

Resolve one class-owned allowlist once for this response.

Parameters

string $type
DataClass $dataClass
array $allowedPartials

Return Value

array|null

at line 246
protected bool allowsAll(array|null $allowed)

Determine whether an allowlist permits every property.

Parameters

array|null $allowed

Return Value

bool

at line 254
protected bool allows(array|null $allowed, string $property)

Determine whether an allowlist permits one property.

Parameters

array|null $allowed
string $property

Return Value

bool