AirLay backend

Field
in package
implements JsonSerializable, Persistable

Interfaces, Classes, Traits and Enums

JsonSerializable
Persistable

Table of Contents

ALLOWED_TYPES  = ['number', 'string', 'media', 'boolean', 'object', 'date', 'alias']
$alias  : string
$defaultValue  : mixed
$guideId  : ObjectId|null
$name  : string
$required  : bool
$type  : string
__construct()  : mixed
bsonSerialize()  : array<string|int, mixed>
bsonUnserialize()  : void
fromArray()  : Field
getAlias()  : string
getDefaultValue()  : mixed
getGuideId()  : ObjectId|null
getName()  : string
getType()  : string
isRequired()  : bool
jsonSerialize()  : array<string|int, mixed>
setDefaultValue()  : Field
setGuideId()  : self
toArray()  : array<string|int, mixed>
ValidateDefaultValue()  : void

Constants

ALLOWED_TYPES

private mixed ALLOWED_TYPES = ['number', 'string', 'media', 'boolean', 'object', 'date', 'alias']

Properties

$alias

private string $alias = ''

$defaultValue

private mixed $defaultValue

$guideId

private ObjectId|null $guideId = null

$required

private bool $required

Methods

__construct()

public __construct(string $name, string $type, bool $required, mixed $defaultValue[, ObjectId|null $guideId = null ][, string $alias = '' ]) : mixed
Parameters
$name : string
$type : string
$required : bool
$defaultValue : mixed
$guideId : ObjectId|null = null
$alias : string = ''
Return values
mixed —

bsonSerialize()

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

bsonUnserialize()

public bsonUnserialize(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>
Return values
void —

fromArray()

public static fromArray(array<string|int, mixed> $data) : Field
Parameters
$data : array<string|int, mixed>
Return values
Field —

getAlias()

public getAlias() : string
Return values
string —

getDefaultValue()

public getDefaultValue() : mixed
Return values
mixed —

getGuideId()

public getGuideId() : ObjectId|null
Return values
ObjectId|null —

getName()

public getName() : string
Return values
string —

getType()

public getType() : string
Return values
string —

isRequired()

public isRequired() : bool
Return values
bool —

jsonSerialize()

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

setDefaultValue()

public setDefaultValue(mixed $defaultValue) : Field
Parameters
$defaultValue : mixed
Return values
Field —

setGuideId()

public setGuideId(ObjectId|null $guideId) : self
Parameters
$guideId : ObjectId|null
Return values
self —

toArray()

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

ValidateDefaultValue()

private static ValidateDefaultValue(string $type, mixed $value) : void
Parameters
$type : string
$value : mixed
Return values
void —

Search results