IndexSearch
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
Start processing a queue Typically this is where you would inject new messages into the queue
Process a QueueMessage
QueueableJob constructor.
This is disabled since we don't want users to accidentally run a queable job without knowing it
Mark the queue as having completed
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.
No description
No description
Messages to add to the queue.
Get Pages to add to the queue
Get a list of sites to remove from the search index
Get a list of files to remove from the search index
Get a list of users to remove from the search index
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
mixed
finish(Queue $q)
Finish processing a queue
void
processQueueItem(Message $msg)
Process a QueueMessage
__construct(IndexManagerInterface $indexManager, Connection $connection, ObjectManager $objectManager)
QueueableJob constructor.
This is here and empty since it'd be a BC break to remove it.
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
JobResult
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
protected Iterator
queueMessages()
Messages to add to the queue.
protected
clearExpressEntityIndex($id)
No description
protected
clearIndex($index)
Clear out all indexes.
protected Iterator
pagesToQueue()
Get Pages to add to the queue
protected Iterator
usersToQueue()
Get Users to add to the queue.
protected Iterator
expressObjectsToQueue()
Get Express objects to add to the queue.
protected Iterator
expressEntriesToQueue()
Get Express entries to add to the queue.
protected Iterator
filesToQueue()
Get Files to add to the queue.
protected Iterator
sitesToQueue()
Get Sites to add to the queue.
setApplication(Application $app)
Setter method for the application
protected int[]
sitesToRemove()
Get a list of sites to remove from the search index
protected int[]
filesToRemove()
Get a list of files to remove from the search index
protected int[]
usersToRemove()
Get a list of users to remove from the search index
protected
pagesToRemove()
Get a list of pages to be removed from the search index