MultiplexerClient::flush() - Code Metrics - Inspection of "Clear cache with ClearCapable" - FriendsOfSymfony/FOSHttpCache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#440)

by David

created 2018-11-06 13:40 UTC

MultiplexerClient::flush() A

↳ Parent: MultiplexerClient

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	5
cts	5
cp	1
rs	9.9666
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2

<?php

/*
 * This file is part of the FOSHttpCache 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\HttpCache\ProxyClient;

use FOS\HttpCache\Exception\ExceptionCollection;
use FOS\HttpCache\Exception\InvalidArgumentException;
use FOS\HttpCache\ProxyClient\Invalidation\BanCapable;
use FOS\HttpCache\ProxyClient\Invalidation\ClearCapable;
use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;

/**
 * This class forwards invalidation to all attached clients.
 *
 * @author Emanuele Panzeri <[email protected]>
 */
class MultiplexerClient implements BanCapable, PurgeCapable, RefreshCapable, TagCapable, ClearCapable
{
    /**
     * @var ProxyClient[]
     */
    private $proxyClients;

    /**
     * MultiplexerClient constructor.
     *
     * @param ProxyClient[] $proxyClients The list of Proxy clients
     */
    public function __construct(array $proxyClients)
    {
        foreach ($proxyClients as $proxyClient) {
            if (!$proxyClient instanceof ProxyClient) {
                throw new InvalidArgumentException(
                    'Expected ProxyClientInterface, got: '.
                    (is_object($proxyClient) ? get_class($proxyClient) : gettype($proxyClient))
                );
            }
        }

        $this->proxyClients = $proxyClients;
    }

    /**
     * Forwards to all clients.
     *
     * @param array $headers HTTP headers that path must match to be banned
     *
     * @return $this
     */
    public function ban(array $headers)
    {
        $this->invoke(BanCapable::class, 'ban', [$headers]);

        return $this;
    }

    /**
     * Forwards to all clients.
     *
     * @param string       $path        Regular expression pattern for URI to invalidate
     * @param string       $contentType Regular expression pattern for the content type to limit banning, for instance
     *                                  'text'
     * @param array|string $hosts       Regular expression of a host name or list of exact host names to limit banning
     *
     * @return $this
     */
    public function banPath($path, $contentType = null, $hosts = null)
    {
        $this->invoke(BanCapable::class, 'banPath', [$path, $contentType, $hosts]);

        return $this;
    }

    /**
     * Forwards to all clients.
     *
     * @throws ExceptionCollection If any errors occurred during flush
     *
     * @return int The number of cache invalidations performed per caching server
     */
    public function flush()
    {
        $count = 0;
        foreach ($this->proxyClients as $proxyClient) {
            $count += $proxyClient->flush();
        }

        return $count;
    }

    /**
     * Forwards tag invalidation request to all clients.
     *
     * {@inheritdoc}
     *
     * @param array $tags
     *
     * @return $this
     */
    public function invalidateTags(array $tags)
    {
        $this->invoke(TagCapable::class, 'invalidateTags', [$tags]);

        return $this;
    }

    /**
     * Forwards to all clients.
     *
     * @param string $url     Path or URL to purge
     * @param array  $headers Extra HTTP headers to send to the caching proxy (optional)
     *
     * @return $this
     */
    public function purge($url, array $headers = [])
    {
        $this->invoke(PurgeCapable::class, 'purge', [$url, $headers]);

        return $this;
    }

    /**
     * Forwards to all clients.
     *
     * @param string $url     Path or URL to refresh
     * @param array  $headers Extra HTTP headers to send to the caching proxy (optional)
     *
     * @return $this
     */
    public function refresh($url, array $headers = [])
    {
        $this->invoke(RefreshCapable::class, 'refresh', [$url, $headers]);

        return $this;
    }

    /**
     * Forwards to all clients.
     *
     * @return $this
     */
    public function clear()
    {
        $this->invoke(ClearCapable::class, 'clear', []);

        return $this;
    }

    /**
     * Invoke the given $method on all available ProxyClients implementing the
     * given $interface.
     *
     * @param string $interface The FQN of the interface
     * @param string $method    The method to invoke
     * @param array  $arguments The arguments to be passed to the method
     */
    private function invoke($interface, $method, array $arguments)
    {
        foreach ($this->getProxyClients($interface) as $proxyClient) {
            call_user_func_array([$proxyClient, $method], $arguments);
        }
    }

    /**
     * Get proxy clients that implement a feature interface.
     *
     * @param string $interface
     *
     * @return ProxyClient[]
     */
    private function getProxyClients($interface)
    {
        return array_filter(
            $this->proxyClients,
            function ($proxyClient) use ($interface) {
                return is_subclass_of($proxyClient, $interface);
            }
        );
    }
}


