ApacheSolrForTypo3\Solr\Task\OptimizeIndexTask

Complexity

Total Complexity

9

Size/Duplication

Total Lines	76
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getAdditionalInformation()	0	12	3
A	getCoresToOptimizeIndex()	0	3	1
A	setCoresToOptimizeIndex()	0	3	1
A	execute()	0	16	4

<?php

namespace ApacheSolrForTypo3\Solr\Task;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use ApacheSolrForTypo3\Solr\ConnectionManager;
use ApacheSolrForTypo3\Solr\NoSolrConnectionFoundException;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Scheduler task to empty the indexes of a site and re-initialize the
 * Solr Index Queue thus making the indexer re-index the site.
 *
 * @author Jens Jacobsen <typo3@jens-jacobsen.de>
 */
class OptimizeIndexTask extends AbstractSolrTask
{
    /**
     * Cores to optimize.
     *
     * @var array
     */
    protected $coresToOptimizeIndex = [];

    /**
     * Optimizes all Solr indexes for selected cores and returns TRUE if the execution was successful
     *
     * @return bool Returns TRUE on success, FALSE on failure.
     * @throws NoSolrConnectionFoundException
     * @noinspection PhpMissingReturnTypeInspection
     * @noinspection PhpUnused
     */
    public function execute()
    {
        $optimizeResult = true;
        $solrServers = GeneralUtility::makeInstance(ConnectionManager::class)->getConnectionsBySite($this->getSite());
        foreach ($solrServers as $solrServer) {
            $writeService = $solrServer->getWriteService();
            $corePath = $writeService->getCorePath();
            if (!in_array($corePath, $this->coresToOptimizeIndex)) {
                continue;
            }
            $result = $writeService->optimizeIndex();
            if ($result->getResponse()->getStatusCode() != 200) {
                $optimizeResult = false;
            }
        }
        return $optimizeResult;
    }

    /**
     * Gets the cores to optimize.
     *
     * @return array
     */
    public function getCoresToOptimizeIndex(): array
    {
        return $this->coresToOptimizeIndex;
    }

    /**
     * Sets the cores to optimize.
     *
     * @param array $coresToOptimizeIndex
     */
    public function setCoresToOptimizeIndex(array $coresToOptimizeIndex): void
    {
        $this->coresToOptimizeIndex = $coresToOptimizeIndex;
    }

    /**
     * This method is designed to return some additional information about the task,
     * that may help to set it apart from other tasks from the same class
     * This additional information is used - for example - in the Scheduler's BE module
     * This method should be implemented in most task classes
     *
     * @return string Information to display
     * @noinspection PhpMissingReturnTypeInspection
     */
    public function getAdditionalInformation()
    {
        $site = $this->getSite();
        if (is_null($site)) {
            return 'Invalid site configuration for scheduler please re-create the task!';
        }

        $information = 'Site: ' . $this->getSite()->getLabel();
        if (!empty($this->coresToOptimizeIndex)) {
            $information .= PHP_EOL . 'Corepaths: ' . implode(', ', $this->coresToOptimizeIndex);
        }
        return $information;
    }
}