Client::hasEncoder() - Code Metrics - Inspection of "3a0aa459e31a406e978213db9a9d11e858292bfc" - matecat/simple-s3 - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Branch — master (3a0aa4)

by Domenico

created 2025-10-29 18:00 UTC

Client::hasEncoder() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
crap	1

<?php
/**
 *  This file is part of the Simple S3 package.
 *
 * (c) Mauro Cassani<https://github.com/mauretto78>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 */

namespace Matecat\SimpleS3;

use Aws\ResultInterface;
use Aws\S3\S3Client;
use InvalidArgumentException;
use Matecat\SimpleS3\Commands\CommandHandler;
use Matecat\SimpleS3\Components\Cache\CacheInterface;
filter:
    dependency_paths: ["lib/*"]
use Matecat\SimpleS3\Components\Encoders\SafeNameEncoderInterface;
use Psr\Http\Message\UriInterface;
use Psr\Log\LoggerInterface;

/**
 * Class Client
 *
 * This class is a simple wrapper of Aws\S3\S3Client
 * -------------------------------------------------------------------------
 *
 * Method list:
 *
 * @method bool clearBucket(array $input)
 * @method bool copyFolder(array $input)
 * @method bool copyInBatch(array $input)
 * @method bool copyItem(array $input)
 * @method bool createBucketIfItDoesNotExist(array $input)
 * @method bool createFolder(array $input)
 * @method bool deleteBucket(array $input)
 * @method bool deleteBucketPolicy(array $input)
 * @method bool deleteFolder(array $input)
 * @method bool deleteItem(array $input)
 * @method bool downloadItem(array $input)
 * @method bool enableAcceleration(array $input)
 * @method ResultInterface|mixed getBucketLifeCycleConfiguration(array $input)
 * @method mixed getBucketPolicy(array $input)
 * @method int|mixed getBucketSize(array $input)
 * @method null|string getCurrentItemVersion(array $input)
 * @method ResultInterface|mixed getItem(array $input)
 * @method array getItemsInABucket(array $input)
 * @method array getItemsInAVersionedBucket(array $input)
 * @method UriInterface getPublicItemLink(array $input)
 * @method bool hasBucket(array $input)
 * @method bool hasFolder(array $input)
 * @method bool hasItem(array $input)
 * @method bool isBucketVersioned(array $input)
 * @method mixed|UriInterface openItem(array $input)
 * @method bool restoreItem(array $input)
 * @method bool setBucketLifecycleConfiguration(array $input)
 * @method bool setBucketPolicy(array $input)
 * @method bool setBucketVersioning(array $input)
 * @method bool transfer(array $input)
 * @method bool uploadItem(array $input)
 * @method bool uploadItemFromBody(array $input)
 *
 * @package SimpleS3
 */
final class Client
{
    /**
     * @var string
     */
    private string $prefixSeparator = DIRECTORY_SEPARATOR;

    /**
     * @var CacheInterface|null
     */
    private ?CacheInterface $cache = null;

    /**
     * @var SafeNameEncoderInterface|null
     */
    private ?SafeNameEncoderInterface $encoder = null;

    /**
     * @var ?LoggerInterface
     */
    private ?LoggerInterface $logger = null;

    /**
     * @var S3Client
     */
    private S3Client $s3;

    /**
     * @var bool
     */
    private bool $sslVerify = true;

    /**
     * @var int
     */
    private int $filenameMaxSize;

    /**
     * Client constructor.
     *
     * @param array $config
     */
    public function __construct(array $config)
    {
        $this->s3              = ClientFactory::create($config);
        $this->filenameMaxSize = 255;
    }

    /**
     * Calls the invoked CommandHandler.
     * It checks if the class exists and
     * if the passed parameters are valid
     *
     * @param string                      $name
     * @param array<array<string,string>> $args
     *
     * @return mixed
     */
    public function __call(string $name, array $args)
    {
        $params = $args[ 0 ] ?? [];

        $commandHandler = 'Matecat\\SimpleS3\\Commands\\Handlers\\' . ucfirst($name);

        if (false === class_exists($commandHandler)) {
            throw new InvalidArgumentException($commandHandler . ' is not a valid command name. Please refer to README to get the complete command list.');
        }

        /** @var CommandHandler $commandHandler */
        $commandHandler = new $commandHandler($this);

        if ($commandHandler->validateParams($params)) {
            return $commandHandler->handle($params);
        }
    }

    /**
     * @param CacheInterface $cache
     */
    public function addCache(CacheInterface $cache): void
    {
        $this->cache = $cache;
        $this->cache->setPrefixSeparator($this->prefixSeparator);
    }

    /**
     * @return bool
     */
    public function hasCache(): bool
    {
        return null !== $this->cache;
    }

    /**
     * @return CacheInterface|null
     */
    public function getCache(): ?CacheInterface
    {
        return $this->cache;
    }

