Completed
Push — master ( aa9daf...c0a8a5 )
by David
10:44
created

src/Command/InvalidateTagCommand.php (3 issues)

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 tag from the command line.
21
 *
22
 * @author David Buchmann <[email protected]>
23
 */
24 View Code Duplication
class InvalidateTagCommand extends BaseInvalidateCommand
25
{
26
    protected static $defaultName = 'fos:httpcache:invalidate:tag';
27
28
    /**
29
     * If no cache manager is specified explicitly, fos_http_cache.cache_manager
30
     * is automatically loaded.
31
     *
32
     * @param CacheManager|null $cacheManager The cache manager to talk to
33
     */
34 4
    public function __construct(CacheManager $cacheManager = null, $commandName = 'fos:httpcache:invalidate:tag')
0 ignored issues
show
The parameter $commandName 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...
35
    {
36 4
        if (2 <= func_num_args()) {
37
            @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 by
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...
38
            static::$defaultName = func_get_arg(1);
39
        }
40 4
        parent::__construct($cacheManager);
41 4
    }
42
43
    /**
44
     * {@inheritdoc}
45
     */
46 4
    protected function configure()
47
    {
48
        $this
49 4
            ->setName(static::$defaultName) // BC with 2.8
50 4
            ->setDescription('Invalidate cached content matching the specified tags on all configured caching proxies')
51 4
            ->addArgument(
52 4
                'tags',
53 4
                InputArgument::IS_ARRAY | InputArgument::REQUIRED,
54 4
                'Tags in the response tags header to invalidate'
55
            )
56 4
            ->setHelp(<<<'EOF'
57 4
The <info>%command.name%</info> command invalidates all cached content matching the specified tags on the configured caching proxies.
58
59
Example:
60
61
    <info>php %command.full_name% my-tag other-tag </info>
62
EOF
63
            )
64
        ;
65 4
    }
66
67
    /**
68
     * {@inheritdoc}
69
     */
70 2
    protected function execute(InputInterface $input, OutputInterface $output)
71
    {
72 2
        $tags = $input->getArgument('tags');
73
74 2
        $this->getCacheManager()->invalidateTags($tags);
0 ignored issues
show
It seems like $tags defined by $input->getArgument('tags') on line 72 can also be of type null or string; however, FOS\HttpCache\CacheInvalidator::invalidateTags() does only seem to accept array, 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...
75 2
    }
76
}
77