CacheUtil::clearDoctrineCache() - Code Metrics - Inspection of "パフォーマンスチューニング" - EC-CUBE/ec-cube - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 4.0 (#3849)

by chihiro

created 2018-09-14 03:41 UTC

CacheUtil::clearDoctrineCache() A

↳ Parent: CacheUtil

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	2.0393

Importance

Changes

Metric	Value
cc	2
nc	2
nop	0
dl	0
loc	25
ccs	11
cts	14
cp	0.7856
crap	2.0393
rs	9.52
c	0
b	0
f	0

<?php

/*
 * This file is part of EC-CUBE
 *
 * Copyright(c) LOCKON CO.,LTD. All Rights Reserved.
 *
 * http://www.lockon.co.jp/
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Eccube\Util;

use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Input\ArrayInput;
use Symfony\Component\Console\Output\BufferedOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Finder\Finder;
use Symfony\Component\HttpKernel\Event\PostResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\HttpKernel\KernelInterface;

/**
 * キャッシュ関連のユーティリティクラス.
 */
class CacheUtil implements EventSubscriberInterface
{
    private $clearCacheAfterResponse = false;

    /**
     * @var KernelInterface
     */
    protected $kernel;

    /**
     * CacheUtil constructor.
     *
     * @param KernelInterface $kernel
     */
    public function __construct(KernelInterface $kernel)
    {
        $this->kernel = $kernel;
    }

    /**
     * @param string $env
     */
    public function clearCache($env = null)
    {
        $this->clearCacheAfterResponse = $env;
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;
}
    }

    public function forceClearCache(PostResponseEvent $event)

    {
        if ($this->clearCacheAfterResponse === false) {
            return;
        }

        $console = new Application($this->kernel);
        $console->setAutoExit(false);

        $command = [
            'command' => 'cache:clear',
            '--no-warmup' => true,
            '--no-ansi' => true,
        ];

        if ($this->clearCacheAfterResponse !== null) {
            $command['--env'] = $this->clearCacheAfterResponse;
        }

        $input = new ArrayInput($command);

        $output = new BufferedOutput(
            OutputInterface::VERBOSITY_DEBUG,
            true
        );

        $console->run($input, $output);

        return $output->fetch();
    }

    /**
     * Doctrineのキャッシュを削除します.
     * APP_ENV=prodの場合のみ実行されます.
     *
     * @param null $env
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
     * @return string
     * @throws \Exception
     */
    public function clearDoctrineCache()
    {
        if ($this->kernel->getEnvironment() !== 'prod') {
            return;
        }
        $console = new Application($this->kernel);
        $console->setAutoExit(false);

        $command = [
            'command' => 'cache:pool:clear',
            'pools' => ['doctrine.app_cache_pool'],
            '--no-ansi' => true,
        ];

        $input = new ArrayInput($command);

        $output = new BufferedOutput(
            OutputInterface::VERBOSITY_DEBUG,
            true
        );

        $console->run($input, $output);

        return $output->fetch();
    }

    /**
     * Twigキャッシュを削除します.
     */
    public function clearTwigCache()
    {
        $cacheDir = $this->kernel->getCacheDir().'/twig';
        $fs = new Filesystem();
        $fs->remove($cacheDir);
    }

    /**
     * キャッシュを削除する.
     *
     * doctrine, profiler, twig によって生成されたキャッシュディレクトリを削除する.
     * キャッシュは $app['config']['root_dir'].'/app/cache' に生成されます.
     *
     * @param Application $app
     * @param boolean $isAll .gitkeep を残してすべてのファイル・ディレクトリを削除する場合 true, 各ディレクトリのみを削除する場合 false
     * @param boolean $isTwig Twigキャッシュファイルのみ削除する場合 true
     *
     * @return boolean 削除に成功した場合 true
     *
     * @deprecated CacheUtil::clearCacheを利用すること
     */
    public static function clear($app, $isAll, $isTwig = false)
    {
        $cacheDir = $app['config']['root_dir'].'/app/cache';

        $filesystem = new Filesystem();
        $finder = Finder::create()->notName('.gitkeep')->files();
        if ($isAll) {
            $finder = $finder->in($cacheDir);
            $filesystem->remove($finder);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        } elseif ($isTwig) {
            if (is_dir($cacheDir.'/twig')) {
                $finder = $finder->in($cacheDir.'/twig');
                $filesystem->remove($finder);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        } else {
            if (is_dir($cacheDir.'/doctrine')) {
                $finder = $finder->in($cacheDir.'/doctrine');
                $filesystem->remove($finder);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
            if (is_dir($cacheDir.'/profiler')) {
                $finder = $finder->in($cacheDir.'/profiler');
                $filesystem->remove($finder);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
            if (is_dir($cacheDir.'/twig')) {
                $finder = $finder->in($cacheDir.'/twig');
                $filesystem->remove($finder);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
            if (is_dir($cacheDir.'/translator')) {
                $finder = $finder->in($cacheDir.'/translator');
                $filesystem->remove($finder);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        }

        if (function_exists('opcache_reset')) {
            opcache_reset();
        }

        if (function_exists('apc_clear_cache')) {
            apc_clear_cache('user');
            apc_clear_cache();
        }

        if (function_exists('wincache_ucache_clear')) {
            wincache_ucache_clear();
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents()
    {
        return [KernelEvents::TERMINATE => 'forceClearCache'];
    }
}


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			/**
40			* CacheUtil constructor.
41			*
42			* @param KernelInterface $kernel
43			*/
44	437		public function __construct(KernelInterface $kernel)
45			{
46	437		$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 2018-08-03 07:23 UTC by Report Bug Copy Issue Report 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	436		public function forceClearCache(PostResponseEvent $event)
			0 ignored issues – show Unused Code introduced 2018-08-01 05:34 UTC by Report Bug Copy Issue Report 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	436		if ($this->clearCacheAfterResponse === false) {
60	436		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			/**
89			* Doctrineのキャッシュを削除します.
90			* APP_ENV=prodの場合のみ実行されます.
91			*
92			* @param null $env
			0 ignored issues – show Bug introduced 2018-09-14 03:41 UTC by Report Bug Copy Issue Report There is no parameter named `$env`. Was it maybe removed? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. Consider the following example. The parameter `$italy` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $island * @param array $italy */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was removed, but the annotation was not. Loading history...
93			* @return string
94			* @throws \Exception
95			*/
96			public function clearDoctrineCache()
97			{
98			if ($this->kernel->getEnvironment() !== 'prod') {
99			return;
100			}
101			$console = new Application($this->kernel);
102	2		$console->setAutoExit(false);
103
104	2		$command = [
105			'command' => 'cache:pool:clear',
106	2		'pools' => ['doctrine.app_cache_pool'],
107	2		'--no-ansi' => true,
108	2		];
109	1
110	1		$input = new ArrayInput($command);
111	1
112			$output = new BufferedOutput(
113			OutputInterface::VERBOSITY_DEBUG,
114			true
115			);
116
117	1		$console->run($input, $output);
118	1
119	1		return $output->fetch();
120			}
121	1
122	1		/**
123	1		* Twigキャッシュを削除します.
124			*/
125	1		public function clearTwigCache()
126	1		{
127	1		$cacheDir = $this->kernel->getCacheDir().'/twig';
128			$fs = new Filesystem();
129	1		$fs->remove($cacheDir);
130			}
131
132			/**
133			* キャッシュを削除する.
134			*
135	2		* doctrine, profiler, twig によって生成されたキャッシュディレクトリを削除する.
136			* キャッシュは $app['config']['root_dir'].'/app/cache' に生成されます.
137			*
138			* @param Application $app
139	2		* @param boolean $isAll .gitkeep を残してすべてのファイル・ディレクトリを削除する場合 true, 各ディレクトリのみを削除する場合 false
140			* @param boolean $isTwig Twigキャッシュファイルのみ削除する場合 true
141			*
142			* @return boolean 削除に成功した場合 true
143			*
144	2		* @deprecated CacheUtil::clearCacheを利用すること
145			*/
146			public static function clear($app, $isAll, $isTwig = false)
147			{
148	2		$cacheDir = $app['config']['root_dir'].'/app/cache';
149
150			$filesystem = new Filesystem();
151			$finder = Finder::create()->notName('.gitkeep')->files();
152			if ($isAll) {
153			$finder = $finder->in($cacheDir);
154	1		$filesystem->remove($finder);
			0 ignored issues – show Documentation introduced 2017-11-24 11:36 UTC by Report Bug Copy Issue Report `$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...
155		View Code Duplication	} elseif ($isTwig) {
156	1		if (is_dir($cacheDir.'/twig')) {
157			$finder = $finder->in($cacheDir.'/twig');
158			$filesystem->remove($finder);
			0 ignored issues – show Documentation introduced 2017-11-24 11:36 UTC by Report Bug Copy Issue Report `$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...
159			}
160			} else {
161		View Code Duplication	if (is_dir($cacheDir.'/doctrine')) {
162			$finder = $finder->in($cacheDir.'/doctrine');
163			$filesystem->remove($finder);
			0 ignored issues – show Documentation introduced 2017-11-24 11:36 UTC by Report Bug Copy Issue Report `$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...
164			}
165		View Code Duplication	if (is_dir($cacheDir.'/profiler')) {
166			$finder = $finder->in($cacheDir.'/profiler');
167			$filesystem->remove($finder);
			0 ignored issues – show Documentation introduced 2017-11-24 11:36 UTC by Report Bug Copy Issue Report `$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...
168			}
169		View Code Duplication	if (is_dir($cacheDir.'/twig')) {
170			$finder = $finder->in($cacheDir.'/twig');
171			$filesystem->remove($finder);
			0 ignored issues – show Documentation introduced 2017-11-24 11:36 UTC by Report Bug Copy Issue Report `$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...
172			}
173		View Code Duplication	if (is_dir($cacheDir.'/translator')) {
174			$finder = $finder->in($cacheDir.'/translator');
175			$filesystem->remove($finder);
			0 ignored issues – show Documentation introduced 2017-11-24 11:36 UTC by Report Bug Copy Issue Report `$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...
176			}
177			}
178
179			if (function_exists('opcache_reset')) {
180			opcache_reset();
181			}
182
183			if (function_exists('apc_clear_cache')) {
184			apc_clear_cache('user');
185			apc_clear_cache();
186			}
187
188			if (function_exists('wincache_ucache_clear')) {
189			wincache_ucache_clear();
190			}
191
192			return true;
193			}
194
195			/**
196			* {@inheritdoc}
197			*/
198			public static function getSubscribedEvents()
199			{
200			return [KernelEvents::TERMINATE => 'forceClearCache'];
201			}
202			}
203

EC-CUBE / ec-cube

Pull Request — 4.0 (#3849)

CacheUtil::clearDoctrineCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like