File::supportsMetadata() - Code Metrics - Inspection of "Add rename method to File" - KnpLabs/Gaufrette - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#468)

by Albin

created 2017-03-28 21:57 UTC

File::supportsMetadata() A

↳ Parent: File

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Gaufrette;

use Gaufrette\Adapter\MetadataSupporter;
use Gaufrette\Exception\FileNotFound;

/**
 * Points to a file in a filesystem.
 *
 * @author Antoine Hérault <[email protected]>
 */
class File
{
    protected $key;
    protected $filesystem;

    /**
     * Content variable is lazy. It will not be read from filesystem until it's requested first time.
     *
     * @var mixed content
     */
    protected $content = null;

    /**
     * @var array metadata in associative array. Only for adapters that support metadata
     */
    protected $metadata = null;

    /**
     * Human readable filename (usually the end of the key).
     *
     * @var string name
     */
    protected $name = null;

    /**
     * File size in bytes.
     *
     * @var int size
     */
    protected $size = 0;

    /**
     * File date modified.
     *
     * @var int mtime
     */
    protected $mtime = null;

    /**
     * @param string     $key
     * @param Filesystem $filesystem
     */
    public function __construct($key, Filesystem $filesystem)
    {
        $this->key = $key;
        $this->name = $key;
        $this->filesystem = $filesystem;
    }

    /**
     * Returns the key.
     *
     * @return string
     */
    public function getKey()
    {
        return $this->key;
    }

    /**
     * Returns the content.
     *
     * @throws FileNotFound
     *
     * @param array $metadata optional metadata which should be set when read
     *
     * @return string
     */
    public function getContent($metadata = array())
    {
        if (isset($this->content)) {
            return $this->content;
        }
        $this->setMetadata($metadata);

        return $this->content = $this->filesystem->read($this->key);

    }

    /**
     * @return string name of the file
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @return int size of the file
     */
    public function getSize()
    {
        if ($this->size) {
            return $this->size;
        }

        try {
            return $this->size = $this->filesystem->size($this->getKey());
        } catch (FileNotFound $exception) {

        }

        return 0;
    }

    /**
     * Returns the file modified time.
     *
     * @return int
     */
    public function getMtime()
    {
        return $this->mtime = $this->filesystem->mtime($this->key);
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;
}
    }

    /**
     * @param int $size size of the file
     */
    public function setSize($size)
    {
        $this->size = $size;
    }

    /**
     * Sets the content.
     *
     * @param string $content
     * @param array  $metadata optional metadata which should be send when write
     *
     * @return int The number of bytes that were written into the file, or
     *             FALSE on failure
     */
    public function setContent($content, $metadata = array())
    {
        $this->content = $content;
        $this->setMetadata($metadata);

        return $this->size = $this->filesystem->write($this->key, $this->content, true);
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;
}
    }

    /**
     * @param string $name name of the file
     */
    public function setName($name)
    {
        $this->name = $name;
    }

    /**
     * Indicates whether the file exists in the filesystem.
     *
     * @return bool
     */
    public function exists()
    {
        return $this->filesystem->has($this->key);
    }

    /**
     * Deletes the file from the filesystem.
     *
     * @throws FileNotFound
     * @throws \RuntimeException when cannot delete file
     *
     * @param array $metadata optional metadata which should be send when write
     *
     * @return bool TRUE on success
     */
    public function delete($metadata = array())
    {
        $this->setMetadata($metadata);

        return $this->filesystem->delete($this->key);
    }

    /**
     * Creates a new file stream instance of the file.
     *
     * @return Stream
     */
    public function createStream()
    {
        return $this->filesystem->createStream($this->key);
    }

    /**
     * @param string $newKey
     */
    public function rename($newKey)
    {
        // Should be replaced by a try..finally block
        $this->filesystem->rename($this->key, $newKey);

        $this->key = $newKey;
    }

    /**
     * Sets the metadata array to be stored in adapters that can support it.
     *
     * @param array $metadata
     *
     * @return bool
     */
    protected function setMetadata(array $metadata)
    {
        if ($metadata && $this->supportsMetadata()) {

            $this->filesystem->getAdapter()->setMetadata($this->key, $metadata);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

            return true;
        }

        return false;
    }

    /**
     * @return bool
     */
    private function supportsMetadata()
    {
        return $this->filesystem->getAdapter() instanceof MetadataSupporter;
    }
}


