phpDocumentor\Console\Command\Template\ListCommand

Complexity

Total Complexity

4

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	configure()	0	14	1
A	execute()	0	11	2

<?php
declare(strict_types=1);

/**
 * This file is part of phpDocumentor.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @author    Mike van Riel <mike.vanriel@naenius.com>
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Console\Command\Template;

use Symfony\Component\Console\Command\Command;
use \Symfony\Component\Console\Input\InputInterface;
use \Symfony\Component\Console\Output\OutputInterface;
use phpDocumentor\Transformer\Template\Factory;

/**
 * Lists all templates known to phpDocumentor.
 */
class ListCommand extends Command
{
    /** @var Factory Template factory providing all known template definitions */
    private $factory;

    /**
     * Initializes this command with its dependencies.
     */
    public function __construct(Factory $factory)
    {
        parent::__construct('template:list');

        $this->factory = $factory;
    }

    /**
     * Initializes this command and sets the name, description, options and arguments.
     */
    protected function configure(): void
    {
        $this->setName('template:list')
            ->setDescription(
                'Displays a listing of all available templates in phpDocumentor'
            )
            ->setHelp(
                <<<HELP
                This task outputs a list of templates as available in phpDocumentor.
                Please mind that custom templates which are situated outside phpDocumentor are not
                shown in this listing.
HELP
            );
    }

    /**
     * Retrieves all template names from the Template Factory and sends those to stdout.
     */
    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $output->writeln('Available templates:');
        foreach ($this->factory->getAllNames() as $template_name) {
            $output->writeln('* ' . $template_name);
        }

        $output->writeln('');

        return 0;
    }
}