BaiduBosAdapter::extractOptions() - Code Metrics - Inspection of "some improve" - xinningsu/flysystem-baidu-bos - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 08ce17...8d8d30 )

by Thomas

created 2021-03-04 16:05 UTC

BaiduBosAdapter::extractOptions() A

↳ Parent: BaiduBosAdapter

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	5
c	0
b	0
f	0
nc	3
nop	1
dl	0
loc	11
rs	10

<?php

namespace Sulao\Flysystem\BaiduBos;

use Exception;
use League\Flysystem\Adapter\AbstractAdapter;
use League\Flysystem\Config;
use League\Flysystem\Util;
use Sulao\BaiduBos\Client;

class BaiduBosAdapter extends AbstractAdapter
{
    use UtilTrait;

    /**
     * @var Client
     */
    protected $client;

    /**
     * BaiduBosAdapter constructor.
     *
     * @param Client $client
     */
    public function __construct(Client $client)
    {
        $this->client = $client;
    }

    /**
     * @return Client
     */
    public function getClient()
    {
        return $this->client;
    }

    /**
     * Write a new file.
     *
     * @param string $path
     * @param string $contents
     * @param Config $config   Config object
     *
     * @return array|false false on failure file meta data on success
     */
    public function write($path, $contents, Config $config)
    {
        try {
            $this->client
                ->putObject($path, $contents, $this->extractOptions($config));
        } catch (Exception $exception) {
            return  false;
        }

        return $this->client->getObjectMeta($path);
    }

    /**
     * Write a new file using a stream.
     *
     * @param string   $path
     * @param resource $resource
     * @param Config   $config   Config object
     *
     * @return array|false false on failure file meta data on success
     */
    public function writeStream($path, $resource, Config $config)
    {
        return $this->write($path, stream_get_contents($resource), $config);
    }

    /**
     * Update a file.
     *
     * @param string $path
     * @param string $contents
     * @param Config $config   Config object
     *
     * @return array|false false on failure file meta data on success
     */
    public function update($path, $contents, Config $config)
    {
        return $this->write($path, $contents, $config);
    }

    /**
     * Update a file using a stream.
     *
     * @param string   $path
     * @param resource $resource
     * @param Config   $config   Config object
     *
     * @return array|false false on failure file meta data on success
     */
    public function updateStream($path, $resource, Config $config)
    {
        return $this->writeStream($path, $resource, $config);
    }

    /**
     * Rename a file.
     *
     * @param string $path
     * @param string $newPath
     *
     * @return bool
     */
    public function rename($path, $newPath)
    {
        try {
            $this->client->copyObject($path, $newPath);
            $this->client->deleteObject($path);
        } catch (Exception $exception) {
            return false;
        }

        return true;
    }

    /**
     * Copy a file.
     *
     * @param string $path
     * @param string $newPath
     *
     * @return bool
     */
    public function copy($path, $newPath)
    {
        try {
            $this->client->copyObject($path, $newPath);
        } catch (Exception $exception) {
            return false;
        }

        return true;
    }

    /**
     * Delete a file.
     *
     * @param string $path
     *
     * @return bool
     */
    public function delete($path)
    {
        try {
            $this->client->deleteObject($path);
        } catch (Exception $exception) {
            return false;
        }

        return true;
    }

    /**
     * Delete a directory.
     *
     * @param string $dirname
     *
     * @return bool
     */
    public function deleteDir($dirname)
    {
        try {
            $this->client->deleteObject(rtrim($dirname, '/') . '/');
        } catch (Exception $exception) {
            return false;
        }

        return true;
    }

    /**
     * Create a directory.
     *
     * @param string $dirname directory name
     * @param Config $config
     *
     * @return bool
     */
    public function createDir($dirname, Config $config)
    {
        try {
            $this->client->putObject(
                rtrim($dirname, '/') . '/',
                '',
                $this->extractOptions($config)
            );
        } catch (Exception $exception) {
            return false;
        }

        return true;
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
    }

    /**
     * Check whether a file exists.
     *
     * @param string $path
     *
     * @return bool
     */
    public function has($path)
    {
        try {
            $this->client->getObjectMeta($path);
        } catch (Exception $exception) {
            return false;
        }

        return true;
    }