    /**
     * @param SafeNameEncoderInterface $encoder
     */
    public function addEncoder(SafeNameEncoderInterface $encoder): void
    {
        $this->encoder = $encoder;
    }

    /**
     * @return bool
     */
    public function hasEncoder(): bool
    {
        return null !== $this->encoder;
    }

    /**
     * @return SafeNameEncoderInterface|null
     */
    public function getEncoder(): ?SafeNameEncoderInterface
    {
        return $this->encoder;
    }

    /**
     * @param LoggerInterface $logger
     */
    public function addLogger(LoggerInterface $logger): void
    {
        $this->logger = $logger;
    }

    /**
     * @return bool
     */
    public function hasLogger(): bool
    {
        return null !== $this->logger;
    }

    /**
     * @return LoggerInterface|null
     */
    public function getLogger(): ?LoggerInterface
    {
        return $this->logger;
    }

    /**
     * @return S3Client
     */
    public function getConn(): S3Client
    {
        return $this->s3;
    }

    /**
     * Disable SSL verify
     */
    public function disableSslVerify(): void
    {
        $this->sslVerify = false;
    }

    /**
     * @return bool
     */
    public function hasSslVerify(): bool
    {
        return $this->sslVerify;
    }

    /**
     * @param string $separator
     */
    public function setPrefixSeparator(string $separator): void
    {
        $this->prefixSeparator = $separator;
    }

    /**
     * @return string
     */
    public function getPrefixSeparator(): string
    {
        return $this->prefixSeparator;
    }

    /**
     * @return int
     */
    public function getFilenameMaxSize(): int
    {
        return $this->filenameMaxSize;
    }

    /**
     * @param int $filenameMaxSize
     */
    public function setFilenameMaxSize(int $filenameMaxSize): void
    {
        $this->filenameMaxSize = $filenameMaxSize;
    }
}


1		<?php
2		/**
3		* This file is part of the Simple S3 package.
4		*
5		* (c) Mauro Cassani<https://github.com/mauretto78>
6		*
7		* For the full copyright and license information, please view the LICENSE
8		* file that was distributed with this source code.
9		*
10		*/
11
12		namespace Matecat\SimpleS3;
13
14		use Aws\ResultInterface;
15		use Aws\S3\S3Client;
16		use InvalidArgumentException;
17		use Matecat\SimpleS3\Commands\CommandHandler;
18		use Matecat\SimpleS3\Components\Cache\CacheInterface;
		0 ignored issues – show Bug introduced 2025-10-29 17:05 UTC by Report Bug Copy Issue Report The type `Matecat\SimpleS3\Components\Cache\CacheInterface` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
