Completed
Push — master ( 98280a...ab186c )
by David
14:23
created

src/Command/InvalidateRegexCommand.php (1 issue)

Labels
Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

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 invalidation by regular expression from the command line.
21
 *
22
 * @author Christian Stocker <[email protected]>
23
 * @author David Buchmann <[email protected]>
24
 */
25 View Code Duplication
class InvalidateRegexCommand extends BaseInvalidateCommand
26
{
27
    protected static $defaultName = 'fos:httpcache:invalidate:regex';
28
29
    /**
30
     * If no cache manager is specified explicitly, fos_http_cache.cache_manager
31
     * is automatically loaded.
32
     *
33
     * @param CacheManager|null $cacheManager The cache manager to talk to
34
     */
35 4
    public function __construct(CacheManager $cacheManager = null, $commandName = 'fos:httpcache:invalidate:regex')
36
    {
37 4
        if (2 <= func_num_args()) {
38
            @trigger_error('Passing a command name in the constructor is deprecated and will be removed in version 3', E_USER_DEPRECATED);
39
            static::$defaultName = func_get_arg(1);
40
        }
41 4
        parent::__construct($cacheManager);
42 4
    }
43
44
    /**
45
     * {@inheritdoc}
46
     */
47 4
    protected function configure()
48
    {
49
        $this
50 4
            ->setName(static::$defaultName) // BC with 2.8
51 4
            ->setDescription('Invalidate everything matching a regular expression on all configured caching proxies')
52 4
            ->addArgument(
53 4
                'regex',
54 4
                InputArgument::REQUIRED,
55 4
                'Regular expression for the paths to match.'
56
            )
57 4
            ->setHelp(<<<'EOF'
58 4
The <info>%command.name%</info> command invalidates all cached content matching a regular expression on the configured caching proxies.
59
60
Example:
61
62
    <info>php %command.full_name% "/some.*/path" </info>
63
64
or clear the whole cache
65
66
    <info>php %command.full_name% .</info>
67
EOF
68
            )
69
        ;
70 4
    }
71
72
    /**
73
     * {@inheritdoc}
74
     */
75 2
    protected function execute(InputInterface $input, OutputInterface $output)
76
    {
77 2
        $regex = $input->getArgument('regex');
78
79 2
        $this->getCacheManager()->invalidateRegex($regex);
0 ignored issues
show
It seems like $regex defined by $input->getArgument('regex') on line 77 can also be of type array<integer,string> or null; however, FOS\HttpCache\CacheInvalidator::invalidateRegex() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
80 2
    }
81
}
82