    /**
     * Read a file.
     *
     * @param string $path
     *
     * @return array|false
     */
    public function read($path)
    {
        try {
            $contents = $this->client->getObject($path);
        } catch (Exception $exception) {
            return false;
        }

        return compact('path', 'contents');
    }

    /**
     * Read a file as a stream.
     *
     * @param string $path
     *
     * @return array|false
     */
    public function readStream($path)
    {
        $result = $this->read($path);
        if ($result === false) {
            return false;
        }

        $stream = fopen('php://temp', 'w+b');
        fputs($stream, $result['contents']);
        rewind($stream);

        return compact('path', 'stream');
    }

    /**
     * List contents of a directory.
     *
     * @param string $directory
     * @param bool   $recursive
     *
     * @return array
     */
    public function listContents($directory = '', $recursive = false)
    {
        $options = [];

        if (!$recursive) {
            $options['query']['delimiter'] = '/';
        }

        $directory = trim($directory, '/');
        if ($directory !== '') {
            $directory .= '/';
            $options['query']['prefix'] = $directory;
        }

        $result = $this->client->listObjects($options);

        $contents = [];
        foreach ($result['contents'] as $row) {
            if ($row['key'] === $directory) {
                continue;
            }

            $contents[] = $this->normalizeContent($row);
        }

        return $contents;
    }

    /**
     * Get all the meta data of a file or directory.
     *
     * @param string $path
     *
     * @return array|false
     */
    public function getMetadata($path)
    {
        try {
            $meta = $this->client->getObjectMeta($path);
        } catch (Exception $exception) {
            return false;
        }

        return $this->normalizeMeta($meta, $path);
    }

    /**
     * Get the size of a file.
     *
     * @param string $path
     *
     * @return array|false
     */
    public function getSize($path)
    {
        return $this->getMetadata($path);
    }

    /**
     * Get the mime-type of a file.
     *
     * @param string $path
     *
     * @return array|false
     */
    public function getMimeType($path)
    {
        return $this->getMetadata($path);
    }

    /**
     * Get the timestamp of a file.
     *
     * @param string $path
     *
     * @return array|false
     */
    public function getTimestamp($path)
    {
        return $this->getMetadata($path);
    }

    /**
     * Get the visibility of a file.
     *
     * @param string $path
     *
     * @return array|false
     */
    public function getVisibility($path)
    {
        $acl = $this->getObjectAcl($path);
        if ($acl === false) {
            return false;
        }

        $permissions = $this->extractPermissions($acl);

        if (in_array('READ', $permissions)) {
            $visibility = 'public-read';
        } else {
            $visibility = 'private';
        }

        return compact('path', 'visibility');
    }

    /**
     * Set the visibility for a file.
     *
     * @param string $path
     * @param string $visibility
     *
     * @return array|false file meta data
     */
    public function setVisibility($path, $visibility)
    {
        try {
            $this->client->putObjectAcl($path, $visibility);
        } catch (Exception $exception) {
            return false;
        }

        return compact('path', 'visibility');
    }

    /**
     * Get object acl, if not set, return bucket acl
     *
     * @param $path
     *
     * @return array|false
     */
    protected function getObjectAcl($path)
    {
        try {
            $result = $this->client->getObjectAcl($path);
            return $result['accessControlList'];
        } catch (Exception $exception) {
            if ($exception->getCode() == 404) {
                return $this->getBucketAcl();
            }
        }

        return false;
    }

    /**
     * Get bucket acl
     *
     * @return array|false
     */
    protected function getBucketAcl()
    {
        try {
            $result = $this->client->getBucketAcl();
        } catch (Exception $exception) {
            return false;
        }

        return $result['accessControlList'];
    }
}


