InitCommand::createDefinition() - Code Metrics - slince/spike - Measure and Improve Code Quality continuously with Scrutinizer

InitCommand::createDefinition() A
last analyzed 2018-08-22 09:25 UTC

↳ Parent: InitCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0

<?php

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

namespace Spike\Server\Command;

use Slince\Config\Config;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

class InitCommand extends Command
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this->ignoreValidationErrors();
        $this->setName('init')
            ->setDefinition($this->createDefinition())
            ->setDescription('Create a configuration file in the specified directory');
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $templateConfigFile = __DIR__.'/../../../resources/spiked-template.json';
        $config = new Config($templateConfigFile);
        $dstPath = $input->getOption('dir');
        $extension = $input->getOption('format');
        if (!in_array($extension, $this->getSupportedFormats())) {
            $output->writeln(sprintf('<error>The format "%s" is not supported</error>', $extension));

            return false;
class Author {
    private $name;

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

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

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

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

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

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
        }
        if (!$config->dump("{$dstPath}/spiked.{$extension}")) {
            $output->writeln('Can not create the configuration file');
        }
    }

    /**
     * {@inheritdoc}
     *
     * @codeCoverageIgnore
     */
    public function getNativeDefinition()
    {
        return $this->createDefinition();
    }

    /**
     * Gets all supported formats.
     *
     * @return array
     */
    protected function getSupportedFormats()
    {
        return [
            'json', 'yaml', 'xml',
        ];
    }

    /**
     * {@inheritdoc}
     */
    private function createDefinition()
    {
        return new InputDefinition(array(
            new InputOption('format', null, InputOption::VALUE_REQUIRED,
                'The configuration file format, support json,ini,xml and yaml', 'json'),
            new InputOption('dir', null, InputOption::VALUE_REQUIRED,
                'The directory', getcwd()),
        ));
    }
}

1			<?php
2
3			/*
4			* This file is part of the slince/spike package.
5			*
6			* (c) Slince <[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 Spike\Server\Command;
13
14			use Slince\Config\Config;
15			use Symfony\Component\Console\Input\InputDefinition;
16			use Symfony\Component\Console\Input\InputOption;
17			use Symfony\Component\Console\Input\InputInterface;
18			use Symfony\Component\Console\Output\OutputInterface;
19
20			class InitCommand extends Command
21			{
22			/**
23			* {@inheritdoc}
24			*/
25			protected function configure()
26			{
27			$this->ignoreValidationErrors();
28			$this->setName('init')
29			->setDefinition($this->createDefinition())
30			->setDescription('Create a configuration file in the specified directory');
31			}
32
33			/**
34			* {@inheritdoc}
35			*/
36			protected function execute(InputInterface $input, OutputInterface $output)
37			{
38			$templateConfigFile = __DIR__.'/../../../resources/spiked-template.json';
39			$config = new Config($templateConfigFile);
40			$dstPath = $input->getOption('dir');
41			$extension = $input->getOption('format');
42			if (!in_array($extension, $this->getSupportedFormats())) {
43			$output->writeln(sprintf('<error>The format "%s" is not supported</error>', $extension));
44
45			return false;
			0 ignored issues – show Bug Best Practice introduced 2017-06-22 14:05 UTC by Report Bug Copy Issue Report The return type of `return false;` (`false`) is incompatible with the return type of the parent method `Symfony\Component\Console\Command\Command::execute` of type `null\|integer`. 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 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('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...
46			}
47			if (!$config->dump("{$dstPath}/spiked.{$extension}")) {
48			$output->writeln('Can not create the configuration file');
49			}
50			}
51
52			/**
53			* {@inheritdoc}
54			*
55			* @codeCoverageIgnore
56			*/
57			public function getNativeDefinition()
58			{
59			return $this->createDefinition();
60			}
61
62			/**
63			* Gets all supported formats.
64			*
65			* @return array
66			*/
67			protected function getSupportedFormats()
68			{
69			return [
70			'json', 'yaml', 'xml',
71			];
72			}
73
74			/**
75			* {@inheritdoc}
76			*/
77			private function createDefinition()
78			{
79			return new InputDefinition(array(
80			new InputOption('format', null, InputOption::VALUE_REQUIRED,
81			'The configuration file format, support json,ini,xml and yaml', 'json'),
82			new InputOption('dir', null, InputOption::VALUE_REQUIRED,
83			'The directory', getcwd()),
84			));
85			}
86			}

slince / spike

InitCommand::createDefinition() A last analyzed 2018-08-22 09:25 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

InitCommand::createDefinition() A
last analyzed 2018-08-22 09:25 UTC