silverstripe / silverstripe-fulltextsearch

src/Search/Processors/SearchUpdateQueuedJobProcessor.php

<?php

namespace SilverStripe\FullTextSearch\Search\Processors;

use SilverStripe\Core\Config\Config;
use stdClass;
use Symbiote\QueuedJobs\Services\QueuedJob;
use Symbiote\QueuedJobs\Services\QueuedJobService;

if (!interface_exists(QueuedJob::class)) {
    return;
}

class SearchUpdateQueuedJobProcessor extends SearchUpdateBatchedProcessor implements QueuedJob
{
    /**
     * The QueuedJob queue to use when processing updates
     * @config
     * @var string
     */
    private static $reindex_queue = QueuedJob::QUEUED;

    protected $messages = array();

    public function triggerProcessing()
    {
        parent::triggerProcessing();
        singleton(QueuedJobService::class)->queueJob($this);
    }

    public function getTitle()
    {
        return "FullTextSearch Update Job";
    }

    public function getSignature()
    {
        return md5(get_class($this) . time() . mt_rand(0, 100000));
    }

    public function getJobType()
    {
        return Config::inst()->get(__CLASS__, 'reindex_queue');
    }

    public function jobFinished()
    {
        return $this->currentBatch >= count($this->batches);
    }

    public function setup()
    {
        // NOP
    }

    public function prepareForRestart()
    {
        // NOP
    }

    public function afterComplete()
    {
        // Once indexing is complete, commit later in order to avoid solr limits
        // see http://stackoverflow.com/questions/7512945/how-to-fix-exceeded-limit-of-maxwarmingsearchers
        SearchUpdateCommitJobProcessor::queue();
    }

    public function getJobData()
    {
        $data = new stdClass();
        $data->totalSteps = count($this->batches);
        $data->currentStep = $this->currentBatch;
        $data->isComplete = $this->jobFinished();
        $data->messages = $this->messages;

        $data->jobData = new stdClass();
        $data->jobData->batches = $this->batches;
        $data->jobData->currentBatch = $this->currentBatch;

        return $data;
    }

    public function setJobData($totalSteps, $currentStep, $isComplete, $jobData, $messages)
    {
        $this->isComplete = $isComplete;

The property isComplete does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $this->messages = $messages;

        $this->batches = $jobData->batches;
        $this->currentBatch = $jobData->currentBatch;
    }

    public function addMessage($message, $severity = 'INFO')
    {
        $severity = strtoupper($severity);
        $this->messages[] = '[' . date('Y-m-d H:i:s') . "][$severity] $message";
    }

    public function process()
    {
        $result = parent::process();

        if ($this->jobFinished()) {
            $this->addMessage("All batched updates complete. Queuing commit job");
        }

        return $result;
    }
}