RefreshPathCommand::execute() - Code Metrics - Inspection of "Merge pull request #483 from Toflar/support-max-he..." - FriendsOfSymfony/FOSHttpCacheBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ea729d...2dd925 )

by David

created 2018-10-01 13:59 UTC

RefreshPathCommand::execute() A

↳ Parent: RefreshPathCommand

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	12
Ratio	100 %

Code Coverage

Tests	6
CRAP Score	3.0261

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	12
loc	12
ccs	6
cts	7
cp	0.8571
rs	9.8666
cc	3
nc	3
nop	2
crap	3.0261

<?php

/*
 * This file is part of the FOSHttpCacheBundle package.
 *
 * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FOS\HttpCacheBundle\Command;

use FOS\HttpCacheBundle\CacheManager;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;

/**
 * A command to trigger cache refresh by path from the command line.
 *
 * @author David Buchmann <[email protected]>
 */
class RefreshPathCommand extends BaseInvalidateCommand
{
    use PathSanityCheck;

    protected static $defaultName = 'fos:httpcache:refresh:path';

    /**
     * If no cache manager is specified explicitly, fos_http_cache.cache_manager
     * is automatically loaded.
     *
     * @param CacheManager|null $cacheManager The cache manager to talk to
     */
    public function __construct(CacheManager $cacheManager = null)
    {
        if (2 <= func_num_args()) {
            @trigger_error('Passing a command name in the constructor is deprecated and will be removed in version 3', E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
            static::$defaultName = func_get_arg(1);
        }
        parent::__construct($cacheManager);
    }

    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName(static::$defaultName) // BC with 2.8
            ->setDescription('Refresh paths on all configured caching proxies')
            ->addArgument(
                'paths',
                InputArgument::IS_ARRAY | InputArgument::REQUIRED,
                'URL paths you want to refresh, you can specify any number of paths'
            )
            ->setHelp(<<<'EOF'
The <info>%command.name%</info> command refreshes a list of paths on the configured caching proxies.

Example:

    <info>php %command.full_name% /some/path /other/path</info>
EOF
            )
        ;
    }

    /**
     * {@inheritdoc}
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $paths = $input->getArgument('paths');

        foreach ($paths as $path) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
            if ($this->looksLikeRegularExpression($path)) {
                $output->writeln(sprintf('Path %s looks like a regular expression. Refresh requests operate with actual requests and thus use exact paths. Use regex invalidation for regular expressions.', $path));
            }

            $this->getCacheManager()->refreshPath($path);
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the FOSHttpCacheBundle package.
5			*
6			* (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
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 FOS\HttpCacheBundle\Command;
13
14			use FOS\HttpCacheBundle\CacheManager;
15			use Symfony\Component\Console\Input\InputArgument;
16			use Symfony\Component\Console\Input\InputInterface;
17			use Symfony\Component\Console\Output\OutputInterface;
18
19			/**
20			* A command to trigger cache refresh by path from the command line.
21			*
22			* @author David Buchmann <[email protected]>
23			*/
24		View Code Duplication	class RefreshPathCommand extends BaseInvalidateCommand
25			{
26			use PathSanityCheck;
27
28			protected static $defaultName = 'fos:httpcache:refresh:path';
29
30			/**
31			* If no cache manager is specified explicitly, fos_http_cache.cache_manager
32			* is automatically loaded.
33			*
34			* @param CacheManager\|null $cacheManager The cache manager to talk to
35			*/
36	4		public function __construct(CacheManager $cacheManager = null)
37			{
38	4		if (2 <= func_num_args()) {
39			@trigger_error('Passing a command name in the constructor is deprecated and will be removed in version 3', E_USER_DEPRECATED);
			0 ignored issues – show Security Best Practice introduced 2018-03-01 15:50 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
40			static::$defaultName = func_get_arg(1);
41			}
42	4		parent::__construct($cacheManager);
43	4		}
44
45			/**
46			* {@inheritdoc}
47			*/
48	4		protected function configure()
49			{
50			$this
51	4		->setName(static::$defaultName) // BC with 2.8
52	4		->setDescription('Refresh paths on all configured caching proxies')
53	4		->addArgument(
54	4		'paths',
55	4		InputArgument::IS_ARRAY \| InputArgument::REQUIRED,
56	4		'URL paths you want to refresh, you can specify any number of paths'
57			)
58	4		->setHelp(<<<'EOF'
59	4		The <info>%command.name%</info> command refreshes a list of paths on the configured caching proxies.
60
61			Example:
62
63			<info>php %command.full_name% /some/path /other/path</info>
64			EOF
65			)
66			;
67	4		}
68
69			/**
70			* {@inheritdoc}
71			*/
72	2		protected function execute(InputInterface $input, OutputInterface $output)
73			{
74	2		$paths = $input->getArgument('paths');
75
76	2		foreach ($paths as $path) {
			0 ignored issues – show Bug introduced 2018-10-01 07:18 UTC by Report Bug Copy Issue Report The expression `$paths` of type `string\|array<integer,string>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
77	2		if ($this->looksLikeRegularExpression($path)) {
78			$output->writeln(sprintf('Path %s looks like a regular expression. Refresh requests operate with actual requests and thus use exact paths. Use regex invalidation for regular expressions.', $path));
79			}
80
81	2		$this->getCacheManager()->refreshPath($path);
82			}
83	2		}
84			}
85

FriendsOfSymfony / FOSHttpCacheBundle

Push — master ( ea729d...2dd925 )

RefreshPathCommand::execute() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like