Gerrie\Command\GerrieBaseCommand

Complexity

Total Complexity

6

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes	6
Bugs	0	Features	3

6 Methods

Rating	Name	Duplication	Size	Complexity
A	addConfigFileOption()	0	9	1
A	addDatabaseOptions()	0	9	1
A	addSSHKeyOption()	0	9	1
A	addSetupDatabaseOption()	0	9	1
A	addDebugOption()	0	9	1
A	addInstancesArgument()	0	8	1

<?php
/**
 * This file is part of the Gerrie package.
 *
 * (c) Andreas Grunwald <andygrunwald@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Gerrie\Command;

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;

class GerrieBaseCommand extends Command
{
    /**
     * Adds the --config-file / -c option to the command.
     *
     * @return void
     */
    protected function addConfigFileOption()
    {
        $this->addOption(
            'config-file',
            'c',
            InputOption::VALUE_REQUIRED,
            'Path to configuration file.'
        );
    }

    /**
     * Adds several options for database connections to the command.
     *
     * @return void
     */
    protected function addDatabaseOptions()
    {
        $this
            ->addOption('database-host', 'H', InputOption::VALUE_REQUIRED, 'Name / IP of the host where the database is running.')
            ->addOption('database-user', 'u', InputOption::VALUE_REQUIRED, 'Username to access the database.')
            ->addOption('database-pass', 'p', InputOption::VALUE_REQUIRED, 'Password to access the database.')
            ->addOption('database-port', 'P', InputOption::VALUE_REQUIRED, 'Port where the database is listen.')
            ->addOption('database-name', 'N', InputOption::VALUE_REQUIRED, 'Name of the database which should be used.');
    }

    /**
     * Adds the SSH Key option to the command.
     *
     * @return void
     */
    protected function addSSHKeyOption()
    {
        $this->addOption(
            'ssh-key',
            'k',
            InputOption::VALUE_REQUIRED,
            'Path to SSH private key for authentication via SSH API.'
        );
    }

    /**
     * Adds the "setup-database-tables" option.
     *
     * @return void
     */
    protected function addSetupDatabaseOption()
    {
        $this->addOption(
            'setup-database-tables',
            's',
            InputOption::VALUE_NONE,
            'Checks if necessary tables are already there. If not this tables will be setted up.'
        );
    }

    /**
     * Adds the "debug" option.
     * This option enables various debug functionalities like
     * * Check if every data key received by Gerrit is proceeded by Gerrie
     * * Check if an update was processed if the server is crawled the first time
     *
     * @return void
     */
    protected function addDebugOption()
    {
        $this->addOption(
            'debug',
            'd',
            InputOption::VALUE_NONE,
            'Enables debug functionality.'
        );
    }

    /**
     * Adds a argument of a possible list of instances.
     *
     * Format: scheme://username[:password]@host[:port]/
     * Examples:
     *  * ssh://max.mustermann@review.typo3.org:29418/';
     *  * https://max.mustermann:dummyPassword@review.typo3.org/
     *
     * @return void
     */
    protected function addInstancesArgument()
    {
        $this->addArgument(
            'instances',
            InputArgument::IS_ARRAY | InputArgument::OPTIONAL,
            'List of instances to crawl separated by whitespace. Format scheme://username[:password]@host[:port]/.'
        );
    }
}