first commit
This commit is contained in:
Sven Wappler
180
Classes/Task/IndexQueueWorkerTaskAdditionalFieldProvider.php
Normal file
180
Classes/Task/IndexQueueWorkerTaskAdditionalFieldProvider.php
Normal file
@@ -0,0 +1,180 @@
|
||||
<?php
|
||||
namespace WapplerSystems\Meilisearch\Task;
|
||||
|
||||
/***************************************************************
|
||||
* Copyright notice
|
||||
*
|
||||
* (c) 2009-2015 Ingo Renner <ingo@typo3.org>
|
||||
* All rights reserved
|
||||
*
|
||||
* This script is part of the TYPO3 project. The TYPO3 project is
|
||||
* free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* The GNU General Public License can be found at
|
||||
* http://www.gnu.org/copyleft/gpl.html.
|
||||
*
|
||||
* This script is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* This copyright notice MUST APPEAR in all copies of the script!
|
||||
***************************************************************/
|
||||
|
||||
use WapplerSystems\Meilisearch\Backend\SiteSelectorField;
|
||||
use WapplerSystems\Meilisearch\Domain\Site\SiteRepository;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Scheduler\AdditionalFieldProviderInterface;
|
||||
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;
|
||||
use TYPO3\CMS\Scheduler\Task\AbstractTask;
|
||||
use TYPO3\CMS\Scheduler\Task\Enumeration\Action;
|
||||
|
||||
/**
|
||||
* Additional field provider for the index queue worker task
|
||||
*
|
||||
* @author Ingo Renner <ingo@typo3.org>
|
||||
*/
|
||||
class IndexQueueWorkerTaskAdditionalFieldProvider implements AdditionalFieldProviderInterface
|
||||
{
|
||||
|
||||
/**
|
||||
* SiteRepository
|
||||
*
|
||||
* @var SiteRepository
|
||||
*/
|
||||
protected $siteRepository;
|
||||
|
||||
public function __construct()
|
||||
{
|
||||
$this->siteRepository = GeneralUtility::makeInstance(SiteRepository::class);
|
||||
}
|
||||
|
||||
/**
|
||||
* Used to define fields to provide the TYPO3 site to index and number of
|
||||
* items to index per run when adding or editing a task.
|
||||
*
|
||||
* @param array $taskInfo reference to the array containing the info used in the add/edit form
|
||||
* @param AbstractTask $task when editing, reference to the current task object. Null when adding.
|
||||
* @param SchedulerModuleController $schedulerModule : reference to the calling object (Scheduler's BE module)
|
||||
* @return array Array containing all the information pertaining to the additional fields
|
||||
* The array is multidimensional, keyed to the task class name and each field's id
|
||||
* For each field it provides an associative sub-array with the following:
|
||||
*/
|
||||
public function getAdditionalFields(
|
||||
array &$taskInfo,
|
||||
$task,
|
||||
SchedulerModuleController $schedulerModule
|
||||
) {
|
||||
/** @var $task IndexQueueWorkerTask */
|
||||
$additionalFields = [];
|
||||
$siteSelectorField = GeneralUtility::makeInstance(SiteSelectorField::class);
|
||||
|
||||
if (!$this->isTaskInstanceofIndexQueueWorkerTask($task)) {
|
||||
return $additionalFields;
|
||||
}
|
||||
|
||||
$currentAction = $schedulerModule->getCurrentAction();
|
||||
if ($currentAction->equals(Action::ADD)) {
|
||||
$taskInfo['site'] = null;
|
||||
$taskInfo['documentsToIndexLimit'] = 50;
|
||||
$taskInfo['forcedWebRoot'] = '';
|
||||
}
|
||||
|
||||
if ($currentAction->equals(Action::EDIT)) {
|
||||
$taskInfo['site'] = $this->siteRepository->getSiteByRootPageId($task->getRootPageId());
|
||||
$taskInfo['documentsToIndexLimit'] = $task->getDocumentsToIndexLimit();
|
||||
$taskInfo['forcedWebRoot'] = $task->getForcedWebRoot();
|
||||
}
|
||||
|
||||
$additionalFields['site'] = [
|
||||
'code' => $siteSelectorField->getAvailableSitesSelector('tx_scheduler[site]',
|
||||
$taskInfo['site']),
|
||||
'label' => 'LLL:EXT:meilisearch/Resources/Private/Language/locallang.xlf:field_site',
|
||||
'cshKey' => '',
|
||||
'cshLabel' => ''
|
||||
];
|
||||
|
||||
$additionalFields['documentsToIndexLimit'] = [
|
||||
'code' => '<input type="number" class="form-control" name="tx_scheduler[documentsToIndexLimit]" value="' . htmlspecialchars($taskInfo['documentsToIndexLimit']) . '" />',
|
||||
'label' => 'LLL:EXT:meilisearch/Resources/Private/Language/locallang.xlf:indexqueueworker_field_documentsToIndexLimit',
|
||||
'cshKey' => '',
|
||||
'cshLabel' => ''
|
||||
];
|
||||
|
||||
$additionalFields['forcedWebRoot'] = [
|
||||
'code' => '<input type="text" class="form-control" name="tx_scheduler[forcedWebRoot]" value="' . htmlspecialchars($taskInfo['forcedWebRoot']) . '" />',
|
||||
'label' => 'LLL:EXT:meilisearch/Resources/Private/Language/locallang.xlf:indexqueueworker_field_forcedWebRoot',
|
||||
'cshKey' => '',
|
||||
'cshLabel' => ''
|
||||
];
|
||||
|
||||
return $additionalFields;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks any additional data that is relevant to this task. If the task
|
||||
* class is not relevant, the method is expected to return TRUE
|
||||
*
|
||||
* @param array $submittedData reference to the array containing the data submitted by the user
|
||||
* @param SchedulerModuleController $schedulerModule reference to the calling object (Scheduler's BE module)
|
||||
* @return bool True if validation was ok (or selected class is not relevant), FALSE otherwise
|
||||
*/
|
||||
public function validateAdditionalFields(
|
||||
array &$submittedData,
|
||||
SchedulerModuleController $schedulerModule
|
||||
) {
|
||||
$result = false;
|
||||
|
||||
// validate site
|
||||
$sites = $this->siteRepository->getAvailableSites();
|
||||
if (array_key_exists($submittedData['site'], $sites)) {
|
||||
$result = true;
|
||||
}
|
||||
|
||||
// escape limit
|
||||
$submittedData['documentsToIndexLimit'] = intval($submittedData['documentsToIndexLimit']);
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Saves any additional input into the current task object if the task
|
||||
* class matches.
|
||||
*
|
||||
* @param array $submittedData array containing the data submitted by the user
|
||||
* @param AbstractTask $task reference to the current task object
|
||||
*/
|
||||
public function saveAdditionalFields(
|
||||
array $submittedData,
|
||||
AbstractTask $task
|
||||
) {
|
||||
if (!$this->isTaskInstanceofIndexQueueWorkerTask($task)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$task->setRootPageId($submittedData['site']);
|
||||
$task->setDocumentsToIndexLimit($submittedData['documentsToIndexLimit']);
|
||||
$task->setForcedWebRoot($submittedData['forcedWebRoot']);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check that a task is an instance of IndexQueueWorkerTask
|
||||
*
|
||||
* @param AbstractTask $task
|
||||
* @return boolean
|
||||
* @throws \LogicException
|
||||
*/
|
||||
protected function isTaskInstanceofIndexQueueWorkerTask($task)
|
||||
{
|
||||
if ((!is_null($task)) && (!($task instanceof IndexQueueWorkerTask))) {
|
||||
throw new \LogicException(
|
||||
'$task must be an instance of IndexQueueWorkerTask, '
|
||||
.'other instances are not supported.', 1487499814
|
||||
);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user