Failed Conditions
Pull Request — experimental/sf (#3412)
by Kentaro
77:23 queued 14:43
created

CacheUtil::__construct()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
nc 1
nop 1
dl 0
loc 4
ccs 0
cts 1
cp 0
crap 2
rs 10
c 0
b 0
f 0
1
<?php
2
3
/*
4
 * This file is part of EC-CUBE
5
 *
6
 * Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
7
 *
8
 * http://www.lockon.co.jp/
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 Eccube\Util;
15
16
use Symfony\Bundle\FrameworkBundle\Console\Application;
17
use Symfony\Component\Console\Input\ArrayInput;
18
use Symfony\Component\Console\Output\BufferedOutput;
19
use Symfony\Component\Console\Output\OutputInterface;
20
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
21
use Symfony\Component\Filesystem\Filesystem;
22
use Symfony\Component\Finder\Finder;
23
use Symfony\Component\HttpKernel\Event\PostResponseEvent;
24
use Symfony\Component\HttpKernel\KernelEvents;
25
use Symfony\Component\HttpKernel\KernelInterface;
26
27
/**
28
 * キャッシュ関連のユーティリティクラス.
29
 */
30
class CacheUtil implements EventSubscriberInterface
31
{
32
    private $clearCacheAfterResponse = false;
33
34
    /**
35
     * @var KernelInterface
36
     */
37
    protected $kernel;
38
39 3
    /**
40
     * CacheUtil constructor.
41 3
     *
42
     * @param KernelInterface $kernel
43
     */
44
    public function __construct(KernelInterface $kernel)
45
    {
46
        $this->kernel = $kernel;
47
    }
48
49
    /**
50
     * @param string $env
51
     */
52
    public function clearCache($env = null)
53
    {
54
        $this->clearCacheAfterResponse = $env;
0 ignored issues
show
Documentation Bug introduced by
It seems like $env can also be of type string. However, the property $clearCacheAfterResponse is declared as type boolean. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
55
    }
56
57
    public function forceClearCache(PostResponseEvent $event)
0 ignored issues
show
Unused Code introduced by
The parameter $event 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...
58
    {
59
        if ($this->clearCacheAfterResponse === false) {
60
            return;
61
        }
62
63
        $console = new Application($this->kernel);
64
        $console->setAutoExit(false);
65
66
        $command = [
67
            'command' => 'cache:clear',
68
            '--no-warmup' => true,
69
            '--no-ansi' => true,
70
        ];
71
72
        if ($this->clearCacheAfterResponse !== null) {
73
            $command['--env'] = $this->clearCacheAfterResponse;
74
        }
75
76
        $input = new ArrayInput($command);
77
78
        $output = new BufferedOutput(
79
            OutputInterface::VERBOSITY_DEBUG,
80
            true
81
        );
82
83
        $console->run($input, $output);
84
85
        return $output->fetch();
86
    }
87
88 2
    /**
89
     * キャッシュを削除する.
90 2
     *
91
     * doctrine, profiler, twig によって生成されたキャッシュディレクトリを削除する.
92 2
     * キャッシュは $app['config']['root_dir'].'/app/cache' に生成されます.
93 2
     *
94 2
     * @param Application $app
95 1
     * @param boolean $isAll .gitkeep を残してすべてのファイル・ディレクトリを削除する場合 true, 各ディレクトリのみを削除する場合 false
96 1
     * @param boolean $isTwig Twigキャッシュファイルのみ削除する場合 true
97 1
     *
98
     * @return boolean 削除に成功した場合 true
99
     *
100
     * @deprecated CacheUtil::clearCacheを利用すること
101
     */
102
    public static function clear($app, $isAll, $isTwig = false)
103 1
    {
104 1
        $cacheDir = $app['config']['root_dir'].'/app/cache';
105 1
106
        $filesystem = new Filesystem();
107 1
        $finder = Finder::create()->notName('.gitkeep')->files();
108 1
        if ($isAll) {
109 1
            $finder = $finder->in($cacheDir);
110
            $filesystem->remove($finder);
0 ignored issues
show
Documentation introduced by
$finder is of type object<Symfony\Component\Finder\Finder>, but the function expects a string|object<Symfony\Co...nt\Filesystem\iterable>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
111 1 View Code Duplication
        } elseif ($isTwig) {
112 1
            if (is_dir($cacheDir.'/twig')) {
113 1
                $finder = $finder->in($cacheDir.'/twig');
114
                $filesystem->remove($finder);
0 ignored issues
show
Documentation introduced by
$finder is of type object<Symfony\Component\Finder\Finder>, but the function expects a string|object<Symfony\Co...nt\Filesystem\iterable>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
115 1
            }
116
        } else {
117 View Code Duplication
            if (is_dir($cacheDir.'/doctrine')) {
118
                $finder = $finder->in($cacheDir.'/doctrine');
119
                $filesystem->remove($finder);
0 ignored issues
show
Documentation introduced by
$finder is of type object<Symfony\Component\Finder\Finder>, but the function expects a string|object<Symfony\Co...nt\Filesystem\iterable>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
120
            }
121 2 View Code Duplication
            if (is_dir($cacheDir.'/profiler')) {
122
                $finder = $finder->in($cacheDir.'/profiler');
123
                $filesystem->remove($finder);
0 ignored issues
show
Documentation introduced by
$finder is of type object<Symfony\Component\Finder\Finder>, but the function expects a string|object<Symfony\Co...nt\Filesystem\iterable>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
124
            }
125 2 View Code Duplication
            if (is_dir($cacheDir.'/twig')) {
126
                $finder = $finder->in($cacheDir.'/twig');
127
                $filesystem->remove($finder);
0 ignored issues
show
Documentation introduced by
$finder is of type object<Symfony\Component\Finder\Finder>, but the function expects a string|object<Symfony\Co...nt\Filesystem\iterable>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
128
            }
129 View Code Duplication
            if (is_dir($cacheDir.'/translator')) {
130 2
                $finder = $finder->in($cacheDir.'/translator');
131
                $filesystem->remove($finder);
0 ignored issues
show
Documentation introduced by
$finder is of type object<Symfony\Component\Finder\Finder>, but the function expects a string|object<Symfony\Co...nt\Filesystem\iterable>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
132
            }
133
        }
134 2
135
        if (function_exists('opcache_reset')) {
136
            opcache_reset();
137
        }
138
139
        if (function_exists('apc_clear_cache')) {
140
            apc_clear_cache('user');
141
            apc_clear_cache();
142
        }
143
144
        if (function_exists('wincache_ucache_clear')) {
145
            wincache_ucache_clear();
146
        }
147
148
        return true;
149
    }
150
151
    /**
152
     * {@inheritdoc}
153
     */
154
    public static function getSubscribedEvents()
155
    {
156
        return [KernelEvents::TERMINATE => 'forceClearCache'];
157
    }
158
}
159