AddMassMediaCommand::execute() - Code Metrics - Inspection of "Manual merge 3.x into master" - sonata-project/SonataMediaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1775)

by Wojciech

created 2020-08-01 21:13 UTC

AddMassMediaCommand::execute() A

↳ Parent: AddMassMediaCommand

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	30
rs	9.44
c	0
b	0
f	0
cc	4
nc	4
nop	2

<?php

declare(strict_types=1);

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

namespace Sonata\MediaBundle\Command;

use Doctrine\Persistence\ManagerRegistry;
use Sonata\Doctrine\Model\ManagerInterface;
use Sonata\MediaBundle\Provider\Pool;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * @final since sonata-project/media-bundle 3.21.0
 */
class AddMassMediaCommand extends BaseCommand

{
    /**
     * @var ManagerRegistry|null
     */
    protected $managerRegistry;

    /**
     * @var string[]
     */
    protected $setters;

    public function __construct(ManagerInterface $mediaManager, Pool $pool, ?ManagerRegistry $managerRegistry = null)
    {
        parent::__construct($mediaManager, $pool);

        $this->managerRegistry = $managerRegistry;
    }

    public function configure(): void
    {
        $this->setName('sonata:media:add-multiple')
            ->setDescription('Add medias in mass into the database')
            ->setDefinition([
                new InputOption('file', null, InputOption::VALUE_OPTIONAL, 'The file to parse'),
                new InputOption('delimiter', null, InputOption::VALUE_OPTIONAL, 'Set the field delimiter (one character only)', ','),
                new InputOption('enclosure', null, InputOption::VALUE_OPTIONAL, 'Set the field enclosure character (one character only).', '"'),
                new InputOption('escape', null, InputOption::VALUE_OPTIONAL, 'Set the escape character (one character only). Defaults as a backslash', '\\'),
            ]);
    }

    public function execute(InputInterface $input, OutputInterface $output): int
    {
        $fp = $this->getFilePointer($input, $output);
        $imported = -1;

        while (!feof($fp)) {
            $data = fgetcsv($fp, null, $input->getOption('delimiter'), $input->getOption('enclosure'), $input->getOption('escape'));

            if (-1 === $imported) {
                $this->setters = $data;

                ++$imported;

                continue;
            }

            if (!\is_array($data)) {
                continue;
            }

            ++$imported;

            $this->insertMedia($data, $output);
            $this->optimize();
        }

        $output->writeln('Done!');

        return 0;
    }

    /**
     * @return resource
     */
    protected function getFilePointer(InputInterface $input, OutputInterface $output)

    {
        if (false !== ftell(STDIN)) {
            return STDIN;
        }

        if (!$input->getOption('file')) {
            throw new \RuntimeException('Please provide a CSV file argument or CSV input stream');
        }

        return fopen($input->getOption('file'), 'r');
    }

    protected function insertMedia(array $data, OutputInterface $output): void
    {
        $media = $this->getMediaManager()->create();

        foreach ($this->setters as $pos => $name) {
            $media->{'set'.$name}($data[$pos]);
        }

        try {
            $this->getMediaManager()->save($media);
            $output->writeln(sprintf(' > %s - %s', $media->getId(), $media->getName()));
        } catch (\Exception $e) {
            $output->writeln(sprintf('<error>%s</error> : %s', $e->getMessage(), json_encode($data)));
        }
    }

