Copied!

Field

Field.php : 18
Extends ValueObject

Base class for document fields.

Properties

public $name read-only

Field.php 
public string $name

protected $name

Field.php : 25

Name of the document field. Will be used to query this field.

 
protected string $name

public $type read-only

Field.php 
public FieldType $type

protected $type

Field.php : 41

Type of the search field.

 
protected FieldType $type

public $value read-only

Field.php 
public mixed $value

protected $value

Field.php : 34

Value of the document field.

 
protected mixed $value

Might be about anything depending on the type of the document field.

Methods

public__construct()

Field.php : 48

Construct object optionally with a set of properties.

 
public __construct(string $name, mixed $value, FieldType $type)

Parameters

Name Type Default value Description
$name string - -
$value mixed - -
$type FieldType - -

publicgetName()

Field.php : 56 
public getName() : string

Return values

string

publicgetType()

Field.php : 69 
public getType() : FieldType

Return values

FieldType

publicgetValue()

Field.php : 64 
public getValue() : mixed

protectedgetProperties()

ValueObject.php : 53

Function where list of properties are returned.

 
protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name Type Default value Description
$dynamicProperties array<string|int, mixed> []

Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>

Tags
Serializerignore

()