1		<?php
2
3		/*
4		* This file is part of the FOSHttpCache 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\HttpCache\ProxyClient;
13
14		use FOS\HttpCache\Exception\ExceptionCollection;
15		use FOS\HttpCache\Exception\InvalidArgumentException;
16		use FOS\HttpCache\ProxyClient\Invalidation\BanCapable;
17		use FOS\HttpCache\ProxyClient\Invalidation\ClearCapable;
18		use FOS\HttpCache\ProxyClient\Invalidation\PurgeCapable;
19		use FOS\HttpCache\ProxyClient\Invalidation\RefreshCapable;
20		use FOS\HttpCache\ProxyClient\Invalidation\TagCapable;
21
22		/**
23		* This class forwards invalidation to all attached clients.
24		*
25		* @author Emanuele Panzeri <[email protected]>
26		*/
27		class MultiplexerClient implements BanCapable, PurgeCapable, RefreshCapable, TagCapable, ClearCapable
28		{
29		/**
30		* @var ProxyClient[]
31		*/
32		private $proxyClients;
33
34		/**
35		* MultiplexerClient constructor.
36		*
37		* @param ProxyClient[] $proxyClients The list of Proxy clients
38		*/
39	8	public function __construct(array $proxyClients)
40		{
41	8	foreach ($proxyClients as $proxyClient) {
42	8	if (!$proxyClient instanceof ProxyClient) {
43	2	throw new InvalidArgumentException(
44		'Expected ProxyClientInterface, got: '.
45	8	(is_object($proxyClient) ? get_class($proxyClient) : gettype($proxyClient))
46		);
47		}
48		}
49
50	6	$this->proxyClients = $proxyClients;
51	6	}
52
53		/**
54		* Forwards to all clients.
55		*
56		* @param array $headers HTTP headers that path must match to be banned
57		*
58		* @return $this
59		*/
60	1	public function ban(array $headers)
61		{
62	1	$this->invoke(BanCapable::class, 'ban', [$headers]);
63
64	1	return $this;
65		}
66
67		/**
68		* Forwards to all clients.
69		*
70		* @param string $path Regular expression pattern for URI to invalidate
71		* @param string $contentType Regular expression pattern for the content type to limit banning, for instance
72		* 'text'
73		* @param array\|string $hosts Regular expression of a host name or list of exact host names to limit banning
74		*
75		* @return $this
76		*/
77	1	public function banPath($path, $contentType = null, $hosts = null)
78		{
79	1	$this->invoke(BanCapable::class, 'banPath', [$path, $contentType, $hosts]);
80
81	1	return $this;
82		}
83
84		/**
85		* Forwards to all clients.
86		*
87		* @throws ExceptionCollection If any errors occurred during flush
88		*
89		* @return int The number of cache invalidations performed per caching server
90		*/
91	1	public function flush()
92		{
93	1	$count = 0;
94	1	foreach ($this->proxyClients as $proxyClient) {
95	1	$count += $proxyClient->flush();
96		}
97
98	1	return $count;
99		}
100
101		/**
102		* Forwards tag invalidation request to all clients.
103		*
104		* {@inheritdoc}
105		*
106		* @param array $tags
107		*
108		* @return $this
109		*/
110	1	public function invalidateTags(array $tags)
111		{
112	1	$this->invoke(TagCapable::class, 'invalidateTags', [$tags]);
113
114	1	return $this;
115		}
116
117		/**
118		* Forwards to all clients.
119		*
120		* @param string $url Path or URL to purge
121		* @param array $headers Extra HTTP headers to send to the caching proxy (optional)
122		*
123		* @return $this
124		*/
125	1	public function purge($url, array $headers = [])
126		{
127	1	$this->invoke(PurgeCapable::class, 'purge', [$url, $headers]);
128
129	1	return $this;
130		}
131
132		/**
133		* Forwards to all clients.
134		*
135		* @param string $url Path or URL to refresh
136		* @param array $headers Extra HTTP headers to send to the caching proxy (optional)
137		*
138		* @return $this
139		*/
140	1	public function refresh($url, array $headers = [])
141		{
142	1	$this->invoke(RefreshCapable::class, 'refresh', [$url, $headers]);
143
144	1	return $this;
145		}
146
147		/**
148		* Forwards to all clients.
149		*
150		* @return $this
151		*/
152		public function clear()
153		{
154		$this->invoke(ClearCapable::class, 'clear', []);
155	5
156		return $this;
157	5	}
158	5
159		/**
160	5	* Invoke the given $method on all available ProxyClients implementing the
161		* given $interface.
162		*
163		* @param string $interface The FQN of the interface
164		* @param string $method The method to invoke
165		* @param array $arguments The arguments to be passed to the method
166		*/
167		private function invoke($interface, $method, array $arguments)
168		{
169		foreach ($this->getProxyClients($interface) as $proxyClient) {
170		call_user_func_array([$proxyClient, $method], $arguments);
171		}
172		}
173
174		/**
175		* Get proxy clients that implement a feature interface.
176		*
177		* @param string $interface
178		*
179		* @return ProxyClient[]
180		*/
181		private function getProxyClients($interface)
182		{
183		return array_filter(
184		$this->proxyClients,
185		function ($proxyClient) use ($interface) {
186		return is_subclass_of($proxyClient, $interface);
187		}
188		);
189		}
190		}
191

FriendsOfSymfony / FOSHttpCache

Pull Request — master (#440)

MultiplexerClient::flush() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like