SilverStripe Search

SolrIndexJob extends AbstractQueuedJob
in package

Class SolrIndexJob is a queued job to index all existing indexes and their classes.

It always runs on all indexes, to make sure all indexes are up to date.

Table of Contents

Properties

$classToIndex  : array<string|int, mixed>
The class that should be indexed.
$indexes  : array<string|int, mixed>
The indexes that need to run.

Methods

afterComplete()  : mixed
Set up the next job if needed
getClassToIndex()  : array<string|int, mixed>
Which Indexes should I index
getIndexes()  : array<string|int, mixed>
Get the indexes
getTitle()  : string
My name
process()  : self
Process this job
setClassToIndex()  : SolrIndexJob
Which classes should I index
setIndexes()  : SolrIndexJob
Set the indexes if needed
configureRun()  : mixed
Configure the run for the valid indexes
getNextSteps()  : array<string|int, mixed>
Get the next step to execute

Properties

$classToIndex

The class that should be indexed.

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

If set, the task should run the given class with the given group The class should be popped off the array at the end of each subset so the next class becomes the class to index.

Rinse and repeat for each class in the index, until this array is empty

$indexes

The indexes that need to run.

protected array<string|int, mixed> $indexes

Methods

afterComplete()

Set up the next job if needed

public afterComplete() : mixed

getClassToIndex()

Which Indexes should I index

public getClassToIndex() : array<string|int, mixed>
Return values
array<string|int, mixed>

getIndexes()

Get the indexes

public getIndexes() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTitle()

My name

public getTitle() : string
Return values
string

process()

Process this job

public process() : self
Tags
throws
Exception
throws
HTTPException
Return values
self

setClassToIndex()

Which classes should I index

public setClassToIndex(array<string|int, mixed> $classToIndex) : SolrIndexJob
Parameters
$classToIndex : array<string|int, mixed>
Return values
SolrIndexJob

setIndexes()

Set the indexes if needed

public setIndexes(array<string|int, mixed> $indexes) : SolrIndexJob
Parameters
$indexes : array<string|int, mixed>
Return values
SolrIndexJob

configureRun()

Configure the run for the valid indexes

protected configureRun(stdClass|null $data) : mixed
Parameters
$data : stdClass|null

getNextSteps()

Get the next step to execute

protected getNextSteps() : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results