SilverStripe Search

BaseService
in package
Uses Configurable

Table of Contents

Constants

CLASS_ID_FIELD  = 'ObjectID'
SilverStripe ID of the object
CLASSNAME  = 'ClassName'
Name of the field that can be used for queries
ID_FIELD  = 'id'
Unique ID in Search engine

Properties

$baseIndexes  : array<string|int, mixed>
$validIndexes  : array<string|int, mixed>

Methods

__construct()  : mixed
getValidIndexes()  : array<string|int, mixed>
setValidIndexes()  : void
checkReflection()  : bool
Check if the class is instantiable
filterIndexes()  : void
Filter enabled indexes down to valid indexes that can be instantiated or are allowed from config

Constants

CLASS_ID_FIELD

SilverStripe ID of the object

public mixed CLASS_ID_FIELD = 'ObjectID'

CLASSNAME

Name of the field that can be used for queries

public mixed CLASSNAME = 'ClassName'

ID_FIELD

Unique ID in Search engine

public mixed ID_FIELD = 'id'

Properties

$baseIndexes

protected array<string|int, mixed> $baseIndexes = []

Base indexes that exist

$validIndexes

protected array<string|int, mixed> $validIndexes = []

Valid indexes out of the base indexes

Methods

__construct()

public __construct(mixed $baseIndexClass) : mixed
Parameters
$baseIndexClass : mixed
Tags
throws
ReflectionException

getValidIndexes()

public getValidIndexes([mixed $index = null ]) : array<string|int, mixed>
Parameters
$index : mixed = null
Return values
array<string|int, mixed>

setValidIndexes()

public setValidIndexes(array<string|int, mixed> $validIndexes) : void
Parameters
$validIndexes : array<string|int, mixed>

checkReflection()

Check if the class is instantiable

protected checkReflection( $subindex) : bool
Parameters
$subindex :
Tags
throws
ReflectionException
Return values
bool

filterIndexes()

Filter enabled indexes down to valid indexes that can be instantiated or are allowed from config

protected filterIndexes() : void
Tags
throws
ReflectionException

        
On this page

Search results