Command.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Extbase\Mvc\Cli;
 
/*
 * 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\Extbase\Reflection\ClassSchema;
 
class ‪Command
{
    protected ‪$objectManager;
 
    protected ‪$controllerClassName;
 
    protected ‪$controllerCommandName;
 
    protected ‪$commandIdentifier;
 
    protected ‪$extensionName;
 
    protected ‪$reflectionService;
 
    protected ‪$classSchema;
 
    protected ‪$controllerCommandMethod;
 
    public function ‪injectObjectManager(\‪TYPO3\CMS\‪Extbase\Object\ObjectManagerInterface ‪$objectManager)
    {
        $this->objectManager = ‪$objectManager;
    }
 
    public function ‪injectReflectionService(\‪TYPO3\CMS\‪Extbase\Reflection\ReflectionService ‪$reflectionService)
    {
        $this->reflectionService = ‪$reflectionService;
    }
 
    public function ‪__construct(‪$controllerClassName, ‪$controllerCommandName)
    {
        $this->controllerClassName = ‪$controllerClassName;
        $this->controllerCommandName = ‪$controllerCommandName;
        $this->controllerCommandMethod = $this->controllerCommandName . 'Command';
        $classNameParts = explode('\\', ‪$controllerClassName);
        if (isset($classNameParts[0]) && $classNameParts[0] === 'TYPO3' && isset($classNameParts[1]) && $classNameParts[1] === 'CMS') {
            $classNameParts[0] .= '\\' . $classNameParts[1];
            unset($classNameParts[1]);
            $classNameParts = array_values($classNameParts);
        }
        $numberOfClassNameParts = count($classNameParts);
        if ($numberOfClassNameParts < 3) {
            throw new \InvalidArgumentException(
                'Controller class names must at least consist of three parts: vendor, extension name and path.',
                1438782187
            );
        }
        if (strpos($classNameParts[$numberOfClassNameParts - 1], 'CommandController') === false) {
            throw new \InvalidArgumentException(
                'Invalid controller class name "' . ‪$controllerClassName . '". Class name must end with "CommandController".',
                1305100019
            );
        }
 
        $this->extensionName = $classNameParts[1];
        $extensionKey = \TYPO3\CMS\Core\Utility\GeneralUtility::camelCaseToLowerCaseUnderscored($this->extensionName);
        $this->commandIdentifier = strtolower($extensionKey . ':' . substr($classNameParts[$numberOfClassNameParts - 1], 0, -17) . ':' . ‪$controllerCommandName);
    }
 
    public function ‪initializeObject()
    {
        $this->classSchema = $this->reflectionService->getClassSchema($this->controllerClassName);
    }
 
    public function ‪getControllerClassName()
    {
        return ‪$this->controllerClassName;
    }
 
    public function ‪getControllerCommandName()
    {
        return ‪$this->controllerCommandName;
    }
 
    public function ‪getCommandIdentifier()
    {
        return ‪$this->commandIdentifier;
    }
 
    public function ‪getExtensionName()
    {
        return ‪$this->extensionName;
    }
 
    public function ‪getShortDescription()
    {
        $lines = explode(LF, $this->classSchema->getMethod($this->controllerCommandMethod)['description']);
        return !empty($lines) ? trim($lines[0]) : '<no description available>';
    }
 
    public function ‪getDescription()
    {
        $lines = explode(LF, $this->classSchema->getMethod($this->controllerCommandMethod)['description']);
        array_shift($lines);
        $descriptionLines = [];
        foreach ($lines as $line) {
            $trimmedLine = trim($line);
            if ($descriptionLines !== [] || $trimmedLine !== '') {
                $descriptionLines[] = $trimmedLine;
            }
        }
        return implode(LF, $descriptionLines);
    }
 
    public function ‪hasArguments()
    {
        return !empty($this->classSchema->getMethod($this->controllerCommandMethod)['params']);
    }
 
    public function ‪getArgumentDefinitions()
    {
        if (!$this->‪hasArguments()) {
            return [];
        }
        $commandArgumentDefinitions = [];
        $commandParameters = $this->classSchema->getMethod($this->controllerCommandMethod)['params'];
        $commandParameterTags = $this->classSchema->getMethod($this->controllerCommandMethod)['tags']['param'];
        $i = 0;
        foreach ($commandParameters as $commandParameterName => $commandParameterDefinition) {
            $explodedAnnotation = preg_split('/\s+/', $commandParameterTags[$i], 3);
            $description = !empty($explodedAnnotation[2]) ? $explodedAnnotation[2] : '';
            $required = $commandParameterDefinition['optional'] !== true;
            $commandArgumentDefinitions[] = $this->objectManager->get(\‪TYPO3\CMS\‪Extbase\Mvc\Cli\CommandArgumentDefinition::class, $commandParameterName, $required, $description);
            $i++;
        }
        return $commandArgumentDefinitions;
    }
 
    public function ‪isInternal()
    {
        return isset($this->classSchema->getMethod($this->controllerCommandMethod)['tags']['internal']);
    }
 
    public function ‪isCliOnly()
    {
        return isset($this->classSchema->getMethod($this->controllerCommandMethod)['tags']['cli']);
    }
 
    public function ‪isFlushingCaches()
    {
        trigger_error(
            'Method isFlushingCaches() will be removed in TYPO3 v10.0. Do not call from other extension.',
            E_USER_DEPRECATED
        );
        return isset($this->classSchema->getMethod($this->controllerCommandMethod)['tags']['flushesCaches']);
    }
 
    public function ‪getRelatedCommandIdentifiers()
    {
        if (!isset($this->classSchema->getMethod($this->controllerCommandMethod)['tags']['see'])) {
            return [];
        }
        $relatedCommandIdentifiers = [];
        foreach ($this->classSchema->getMethod($this->controllerCommandMethod)['tags']['see'] as $tagValue) {
            if (preg_match('/^[\\w\\d\\.]+:[\\w\\d]+:[\\w\\d]+$/', $tagValue) === 1) {
                $relatedCommandIdentifiers[] = $tagValue;
            }
        }
        return $relatedCommandIdentifiers;
    }
}