19		use Matecat\SimpleS3\Components\Encoders\SafeNameEncoderInterface;
20		use Psr\Http\Message\UriInterface;
21		use Psr\Log\LoggerInterface;
22
23		/**
24		* Class Client
25		*
26		* This class is a simple wrapper of Aws\S3\S3Client
27		* -------------------------------------------------------------------------
28		*
29		* Method list:
30		*
31		* @method bool clearBucket(array $input)
32		* @method bool copyFolder(array $input)
33		* @method bool copyInBatch(array $input)
34		* @method bool copyItem(array $input)
35		* @method bool createBucketIfItDoesNotExist(array $input)
36		* @method bool createFolder(array $input)
37		* @method bool deleteBucket(array $input)
38		* @method bool deleteBucketPolicy(array $input)
39		* @method bool deleteFolder(array $input)
40		* @method bool deleteItem(array $input)
41		* @method bool downloadItem(array $input)
42		* @method bool enableAcceleration(array $input)
43		* @method ResultInterface\|mixed getBucketLifeCycleConfiguration(array $input)
44		* @method mixed getBucketPolicy(array $input)
45		* @method int\|mixed getBucketSize(array $input)
46		* @method null\|string getCurrentItemVersion(array $input)
47		* @method ResultInterface\|mixed getItem(array $input)
48		* @method array getItemsInABucket(array $input)
49		* @method array getItemsInAVersionedBucket(array $input)
50		* @method UriInterface getPublicItemLink(array $input)
51		* @method bool hasBucket(array $input)
52		* @method bool hasFolder(array $input)
53		* @method bool hasItem(array $input)
54		* @method bool isBucketVersioned(array $input)
55		* @method mixed\|UriInterface openItem(array $input)
56		* @method bool restoreItem(array $input)
57		* @method bool setBucketLifecycleConfiguration(array $input)
58		* @method bool setBucketPolicy(array $input)
59		* @method bool setBucketVersioning(array $input)
60		* @method bool transfer(array $input)
61		* @method bool uploadItem(array $input)
62		* @method bool uploadItemFromBody(array $input)
63		*
64		* @package SimpleS3
65		*/
66		final class Client
67		{
68		/**
69		* @var string
70		*/
71		private string $prefixSeparator = DIRECTORY_SEPARATOR;
72
73		/**
74		* @var CacheInterface\|null
75		*/
76		private ?CacheInterface $cache = null;
77
78		/**
79		* @var SafeNameEncoderInterface\|null
80		*/
81		private ?SafeNameEncoderInterface $encoder = null;
82
83		/**
84		* @var ?LoggerInterface
85		*/
86		private ?LoggerInterface $logger = null;
87
88		/**
89		* @var S3Client
90		*/
91		private S3Client $s3;
92
93		/**
94		* @var bool
95		*/
96		private bool $sslVerify = true;
97
98		/**
99		* @var int
100		*/
101		private int $filenameMaxSize;
102
103		/**
104		* Client constructor.
105		*
106		* @param array $config
107		*/
108	39	public function __construct(array $config)
109		{
110	39	$this->s3 = ClientFactory::create($config);
111	39	$this->filenameMaxSize = 255;
112		}
113
114		/**
115		* Calls the invoked CommandHandler.
116		* It checks if the class exists and
117		* if the passed parameters are valid
118		*
119		* @param string $name
120		* @param array<array<string,string>> $args
121		*
122		* @return mixed
123		*/
124	39	public function __call(string $name, array $args)
125		{
126	39	$params = $args[ 0 ] ?? [];
127
128	39	$commandHandler = 'Matecat\\SimpleS3\\Commands\\Handlers\\' . ucfirst($name);
129
130	39	if (false === class_exists($commandHandler)) {
131		throw new InvalidArgumentException($commandHandler . ' is not a valid command name. Please refer to README to get the complete command list.');
132		}
133
134		/** @var CommandHandler $commandHandler */
135	39	$commandHandler = new $commandHandler($this);
136
137	39	if ($commandHandler->validateParams($params)) {
138	39	return $commandHandler->handle($params);
139		}
140		}
141
142		/**
143		* @param CacheInterface $cache
144		*/
145	30	public function addCache(CacheInterface $cache): void
146		{
147	30	$this->cache = $cache;
148	30	$this->cache->setPrefixSeparator($this->prefixSeparator);
149		}
150
151		/**
152		* @return bool
153		*/
154	27	public function hasCache(): bool
155		{
156	27	return null !== $this->cache;
157		}
158
159		/**
160		* @return CacheInterface\|null
161		*/
162	20	public function getCache(): ?CacheInterface
163		{
164	20	return $this->cache;
165		}
166
167		/**
168		* @param SafeNameEncoderInterface $encoder
169		*/
170	34	public function addEncoder(SafeNameEncoderInterface $encoder): void
171		{
172	34	$this->encoder = $encoder;
173		}
174
175		/**
176		* @return bool
177		*/
178	27	public function hasEncoder(): bool
179		{
180	27	return null !== $this->encoder;
181		}
182
183		/**
184		* @return SafeNameEncoderInterface\|null
185		*/
186	22	public function getEncoder(): ?SafeNameEncoderInterface
187		{
188	22	return $this->encoder;
189		}
190
191		/**
192		* @param LoggerInterface $logger
193		*/
194	35	public function addLogger(LoggerInterface $logger): void
195		{
196	35	$this->logger = $logger;
197		}
198
199		/**
200		* @return bool
201		*/
202	39	public function hasLogger(): bool
203		{
204	39	return null !== $this->logger;
205		}
206
207		/**
208		* @return LoggerInterface\|null
209		*/
210	35	public function getLogger(): ?LoggerInterface
211		{
212	35	return $this->logger;
213		}
214
215		/**
216		* @return S3Client
217		*/
218	34	public function getConn(): S3Client
219		{
220	34	return $this->s3;
221		}
222
223		/**
224		* Disable SSL verify
225		*/
226		public function disableSslVerify(): void
227		{
228		$this->sslVerify = false;
229		}
230
231		/**
232		* @return bool
233		*/
234	2	public function hasSslVerify(): bool
235		{
236	2	return $this->sslVerify;
237		}
238
239		/**
240		* @param string $separator
241		*/
242	2	public function setPrefixSeparator(string $separator): void
243		{
244	2	$this->prefixSeparator = $separator;
245		}
246
247		/**
248		* @return string
249		*/
250	21	public function getPrefixSeparator(): string
251		{
252	21	return $this->prefixSeparator;
253		}
254
255		/**
256		* @return int
257		*/
258		public function getFilenameMaxSize(): int
259		{
260		return $this->filenameMaxSize;
261		}
262
263		/**
264		* @param int $filenameMaxSize
265		*/
266		public function setFilenameMaxSize(int $filenameMaxSize): void
267		{
268		$this->filenameMaxSize = $filenameMaxSize;
269		}
270		}
271

matecat / simple-s3

Branch — master (3a0aa4)

Client::hasEncoder() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like