Base class for document fields.
Properties¶
                
        $name
            ¶
    
        
        Field.php
                :
        26
                
    
        Name of the document field. Will be used to query this field.
| 
                     | 
                
                    
                     | 
            
                
        $type
            ¶
    
        
        Field.php
                :
        42
                
    
        Type of the search field.
| 
                     | 
                
                    
                     | 
            
                
        $value
            ¶
    
        
        Field.php
                :
        35
                
    
        Value of the document field.
| 
                     | 
                
                    
                     | 
            
Might be about anything depending on the type of the document field.
Methods¶
                
__construct()
            ¶
    
        
        Field.php
                :
        49
                
    
        Construct object optionally with a set of properties.
| 
                     | 
                
                    
                     | 
            
Parameters
| Name | Type | Default value | Description | 
|---|---|---|---|
| $name | string | - | - | 
| $value | mixed | - | - | 
| $type | FieldType | - | - | 
                
getName()
            ¶
    
        
        Field.php
                :
        57
                
    
        | 
                     | 
                
                    
                     | 
            
Return values
string
                
getType()
            ¶
    
        
        Field.php
                :
        70
                
    
        | 
                     | 
                
                    
                     | 
            
Return values
                
getValue()
            ¶
    
        
        Field.php
                :
        65
                
    
        | 
                     | 
                
                    
                     | 
            
                
getProperties()
            ¶
    
        
        ValueObject.php
                :
        53
                
    
        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>
Attributes
- #[Ignore]