Copied!

StringField

StringField.php : 14
Extends FieldType

String document field.

Properties

public $boost

FieldType.php : 44

The importance of that field (boost factor).

public int $boost = 1

public $highlight

FieldType.php : 37

Whether highlighting should be performed for this field on result documents.

public bool $highlight = false

public $inResult

FieldType.php : 58

Whether the field should be a part of the resulting document.

public bool $inResult = true

public $multiValue

FieldType.php : 51

Whether the field supports multiple values.

public bool $multiValue = false

public $name

FieldType.php : 23

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

public string $name

public $type read-only

FieldType.php
public string $type

[deprecated] The type name of the facet, deprecated - use FieldType::getType instead.

protected $type

StringField.php : 21

The type name of the facet. Has to be handled by the solr schema.

protected string $type = 'ez_string'

Methods

public__construct()

ValueObject.php : 30

Construct object optionally with a set of properties.

public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

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

publicgetType()

FieldType.php : 60
public getType() : string

Return values

string

protectedgetProperties()

ValueObject.php : 50

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>