Application::getDefaultCommands() - Code Metrics - Inspection of "FastCGI/Config: attempt to glob for sockets if no..." - gordalina/cachetool - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#38)

by Boris

created 2016-06-16 23:13 UTC

Application::getDefaultCommands() B

↳ Parent: Application

Complexity

Conditions	1
Paths	1

Size

Total Lines	39
Code Lines	32

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	32
CRAP Score	1

Importance

Changes	7
Bugs	0	Features	4

Metric	Value
c	7
b	0
f	4
dl	0
loc	39
ccs	32
cts	32
cp	1
rs	8.8571
nc	1
cc	1
eloc	32
nop	0
crap	1

<?php

/*
 * This file is part of CacheTool.
 *
 * (c) Samuel Gordalina <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace CacheTool\Console;

use CacheTool\Adapter\FastCGI;
use CacheTool\Adapter\Cli;
use CacheTool\CacheTool;
use CacheTool\Command as CacheToolCommand;
use CacheTool\Monolog\ConsoleHandler;
use Monolog\Logger;
use Symfony\Component\Console\Application as BaseApplication;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\DependencyInjection\ContainerAwareInterface;
use Symfony\Component\DependencyInjection\Container;
use Symfony\Component\DependencyInjection\ContainerInterface;

class Application extends BaseApplication
{
    const VERSION = '@package_version@';

    /**
     * @var Config
     */
    protected $config;

    /**
     * @var Logger
     */
    protected $logger;

    /**
     * @param Config $config
     */
    public function __construct(Config $config)
    {
        parent::__construct('CacheTool', self::VERSION);

        $this->config = $config;
        $this->logger = new Logger('cachetool');
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultCommands()
    {
        $commands = parent::getDefaultCommands();
        $commands[] = new CacheToolCommand\SelfUpdateCommand();

        $commands[] = new CacheToolCommand\ApcBinDumpCommand();
        $commands[] = new CacheToolCommand\ApcBinLoadCommand();
        $commands[] = new CacheToolCommand\ApcCacheClearCommand();
        $commands[] = new CacheToolCommand\ApcCacheInfoCommand();
        $commands[] = new CacheToolCommand\ApcCacheInfoFileCommand();
        $commands[] = new CacheToolCommand\ApcKeyDeleteCommand();
        $commands[] = new CacheToolCommand\ApcKeyExistsCommand();
        $commands[] = new CacheToolCommand\ApcKeyFetchCommand();
        $commands[] = new CacheToolCommand\ApcKeyStoreCommand();
        $commands[] = new CacheToolCommand\ApcSmaInfoCommand();
        $commands[] = new CacheToolCommand\ApcRegexpDeleteCommand();

        $commands[] = new CacheToolCommand\ApcuCacheClearCommand();
        $commands[] = new CacheToolCommand\ApcuCacheInfoCommand();
        $commands[] = new CacheToolCommand\ApcuCacheInfoKeysCommand();
        $commands[] = new CacheToolCommand\ApcuKeyDeleteCommand();
        $commands[] = new CacheToolCommand\ApcuKeyExistsCommand();
        $commands[] = new CacheToolCommand\ApcuKeyFetchCommand();
        $commands[] = new CacheToolCommand\ApcuKeyStoreCommand();
        $commands[] = new CacheToolCommand\ApcuSmaInfoCommand();
        $commands[] = new CacheToolCommand\ApcuRegexpDeleteCommand();

        $commands[] = new CacheToolCommand\OpcacheConfigurationCommand();
        $commands[] = new CacheToolCommand\OpcacheResetCommand();
        $commands[] = new CacheToolCommand\OpcacheStatusCommand();
        $commands[] = new CacheToolCommand\OpcacheStatusScriptsCommand();
        $commands[] = new CacheToolCommand\OpcacheInvalidateScriptsCommand();

        $commands[] = new CacheToolCommand\StatCacheClearCommand();
        $commands[] = new CacheToolCommand\StatRealpathGetCommand();
        $commands[] = new CacheToolCommand\StatRealpathSizeCommand();

        return $commands;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * {@inheritDoc}
     */
    protected function getDefaultInputDefinition()
    {
        $definition = parent::getDefaultInputDefinition();
        $definition->addOption(new InputOption('--fcgi', null, InputOption::VALUE_OPTIONAL, 'If specified, used as a connection string to FastCGI server.'));
        $definition->addOption(new InputOption('--cli', null, InputOption::VALUE_NONE, 'If specified, forces adapter to cli'));
        $definition->addOption(new InputOption('--tmp-dir', '-t', InputOption::VALUE_REQUIRED, 'Temporary directory to write files to'));

        return $definition;
    }

    /**
     * {@inheritDoc}
     */
    public function doRun(InputInterface $input, OutputInterface $output)
    {
        $handler = new ConsoleHandler();
        $handler->setOutput($output);
        $this->logger->pushHandler($handler);

        $exitCode = parent::doRun($input, $output);

        $handler->close();

        return $exitCode;
    }

    /**
     * {@inheritDoc}
     */
    public function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
    {
        if ($command instanceof ContainerAwareInterface) {
            $container = $this->buildContainer($input);
            $command->setContainer($container);
        }

        return parent::doRunCommand($command, $input, $output);
    }

    /**
     * @param  InputInterface     $input
     * @return ContainerInterface
     */
    public function buildContainer(InputInterface $input)
    {
        if ($input->hasParameterOption('--cli')) {
            $this->config['adapter'] = 'cli';
        } elseif ($input->hasParameterOption('--fcgi')) {
            $this->config['adapter'] = 'fastcgi';
            $this->config['fastcgi'] = $input->getParameterOption('--fcgi');
        }

        if ($input->hasParameterOption('--tmp-dir') || $input->hasParameterOption('-t')) {
            $this->config['temp_dir'] = $input->getParameterOption('--tmp-dir') ?: $input->getParameterOption('-t');
        }

        switch ($this->config['adapter']) {
            case 'cli':
                $adapter = new Cli();
                break;

            case 'fastcgi':
                $adapter = new FastCGI($this->config['fastcgi']);
                break;

            default:
                throw new \RuntimeException("Adapter `{$this->config['adapter']}` is not one of cli or fastcgi");
        }

        $cacheTool = CacheTool::factory($adapter, $this->config['temp_dir'], $this->logger);
        $container = new Container();
        $container->set('cachetool', $cacheTool);
        $container->set('logger', $this->logger);

        return $container;
    }
}


1		<?php
2
3		/*
4		* This file is part of CacheTool.
5		*
6		* (c) Samuel Gordalina <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace CacheTool\Console;
13
14		use CacheTool\Adapter\FastCGI;
15		use CacheTool\Adapter\Cli;
16		use CacheTool\CacheTool;
17		use CacheTool\Command as CacheToolCommand;
18		use CacheTool\Monolog\ConsoleHandler;
19		use Monolog\Logger;
20		use Symfony\Component\Console\Application as BaseApplication;
21		use Symfony\Component\Console\Command\Command;
22		use Symfony\Component\Console\Input\InputOption;
23		use Symfony\Component\Console\Input\InputInterface;
24		use Symfony\Component\Console\Output\OutputInterface;
25		use Symfony\Component\DependencyInjection\ContainerAwareInterface;
26		use Symfony\Component\DependencyInjection\Container;
27		use Symfony\Component\DependencyInjection\ContainerInterface;
28
29		class Application extends BaseApplication
30		{
31		const VERSION = '@package_version@';
32
33		/**
34		* @var Config
35		*/
36		protected $config;
37
38		/**
39		* @var Logger
40		*/
41		protected $logger;
42
43		/**
44		* @param Config $config
45		*/
46	4	public function __construct(Config $config)
47		{
48	4	parent::__construct('CacheTool', self::VERSION);
49
50	4	$this->config = $config;
51	4	$this->logger = new Logger('cachetool');
52	4	}
53
54		/**
55		* {@inheritdoc}
56		*/
57	4	protected function getDefaultCommands()
58		{
59	4	$commands = parent::getDefaultCommands();
60	4	$commands[] = new CacheToolCommand\SelfUpdateCommand();
61
62	4	$commands[] = new CacheToolCommand\ApcBinDumpCommand();
63	4	$commands[] = new CacheToolCommand\ApcBinLoadCommand();
64	4	$commands[] = new CacheToolCommand\ApcCacheClearCommand();
65	4	$commands[] = new CacheToolCommand\ApcCacheInfoCommand();
66	4	$commands[] = new CacheToolCommand\ApcCacheInfoFileCommand();
67	4	$commands[] = new CacheToolCommand\ApcKeyDeleteCommand();
68	4	$commands[] = new CacheToolCommand\ApcKeyExistsCommand();
69	4	$commands[] = new CacheToolCommand\ApcKeyFetchCommand();
70	4	$commands[] = new CacheToolCommand\ApcKeyStoreCommand();
71	4	$commands[] = new CacheToolCommand\ApcSmaInfoCommand();
72	4	$commands[] = new CacheToolCommand\ApcRegexpDeleteCommand();
73
74	4	$commands[] = new CacheToolCommand\ApcuCacheClearCommand();
75	4	$commands[] = new CacheToolCommand\ApcuCacheInfoCommand();
76	4	$commands[] = new CacheToolCommand\ApcuCacheInfoKeysCommand();
77	4	$commands[] = new CacheToolCommand\ApcuKeyDeleteCommand();
78	4	$commands[] = new CacheToolCommand\ApcuKeyExistsCommand();
79	4	$commands[] = new CacheToolCommand\ApcuKeyFetchCommand();
80	4	$commands[] = new CacheToolCommand\ApcuKeyStoreCommand();
81	4	$commands[] = new CacheToolCommand\ApcuSmaInfoCommand();
82	4	$commands[] = new CacheToolCommand\ApcuRegexpDeleteCommand();
83
84	4	$commands[] = new CacheToolCommand\OpcacheConfigurationCommand();
85	4	$commands[] = new CacheToolCommand\OpcacheResetCommand();
86	4	$commands[] = new CacheToolCommand\OpcacheStatusCommand();
87	4	$commands[] = new CacheToolCommand\OpcacheStatusScriptsCommand();
88	4	$commands[] = new CacheToolCommand\OpcacheInvalidateScriptsCommand();
89
90	4	$commands[] = new CacheToolCommand\StatCacheClearCommand();
91	4	$commands[] = new CacheToolCommand\StatRealpathGetCommand();
92	4	$commands[] = new CacheToolCommand\StatRealpathSizeCommand();
93
94	4	return $commands;
		0 ignored issues – show Best Practice introduced 2016-05-31 17:33 UTC by Report Bug Copy Issue Report The expression `return $commands;` seems to be an `array`, but some of its elements' types (`CacheTool\Command\SelfUp...StatRealpathSizeCommand`) are incompatible with the return type of the parent method `Symfony\Component\Consol...ion::getDefaultCommands` of type `array<Symfony\Component\...le\Command\ListCommand>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
95		}
96
97		/**
98		* {@inheritDoc}
99		*/
100	4	protected function getDefaultInputDefinition()
101		{
102	4	$definition = parent::getDefaultInputDefinition();
103	4	$definition->addOption(new InputOption('--fcgi', null, InputOption::VALUE_OPTIONAL, 'If specified, used as a connection string to FastCGI server.'));
104	4	$definition->addOption(new InputOption('--cli', null, InputOption::VALUE_NONE, 'If specified, forces adapter to cli'));
105	4	$definition->addOption(new InputOption('--tmp-dir', '-t', InputOption::VALUE_REQUIRED, 'Temporary directory to write files to'));
106
107	4	return $definition;
108		}
109
110		/**
111		* {@inheritDoc}
112		*/
113	4	public function doRun(InputInterface $input, OutputInterface $output)
114		{
115	4	$handler = new ConsoleHandler();
116	4	$handler->setOutput($output);
117	4	$this->logger->pushHandler($handler);
118
119	4	$exitCode = parent::doRun($input, $output);
120
121	3	$handler->close();
122
123	3	return $exitCode;
124		}
125
126		/**
127		* {@inheritDoc}
128		*/
129	4	public function doRunCommand(Command $command, InputInterface $input, OutputInterface $output)
130		{
131	4	if ($command instanceof ContainerAwareInterface) {
132	4	$container = $this->buildContainer($input);
133	3	$command->setContainer($container);
134	3	}
135
136	3	return parent::doRunCommand($command, $input, $output);
137		}
138
139		/**
140		* @param InputInterface $input
141		* @return ContainerInterface
142		*/
143	4	public function buildContainer(InputInterface $input)
144		{
145	4	if ($input->hasParameterOption('--cli')) {
146	1	$this->config['adapter'] = 'cli';
147	4	} elseif ($input->hasParameterOption('--fcgi')) {
148	1	$this->config['adapter'] = 'fastcgi';
149	1	$this->config['fastcgi'] = $input->getParameterOption('--fcgi');
150	1	}
151
152	4	if ($input->hasParameterOption('--tmp-dir') \|\| $input->hasParameterOption('-t')) {
153		$this->config['temp_dir'] = $input->getParameterOption('--tmp-dir') ?: $input->getParameterOption('-t');
154		}
155
156	4	switch ($this->config['adapter']) {
157	4	case 'cli':
158	2	$adapter = new Cli();
159	2	break;
160
161	2	case 'fastcgi':
162	1	$adapter = new FastCGI($this->config['fastcgi']);
163	1	break;
164
165	1	default:
166	1	throw new \RuntimeException("Adapter `{$this->config['adapter']}` is not one of cli or fastcgi");
167	4	}
168
169	3	$cacheTool = CacheTool::factory($adapter, $this->config['temp_dir'], $this->logger);
170	3	$container = new Container();
171	3	$container->set('cachetool', $cacheTool);
172	3	$container->set('logger', $this->logger);
173
174	3	return $container;
175		}
176		}
177

gordalina / cachetool

Pull Request — master (#38)

Application::getDefaultCommands() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like