Base class for document fields.
Properties¶
                 $name
            ¶
        $name
            ¶
    
        
        Field.php
                :
        25
                 
    
        Name of the document field. Will be used to query this field.
|  |  | 
                 $type
            ¶
        $type
            ¶
    
        
        Field.php
                :
        41
                 
    
        Type of the search field.
|  |  | 
                 $value
            ¶
        $value
            ¶
    
        
        Field.php
                :
        34
                 
    
        Value of the document field.
|  |  | 
Might be about anything depending on the type of the document field.
Methods¶
                 __construct()
            ¶
__construct()
            ¶
    
        
        Field.php
                :
        48
                 
    
        Construct object optionally with a set of properties.
|  |  | 
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $name | string | - | - | 
| $value | mixed | - | - | 
| $type | FieldType | - | - | 
                 getName()
            ¶
getName()
            ¶
    
        
        Field.php
                :
        56
                 
    
        |  |  | 
Return values
string
                 getType()
            ¶
getType()
            ¶
    
        
        Field.php
                :
        69
                 
    
        |  |  | 
Return values
                 getValue()
            ¶
getValue()
            ¶
    
        
        Field.php
                :
        64
                 
    
        |  |  | 
                 getProperties()
            ¶
getProperties()
            ¶
    
        
        ValueObject.php
                :
        54
                 
    
        Returns list of available properties' names.
|  |  | 
Override to add dynamic properties.
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $dynamicProperties | array<int, string> | [] | Additional dynamic properties exposed on the object | 
Return values
array<int, string>