Task.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Extbase\Scheduler;
 
/*
 * 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 ‪TYPO3\CMS\Core\Log\LogManager;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Mvc\Cli\CommandManager;
use ‪TYPO3\CMS\Extbase\Object\ObjectManager;
use ‪TYPO3\CMS\Scheduler\Task\AbstractTask;
 
class ‪Task extends ‪AbstractTask
{
    protected ‪$commandIdentifier;
 
    protected ‪$arguments = [];
 
    protected ‪$defaults = [];
 
    protected ‪$objectManager;
 
    protected ‪$commandManager;
 
    protected ‪$taskExecutor;
 
    public function ‪__construct()
    {
        parent::__construct();
        $this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
        $this->commandManager = $this->objectManager->get(CommandManager::class);
        $this->taskExecutor = $this->objectManager->get(TaskExecutor::class);
    }
 
    public function ‪__sleep()
    {
        $properties = get_object_vars($this);
        unset(
            $properties['commandManager'],
            $properties['objectManager'],
            $properties['taskExecutor'],
            $properties['logger']
        );
        return array_keys($properties);
    }
 
    public function ‪__wakeup()
    {
        $this->logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(__CLASS__);
        $this->objectManager = GeneralUtility::makeInstance(ObjectManager::class);
        $this->commandManager = $this->objectManager->get(CommandManager::class);
        $this->taskExecutor = $this->objectManager->get(TaskExecutor::class);
    }
 
    public function ‪execute()
    {
        try {
            $this->taskExecutor->execute($this);
        } catch (\Exception $e) {
            $this->‪logException($e);
            // Make sure the Scheduler gets exception details
            throw $e;
        }
        return true;
    }
 
    public function ‪setCommandIdentifier(‪$commandIdentifier)
    {
        $this->commandIdentifier = ‪$commandIdentifier;
    }
 
    public function ‪getCommandIdentifier()
    {
        return ‪$this->commandIdentifier;
    }
 
    public function ‪setArguments(‪$arguments)
    {
        $this->arguments = ‪$arguments;
    }
 
    public function ‪getArguments()
    {
        return ‪$this->arguments;
    }
 
    public function ‪setDefaults(array ‪$defaults)
    {
        $this->defaults = ‪$defaults;
    }
 
    public function ‪getDefaults()
    {
        return ‪$this->defaults;
    }
 
    public function ‪addDefaultValue($argumentName, $argumentValue)
    {
        if (is_bool($argumentValue)) {
            $argumentValue = (int)$argumentValue;
        }
        $this->defaults[$argumentName] = $argumentValue;
    }
 
    public function ‪getAdditionalInformation()
    {
        $label = ‪$this->commandIdentifier;
        if (!empty($this->arguments)) {
            ‪$arguments = [];
            foreach ($this->arguments as $argumentName => $argumentValue) {
                if (!isset($this->defaults[$argumentName]) || $argumentValue != $this->defaults[$argumentName]) {
                    ‪$arguments[] = $argumentName . '=' . $argumentValue;
                }
            }
            $label .= ' ' . implode(', ', ‪$arguments);
        }
        return $label;
    }
 
    protected function ‪logException(\‪Exception $e)
    {
        $this->logger->error('A Task (' . $this->commandIdentifier . ') Exception was captured: ' . $e->getMessage() . ' (' . $e->getCode() . ')', ['exception' => $e]);
    }
}