class IndexSearch extends IndexSearchAll implements ApplicationAwareInterface (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Constants

CLEAR

CLEAR_EXPRESS_ENTITY

Properties

$jQueueBatchSize from  IndexSearchAll
protected Queue $jQueueObject from  QueueableJob
$jNotUninstallable from  IndexSearchAll
$jSupportsQueue from  IndexSearchAll
protected array $result from  IndexSearchAll
protected $clearTable
protected $indexManager from  IndexSearchAll
protected Connection $connection from  IndexSearchAll
protected ObjectManager $objectManager from  IndexSearchAll
protected Application $app from  ApplicationAwareTrait

Methods

mixed
start(Queue $queue)

Start processing a queue Typically this is where you would inject new messages into the queue

mixed
finish(Queue $q)

Finish processing a queue

void
processQueueItem(Message $msg)

Process a QueueMessage

__construct(IndexManagerInterface $indexManager, Connection $connection, ObjectManager $objectManager)

QueueableJob constructor.

run()

This is disabled since we don't want users to accidentally run a queable job without knowing it

int
getJobQueueBatchSize()

Get the size of the queue batches

Queue
getQueueObject()

Get the queue object we're going to use to queue

reset()

Delete the queue

markStarted()

Mark the queue as started

markCompleted(int $code = 0, bool $message = false)

Mark the queue as having completed

executeJob()

Executejob for queueable jobs actually starts the queue, runs, and ends all in one function. This happens if we run a job in legacy mode.

executeBatch(array|iterator $batch, Queue $queue)

Process a queue batch

getJobName()

No description

getJobDescription()

No description

queueMessages()

Messages to add to the queue.

clearExpressEntityIndex($id)

No description

clearIndex($index)

Clear out all indexes.

pagesToQueue()

Get Pages to add to the queue

usersToQueue()

Get Users to add to the queue.

expressObjectsToQueue()

Get Express objects to add to the queue.

expressEntriesToQueue()

Get Express entries to add to the queue.

filesToQueue()

Get Files to add to the queue.

sitesToQueue()

Get Sites to add to the queue.

setApplication(Application $app)

Setter method for the application

int[]
sitesToRemove()

Get a list of sites to remove from the search index

int[]
filesToRemove()

Get a list of files to remove from the search index

int[]
usersToRemove()

Get a list of users to remove from the search index

pagesToRemove()

Get a list of pages to be removed from the search index

Details

mixed start(Queue $queue)

Start processing a queue Typically this is where you would inject new messages into the queue

Parameters

Queue $queue

Return Value

mixed

mixed finish(Queue $q)

Finish processing a queue

Parameters

Queue $q

Return Value

mixed

void processQueueItem(Message $msg)

Process a QueueMessage

Parameters

Message $msg

Return Value

void

__construct(IndexManagerInterface $indexManager, Connection $connection, ObjectManager $objectManager)

QueueableJob constructor.

This is here and empty since it'd be a BC break to remove it.

Parameters

IndexManagerInterface $indexManager
Connection $connection
ObjectManager $objectManager

run()

This is disabled since we don't want users to accidentally run a queable job without knowing it

int getJobQueueBatchSize()

Get the size of the queue batches

Return Value

int

Queue getQueueObject()

Get the queue object we're going to use to queue

Return Value

Queue

reset()

Delete the queue

markStarted()

Mark the queue as started

JobResult markCompleted(int $code = 0, bool $message = false)

Mark the queue as having completed

Parameters

int $code

0 for success, otherwise the exception error code

bool $message

The message to show

Return Value

JobResult

executeJob()

Executejob for queueable jobs actually starts the queue, runs, and ends all in one function. This happens if we run a job in legacy mode.

executeBatch(array|iterator $batch, Queue $queue)

Process a queue batch

Parameters

array|iterator $batch
Queue $queue

getJobName()

No description

getJobDescription()

No description

protected Iterator queueMessages()

Messages to add to the queue.

Return Value

Iterator

protected clearExpressEntityIndex($id)

No description

Parameters

$id

protected clearIndex($index)

Clear out all indexes.

Parameters

$index

protected Iterator pagesToQueue()

Get Pages to add to the queue

Return Value

Iterator

protected Iterator usersToQueue()

Get Users to add to the queue.

Return Value

Iterator

protected Iterator expressObjectsToQueue()

Get Express objects to add to the queue.

Return Value

Iterator

protected Iterator expressEntriesToQueue()

Get Express entries to add to the queue.

Return Value

Iterator

protected Iterator filesToQueue()

Get Files to add to the queue.

Return Value

Iterator

protected Iterator sitesToQueue()

Get Sites to add to the queue.

Return Value

Iterator

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

protected int[] sitesToRemove()

Get a list of sites to remove from the search index

Return Value

int[]

protected int[] filesToRemove()

Get a list of files to remove from the search index

Return Value

int[]

protected int[] usersToRemove()

Get a list of users to remove from the search index

Return Value

int[]

protected pagesToRemove()

Get a list of pages to be removed from the search index