1			<?php
2
3			namespace Gaufrette;
4
5			use Gaufrette\Adapter\MetadataSupporter;
6			use Gaufrette\Exception\FileNotFound;
7
8			/**
9			* Points to a file in a filesystem.
10			*
11			* @author Antoine Hérault <[email protected]>
12			*/
13			class File
14			{
15			protected $key;
16			protected $filesystem;
17
18			/**
19			* Content variable is lazy. It will not be read from filesystem until it's requested first time.
20			*
21			* @var mixed content
22			*/
23			protected $content = null;
24
25			/**
26			* @var array metadata in associative array. Only for adapters that support metadata
27			*/
28			protected $metadata = null;
29
30			/**
31			* Human readable filename (usually the end of the key).
32			*
33			* @var string name
34			*/
35			protected $name = null;
36
37			/**
38			* File size in bytes.
39			*
40			* @var int size
41			*/
42			protected $size = 0;
43
44			/**
45			* File date modified.
46			*
47			* @var int mtime
48			*/
49			protected $mtime = null;
50
51			/**
52			* @param string $key
53			* @param Filesystem $filesystem
54			*/
55			public function __construct($key, Filesystem $filesystem)
56			{
57			$this->key = $key;
58			$this->name = $key;
59			$this->filesystem = $filesystem;
60			}
61
62			/**
63			* Returns the key.
64			*
65			* @return string
66			*/
67			public function getKey()
68			{
69			return $this->key;
70			}
71
72			/**
73			* Returns the content.
74			*
75			* @throws FileNotFound
76			*
77			* @param array $metadata optional metadata which should be set when read
78			*
79			* @return string
80			*/
81			public function getContent($metadata = array())
82			{
83			if (isset($this->content)) {
84			return $this->content;
85			}
86			$this->setMetadata($metadata);
87
88			return $this->content = $this->filesystem->read($this->key);
			0 ignored issues – show Bug Compatibility introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report The expression `$this->content = $this->...stem->read($this->key);` of type `string\|boolean` adds the type `boolean` to the return on line 88 which is incompatible with the return type documented by `Gaufrette\File::getContent` of type `string`. Loading history...
89			}
90
91			/**
92			* @return string name of the file
93			*/
94			public function getName()
95			{
96			return $this->name;
97			}
98
99			/**
100			* @return int size of the file
101			*/
102			public function getSize()
103			{
104			if ($this->size) {
105			return $this->size;
106			}
107
108			try {
109			return $this->size = $this->filesystem->size($this->getKey());
110			} catch (FileNotFound $exception) {
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report Consider adding a comment why this CATCH block is empty. Loading history...
111			}
112
113			return 0;
114			}
115
116			/**
117			* Returns the file modified time.
118			*
119			* @return int
120			*/
121			public function getMtime()
122			{
123			return $this->mtime = $this->filesystem->mtime($this->key);
			0 ignored issues – show Documentation Bug introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report It seems like `$this->filesystem->mtime($this->key)` can also be of type `boolean`. However, the property `$mtime` is declared as type `integer`. 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...
124			}
125
126			/**
127			* @param int $size size of the file
128			*/
129			public function setSize($size)
130			{
131			$this->size = $size;
132			}
133
134			/**
135			* Sets the content.
136			*
137			* @param string $content
138			* @param array $metadata optional metadata which should be send when write
139			*
140			* @return int The number of bytes that were written into the file, or
141			* FALSE on failure
142			*/
143			public function setContent($content, $metadata = array())
144			{
145			$this->content = $content;
146			$this->setMetadata($metadata);
147
148			return $this->size = $this->filesystem->write($this->key, $this->content, true);
			0 ignored issues – show Documentation Bug introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report It seems like `$this->filesystem->write..., $this->content, true)` can also be of type `boolean`. However, the property `$size` is declared as type `integer`. 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...
149			}
150
151			/**
152			* @param string $name name of the file
153			*/
154			public function setName($name)
155			{
156			$this->name = $name;
157			}
158
159			/**
160			* Indicates whether the file exists in the filesystem.
161			*
162			* @return bool
163			*/
164			public function exists()
165			{
166			return $this->filesystem->has($this->key);
167			}
168
169			/**
170			* Deletes the file from the filesystem.
171			*
172			* @throws FileNotFound
173			* @throws \RuntimeException when cannot delete file
174			*
175			* @param array $metadata optional metadata which should be send when write
176			*
177			* @return bool TRUE on success
178			*/
179			public function delete($metadata = array())
180			{
181			$this->setMetadata($metadata);
182
183			return $this->filesystem->delete($this->key);
184			}
185
186			/**
187			* Creates a new file stream instance of the file.
188			*
189			* @return Stream
190			*/
191			public function createStream()
192			{
193			return $this->filesystem->createStream($this->key);
194			}
195
196			/**
197			* @param string $newKey
198			*/
199			public function rename($newKey)
200			{
201			// Should be replaced by a try..finally block
202			$this->filesystem->rename($this->key, $newKey);
203
204			$this->key = $newKey;
205			}
206
207			/**
208			* Sets the metadata array to be stored in adapters that can support it.
209			*
210			* @param array $metadata
211			*
212			* @return bool
213			*/
214			protected function setMetadata(array $metadata)
215			{
216			if ($metadata && $this->supportsMetadata()) {
			0 ignored issues – show Bug Best Practice introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report The expression `$metadata` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
217			$this->filesystem->getAdapter()->setMetadata($this->key, $metadata);
			0 ignored issues – show Bug introduced 2016-03-05 14:38 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Gaufrette\Adapter` as the method `setMetadata()` does only exist in the following implementations of said interface: `Gaufrette\Adapter\AclAwareAmazonS3`, `Gaufrette\Adapter\AmazonS3`, `Gaufrette\Adapter\AwsS3`, `Gaufrette\Adapter\AzureBlobStorage`, `Gaufrette\Adapter\Cache`, `Gaufrette\Adapter\GoogleCloudStorage`, `Gaufrette\Adapter\GridFS`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
218
219			return true;
220			}
221
222			return false;
223			}
224
225			/**
226			* @return bool
227			*/
228			private function supportsMetadata()
229			{
230			return $this->filesystem->getAdapter() instanceof MetadataSupporter;
231			}
232			}
233

KnpLabs / Gaufrette

Pull Request — master (#468)

File::supportsMetadata() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like