    protected function optimize(): void
    {
        if (null !== $this->managerRegistry) {
            $this->managerRegistry->getManager()->getUnitOfWork()->clear();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\MediaBundle\Command;
15
16			use Doctrine\Persistence\ManagerRegistry;
17			use Sonata\Doctrine\Model\ManagerInterface;
18			use Sonata\MediaBundle\Provider\Pool;
19			use Symfony\Component\Console\Input\InputInterface;
20			use Symfony\Component\Console\Input\InputOption;
21			use Symfony\Component\Console\Output\OutputInterface;
22
23			/**
24			* @final since sonata-project/media-bundle 3.21.0
25			*/
26			class AddMassMediaCommand extends BaseCommand
			0 ignored issues – show Deprecated Code introduced 2020-08-01 08:43 UTC by Report Bug Copy Issue Report The class `Sonata\MediaBundle\Command\BaseCommand` has been deprecated with message: since sonata-project/media-bundle 3.x, to be removed in 4.0. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
27			{
28			/**
29			* @var ManagerRegistry\|null
30			*/
31			protected $managerRegistry;
32
33			/**
34			* @var string[]
35			*/
36			protected $setters;
37
38			public function __construct(ManagerInterface $mediaManager, Pool $pool, ?ManagerRegistry $managerRegistry = null)
39			{
40			parent::__construct($mediaManager, $pool);
41
42			$this->managerRegistry = $managerRegistry;
43			}
44
45			public function configure(): void
46			{
47			$this->setName('sonata:media:add-multiple')
48			->setDescription('Add medias in mass into the database')
49			->setDefinition([
50			new InputOption('file', null, InputOption::VALUE_OPTIONAL, 'The file to parse'),
51			new InputOption('delimiter', null, InputOption::VALUE_OPTIONAL, 'Set the field delimiter (one character only)', ','),
52			new InputOption('enclosure', null, InputOption::VALUE_OPTIONAL, 'Set the field enclosure character (one character only).', '"'),
53			new InputOption('escape', null, InputOption::VALUE_OPTIONAL, 'Set the escape character (one character only). Defaults as a backslash', '\\'),
54			]);
55			}
56
57			public function execute(InputInterface $input, OutputInterface $output): int
58			{
59			$fp = $this->getFilePointer($input, $output);
60			$imported = -1;
61
62			while (!feof($fp)) {
63			$data = fgetcsv($fp, null, $input->getOption('delimiter'), $input->getOption('enclosure'), $input->getOption('escape'));
64
65			if (-1 === $imported) {
66			$this->setters = $data;
67
68			++$imported;
69
70			continue;
71			}
72
73			if (!\is_array($data)) {
74			continue;
75			}
76
77			++$imported;
78
79			$this->insertMedia($data, $output);
80			$this->optimize();
81			}
82
83			$output->writeln('Done!');
84
85			return 0;
86			}
87
88			/**
89			* @return resource
90			*/
91			protected function getFilePointer(InputInterface $input, OutputInterface $output)
			0 ignored issues – show Unused Code introduced 2017-09-13 09:07 UTC by Report Bug Copy Issue Report The parameter `$output` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
92			{
93			if (false !== ftell(STDIN)) {
94			return STDIN;
95			}
96
97			if (!$input->getOption('file')) {
98			throw new \RuntimeException('Please provide a CSV file argument or CSV input stream');
99			}
100
101			return fopen($input->getOption('file'), 'r');
102			}
103
104			protected function insertMedia(array $data, OutputInterface $output): void
105			{
106			$media = $this->getMediaManager()->create();
107
108			foreach ($this->setters as $pos => $name) {
109			$media->{'set'.$name}($data[$pos]);
110			}
111
112			try {
113			$this->getMediaManager()->save($media);
114			$output->writeln(sprintf(' > %s - %s', $media->getId(), $media->getName()));
115			} catch (\Exception $e) {
116			$output->writeln(sprintf('<error>%s</error> : %s', $e->getMessage(), json_encode($data)));
117			}
118			}
119
120			protected function optimize(): void
121			{
122			if (null !== $this->managerRegistry) {
123			$this->managerRegistry->getManager()->getUnitOfWork()->clear();
			0 ignored issues – show Bug introduced 2020-08-01 08:43 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Doctrine\Persistence\ObjectManager` as the method `getUnitOfWork()` does only exist in the following implementations of said interface: `Doctrine\ORM\Decorator\EntityManagerDecorator`, `Doctrine\ORM\EntityManager`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
124			}
125			}
126			}
127

sonata-project / SonataMediaBundle

Pull Request — master (#1775)

AddMassMediaCommand::execute() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like