Documentation

FieldsToSave implements ContainerAwareInterface, JsonSerializable Uses ContainerAwareTrait

Interfaces, Classes and Traits

ContainerAwareInterface
JsonSerializable

Table of Contents

$container  : Container
$fields  : array<string|int, mixed>
$id  : string|null
$operation  : mixed
$type  : Type
container()  : void
created()  : void
fields()  : FieldsToSave
getAttributes()  : array<string|int, Attribute>
getFieldNames()  : array<string|int, mixed>
getFields()  : array<string|int, mixed>
getId()  : string|null
getNestedField()  : FieldsToSave|array<string|int, FieldsToSave>
getOperation()  : string
getRelations()  : array<string|int, Relation>
getType()  : Type
hasField()  : bool
id()  : FieldsToSave
jsonSerialize()  : mixed
operation()  : FieldsToSave
typeClass()  : FieldsToSave
createNestedFields()  : FieldsToSave
getRelation()  : Relation
getTypeClassByName()  : string
hasAttribute()  : bool
hasRelation()  : bool
normalize()  : array<string|int, mixed>
filter out all non allowed fields from request

Properties

$operation

protected mixed $operation = AfeefaApiResourcesApiOperation::UPDATE

Methods

getAttributes()

public getAttributes() : array<string|int, Attribute>
Return values
array<string|int, Attribute>

getFieldNames()

public getFieldNames() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFields()

public getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getId()

public getId() : string|null
Return values
string|null

getOperation()

public getOperation() : string
Return values
string

hasField()

public hasField(string $fieldName) : bool
Parameters
$fieldName : string
Return values
bool

jsonSerialize()

public jsonSerialize() : mixed
Return values
mixed

createNestedFields()

protected createNestedFields(string $TypeClass, array<string|int, mixed> $fields) : FieldsToSave
Parameters
$TypeClass : string
$fields : array<string|int, mixed>
Return values
FieldsToSave

getTypeClassByName()

protected getTypeClassByName([string $typeName = null ]) : string
Parameters
$typeName : string = null
Return values
string

hasAttribute()

protected hasAttribute(string $name) : bool
Parameters
$name : string
Return values
bool

hasRelation()

protected hasRelation(string $name) : bool
Parameters
$name : string
Return values
bool

normalize()

filter out all non allowed fields from request

protected normalize(array<string|int, mixed> $fields) : array<string|int, mixed>
Parameters
$fields : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results