1			<?php
2
3			namespace Sulao\Flysystem\BaiduBos;
4
5			use Exception;
6			use League\Flysystem\Adapter\AbstractAdapter;
7			use League\Flysystem\Config;
8			use League\Flysystem\Util;
9			use Sulao\BaiduBos\Client;
10
11			class BaiduBosAdapter extends AbstractAdapter
12			{
13			use UtilTrait;
14
15			/**
16			* @var Client
17			*/
18			protected $client;
19
20			/**
21			* BaiduBosAdapter constructor.
22			*
23			* @param Client $client
24			*/
25			public function __construct(Client $client)
26			{
27			$this->client = $client;
28			}
29
30			/**
31			* @return Client
32			*/
33			public function getClient()
34			{
35			return $this->client;
36			}
37
38			/**
39			* Write a new file.
40			*
41			* @param string $path
42			* @param string $contents
43			* @param Config $config Config object
44			*
45			* @return array\|false false on failure file meta data on success
46			*/
47			public function write($path, $contents, Config $config)
48			{
49			try {
50			$this->client
51			->putObject($path, $contents, $this->extractOptions($config));
52			} catch (Exception $exception) {
53			return false;
54			}
55
56			return $this->client->getObjectMeta($path);
57			}
58
59			/**
60			* Write a new file using a stream.
61			*
62			* @param string $path
63			* @param resource $resource
64			* @param Config $config Config object
65			*
66			* @return array\|false false on failure file meta data on success
67			*/
68			public function writeStream($path, $resource, Config $config)
69			{
70			return $this->write($path, stream_get_contents($resource), $config);
71			}
72
73			/**
74			* Update a file.
75			*
76			* @param string $path
77			* @param string $contents
78			* @param Config $config Config object
79			*
80			* @return array\|false false on failure file meta data on success
81			*/
82			public function update($path, $contents, Config $config)
83			{
84			return $this->write($path, $contents, $config);
85			}
86
87			/**
88			* Update a file using a stream.
89			*
90			* @param string $path
91			* @param resource $resource
92			* @param Config $config Config object
93			*
94			* @return array\|false false on failure file meta data on success
95			*/
96			public function updateStream($path, $resource, Config $config)
97			{
98			return $this->writeStream($path, $resource, $config);
99			}
100
101			/**
102			* Rename a file.
103			*
104			* @param string $path
105			* @param string $newPath
106			*
107			* @return bool
108			*/
109			public function rename($path, $newPath)
110			{
111			try {
112			$this->client->copyObject($path, $newPath);
113			$this->client->deleteObject($path);
114			} catch (Exception $exception) {
115			return false;
116			}
117
118			return true;
119			}
120
121			/**
122			* Copy a file.
123			*
124			* @param string $path
125			* @param string $newPath
126			*
127			* @return bool
128			*/
129			public function copy($path, $newPath)
130			{
131			try {
132			$this->client->copyObject($path, $newPath);
133			} catch (Exception $exception) {
134			return false;
135			}
136
137			return true;
138			}
139
140			/**
141			* Delete a file.
142			*
143			* @param string $path
144			*
145			* @return bool
146			*/
147			public function delete($path)
148			{
149			try {
150			$this->client->deleteObject($path);
151			} catch (Exception $exception) {
152			return false;
153			}
154
155			return true;
156			}
157
158			/**
159			* Delete a directory.
160			*
161			* @param string $dirname
162			*
163			* @return bool
164			*/
165			public function deleteDir($dirname)
166			{
167			try {
168			$this->client->deleteObject(rtrim($dirname, '/') . '/');
169			} catch (Exception $exception) {
170			return false;
171			}
172
173			return true;
174			}
175
176			/**
177			* Create a directory.
178			*
179			* @param string $dirname directory name
180			* @param Config $config
181			*
182			* @return bool
183			*/
184			public function createDir($dirname, Config $config)
185			{
186			try {
187			$this->client->putObject(
188			rtrim($dirname, '/') . '/',
189			'',
190			$this->extractOptions($config)
191			);
192			} catch (Exception $exception) {
193			return false;
194			}
195
196			return true;
			0 ignored issues – show Bug Best Practice introduced 2021-03-04 15:37 UTC by Report Bug Copy Issue Report The expression `return true` returns the type `true` which is incompatible with the return type mandated by `League\Flysystem\AdapterInterface::createDir()` of `array\|false`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
197			}
198
199			/**
200			* Check whether a file exists.
201			*
202			* @param string $path
203			*
204			* @return bool
205			*/
206			public function has($path)
207			{
208			try {
209			$this->client->getObjectMeta($path);
210			} catch (Exception $exception) {
211			return false;
212			}
213
214			return true;
215			}
216
217			/**
218			* Read a file.
219			*
220			* @param string $path
221			*
222			* @return array\|false
223			*/
224			public function read($path)
225			{
226			try {
227			$contents = $this->client->getObject($path);
228			} catch (Exception $exception) {
229			return false;
230			}
231
232			return compact('path', 'contents');
233			}
234
235			/**
236			* Read a file as a stream.
237			*
238			* @param string $path
239			*
240			* @return array\|false
241			*/
242			public function readStream($path)
243			{
244			$result = $this->read($path);
245			if ($result === false) {
246			return false;
247			}
248
249			$stream = fopen('php://temp', 'w+b');
250			fputs($stream, $result['contents']);
251			rewind($stream);
252
253			return compact('path', 'stream');
254			}
255
256			/**
257			* List contents of a directory.
258			*
259			* @param string $directory
260			* @param bool $recursive
261			*
262			* @return array
263			*/
264			public function listContents($directory = '', $recursive = false)
265			{
266			$options = [];
267
268			if (!$recursive) {
269			$options['query']['delimiter'] = '/';
270			}
271
272			$directory = trim($directory, '/');
273			if ($directory !== '') {
274			$directory .= '/';
275			$options['query']['prefix'] = $directory;
276			}
277
278			$result = $this->client->listObjects($options);
279
280			$contents = [];
281			foreach ($result['contents'] as $row) {
282			if ($row['key'] === $directory) {
283			continue;
284			}
285
286			$contents[] = $this->normalizeContent($row);
287			}
288
289			return $contents;
290			}
291
292			/**
293			* Get all the meta data of a file or directory.
294			*
295			* @param string $path
296			*
297			* @return array\|false
298			*/
299			public function getMetadata($path)
300			{
301			try {
302			$meta = $this->client->getObjectMeta($path);
303			} catch (Exception $exception) {
304			return false;
305			}
306
307			return $this->normalizeMeta($meta, $path);
308			}
309
310			/**
311			* Get the size of a file.
312			*
313			* @param string $path
314			*
315			* @return array\|false
316			*/
317			public function getSize($path)
318			{
319			return $this->getMetadata($path);
320			}
321
322			/**
323			* Get the mime-type of a file.
324			*
325			* @param string $path
326			*
327			* @return array\|false
328			*/
329			public function getMimeType($path)
330			{
331			return $this->getMetadata($path);
332			}
333
334			/**
335			* Get the timestamp of a file.
336			*
337			* @param string $path
338			*
339			* @return array\|false
340			*/
341			public function getTimestamp($path)
342			{
343			return $this->getMetadata($path);
344			}
345
346			/**
347			* Get the visibility of a file.
348			*
349			* @param string $path
350			*
351			* @return array\|false
352			*/
353			public function getVisibility($path)
354			{
355			$acl = $this->getObjectAcl($path);
356			if ($acl === false) {
357			return false;
358			}
359
360			$permissions = $this->extractPermissions($acl);
361
362			if (in_array('READ', $permissions)) {
363			$visibility = 'public-read';
364			} else {
365			$visibility = 'private';
366			}
367
368			return compact('path', 'visibility');
369			}
370
371			/**
372			* Set the visibility for a file.
373			*
374			* @param string $path
375			* @param string $visibility
376			*
377			* @return array\|false file meta data
378			*/
379			public function setVisibility($path, $visibility)
380			{
381			try {
382			$this->client->putObjectAcl($path, $visibility);
383			} catch (Exception $exception) {
384			return false;
385			}
386
387			return compact('path', 'visibility');
388			}
389
390			/**
391			* Get object acl, if not set, return bucket acl
392			*
393			* @param $path
394			*
395			* @return array\|false
396			*/
397			protected function getObjectAcl($path)
398			{
399			try {
400			$result = $this->client->getObjectAcl($path);
401			return $result['accessControlList'];
402			} catch (Exception $exception) {
403			if ($exception->getCode() == 404) {
404			return $this->getBucketAcl();
405			}
406			}
407
408			return false;
409			}
410
411			/**
412			* Get bucket acl
413			*
414			* @return array\|false
415			*/
416			protected function getBucketAcl()
417			{
418			try {
419			$result = $this->client->getBucketAcl();
420			} catch (Exception $exception) {
421			return false;
422			}
423
424			return $result['accessControlList'];
425			}
426			}
427

xinningsu / flysystem-baidu-bos

Push — master ( 08ce17...8d8d30 )

BaiduBosAdapter::extractOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like