ExportCommand::interact() - Code Metrics - Inspection of "Iblock schema" - notamedia/console-jedi - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

unknown

created 2016-12-04 08:48 UTC

ExportCommand::interact() A

↳ Parent: ExportCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	2

<?php

namespace Notamedia\ConsoleJedi\Schema\Command;

use Notamedia\ConsoleJedi\Application\Command\BitrixCommand;
use Notamedia\ConsoleJedi\Schema\Exception\SchemaException;
use Notamedia\ConsoleJedi\Schema\Schema;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Helper\FormatterHelper;
use Bitrix\Main\Loader;

class ExportCommand extends BitrixCommand
{
    use CommandTrait;

    /**
     * {@inheritdoc}
     */
    protected function configure()

    {
        $this
            ->setName('schema:export')
            ->setDescription('Export information block(s) to xml')
            ->addArgument(
                'type',
                InputArgument::REQUIRED,
                'Information iblock type'
            )
            ->addArgument(
                'code',
                InputArgument::REQUIRED,
                'Information iblock code'
            )
            ->addArgument(
                'dir',
                InputArgument::OPTIONAL,
                'Directory to export'
            )
            ->addOption(
                'sections',
                's',
                InputOption::VALUE_OPTIONAL,
                'Export sections [ "active", "all", "none" ]',
                'none'
            )
            ->addOption(
                'elements',
                'e',
                InputOption::VALUE_OPTIONAL,
                'Export elements [ "active", "all", "none" ]',
                'none'
            );
    }

    /**
     * {@inheritdoc}
     */
    protected function initialize(InputInterface $input, OutputInterface $output)
    {
        Loader::includeModule('iblock');
    }

    /**
     * {@inheritdoc}
     */
    protected function interact(InputInterface $input, OutputInterface $output)
    {
        $this->setDir($input);
        $this->setIblocks($input);
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $formatter = new FormatterHelper();

        if (count($this->errors) > 0) {

            $output->writeln($formatter->formatBlock($this->errors, 'error'));
            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());
}
        }

        $export = Schema::export()
            ->setSections($input->getOption('sections'))
            ->setElements($input->getOption('elements'));

        foreach ($this->iblocks as $iblock) {

            try {
                $xml_id = \CIBlockCMLExport::GetIBlockXML_ID($iblock['ID']);
                $path = implode(DIRECTORY_SEPARATOR, [$this->dir, $xml_id]) . $this->extension;

                $export
                    ->setPath($path)
                    ->setId($iblock['ID'])
                    ->execute();

                $output->writeln(sprintf('<info>%s</info> iblock %s %s', 'success', $iblock['CODE'], $path));

            } catch (SchemaException $e) {
                $output->writeln(sprintf('<error>%s</error> iblock %s', 'fail', $iblock['CODE']));
                if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
                    $output->writeln($e->getMessage());
                }
            }
        }

        return true;
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());
}
    }
}

1		<?php
2
3		namespace Notamedia\ConsoleJedi\Schema\Command;
4
5		use Notamedia\ConsoleJedi\Application\Command\BitrixCommand;
6		use Notamedia\ConsoleJedi\Schema\Exception\SchemaException;
7		use Notamedia\ConsoleJedi\Schema\Schema;
8		use Symfony\Component\Console\Input\InputArgument;
9		use Symfony\Component\Console\Input\InputInterface;
10		use Symfony\Component\Console\Input\InputOption;
11		use Symfony\Component\Console\Output\OutputInterface;
12		use Symfony\Component\Console\Helper\FormatterHelper;
13		use Bitrix\Main\Loader;
14
15		class ExportCommand extends BitrixCommand
16		{
17		use CommandTrait;
18
19		/**
20		* {@inheritdoc}
21		*/
22	View Code Duplication	protected function configure()
		0 ignored issues – show Duplication introduced 2016-12-03 12:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
23		{
24		$this
25		->setName('schema:export')
26		->setDescription('Export information block(s) to xml')
27		->addArgument(
28		'type',
29		InputArgument::REQUIRED,
30		'Information iblock type'
31		)
32		->addArgument(
33		'code',
34		InputArgument::REQUIRED,
35		'Information iblock code'
36		)
37		->addArgument(
38		'dir',
39		InputArgument::OPTIONAL,
40		'Directory to export'
41		)
42		->addOption(
43		'sections',
44		's',
45		InputOption::VALUE_OPTIONAL,
46		'Export sections [ "active", "all", "none" ]',
47		'none'
48		)
49		->addOption(
50		'elements',
51		'e',
52		InputOption::VALUE_OPTIONAL,
53		'Export elements [ "active", "all", "none" ]',
54		'none'
55		);
56		}
57
58		/**
59		* {@inheritdoc}
60		*/
61		protected function initialize(InputInterface $input, OutputInterface $output)
62		{
63		Loader::includeModule('iblock');
64		}
65
66		/**
67		* {@inheritdoc}
68		*/
69		protected function interact(InputInterface $input, OutputInterface $output)
70		{
71		$this->setDir($input);
72		$this->setIblocks($input);
73		}
74
75		/**
76		* {@inheritdoc}
77		*/
78		protected function execute(InputInterface $input, OutputInterface $output)
79		{
80		$formatter = new FormatterHelper();
81
82	View Code Duplication	if (count($this->errors) > 0) {
		0 ignored issues – show Duplication introduced 2016-12-03 12:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
83		$output->writeln($formatter->formatBlock($this->errors, 'error'));
84		return false;
		0 ignored issues – show Bug Best Practice introduced 2016-12-03 12:27 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...
85		}
86
87		$export = Schema::export()
88		->setSections($input->getOption('sections'))
89		->setElements($input->getOption('elements'));
90
91		foreach ($this->iblocks as $iblock) {
92
93		try {
94		$xml_id = \CIBlockCMLExport::GetIBlockXML_ID($iblock['ID']);
95		$path = implode(DIRECTORY_SEPARATOR, [$this->dir, $xml_id]) . $this->extension;
96
97		$export
98		->setPath($path)
99		->setId($iblock['ID'])
100		->execute();
101
102		$output->writeln(sprintf('<info>%s</info> iblock %s %s', 'success', $iblock['CODE'], $path));
103
104		} catch (SchemaException $e) {
105		$output->writeln(sprintf('<error>%s</error> iblock %s', 'fail', $iblock['CODE']));
106		if ($output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) {
107		$output->writeln($e->getMessage());
108		}
109		}
110		}
111
112		return true;
		0 ignored issues – show Bug Best Practice introduced 2016-12-03 12:27 UTC by Report Bug Copy Issue Report The return type of `return true;` (`boolean`) 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...
113		}
114		}

notamedia / console-jedi

Pull Request — master (#20)

ExportCommand::interact() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like