GridFS::storeBytes() - Code Metrics - Inspection of "database in collection privatye" - sokil/php-mongo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f6151a...357aa0 )

by De

created 2016-09-13 20:19 UTC

GridFS::storeBytes() A

↳ Parent: GridFS

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	2

<?php

/**
 * This file is part of the PHPMongo package.
 *
 * (c) Dmytro Sokil <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sokil\Mongo;

/**
 * Representation of GridFS as collection of files
 *
 * @property \MongoGridFS $collection MongoGridFS Instance
 */
class GridFS extends Collection
{
    protected $mongoCollectionClassName = '\MongoGridFS';
    
    /**
     * Factory method to get document object from array of stored document 
     * @param \MongoGridFSFile $data
     * @return \Sokil\Mongo\GridFsFile
     */
    public function hydrate($data, $useDocumentPool = true)
    {
        if(($data instanceof \MongoGridFSFile) === false) {
            throw new Exception('Must be \MongoGridFSFile');
        }
        
        $className = $this->getFileClassName($data);
        
        return new $className($this, $data);
    }
    
    /**
     * Override to define class name of file by file data
     * 
     * @param \MongoGridFSFile $fileData
     * @return string Document class data
     */
    public function getFileClassName(\MongoGridFSFile $fileData = null)

    {
        return '\Sokil\Mongo\GridFSFile';
    }
    
    /**
     * Create file in GridFS from file in filesystem
     * 
     * @param string $filename name of source file
     * @param array $metadata metadata stored with file
     * @return \MongoId Id of stored file
     */
    public function storeFile($filename, $metadata = array())
    {
        return $this->getMongoCollection()->storeFile($filename, $metadata);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
    }
    
    /**
     * Create file in GridFS from binary data
     * 
     * @param string $bytes binary data to store in GridFS
     * @param array $metadata metadata stored with file
     * @return \MongoId Id of stored file
     */
    public function storeBytes($bytes, $metadata = array())
    {
        return $this->getMongoCollection()->storeBytes($bytes, $metadata);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
    }

    /**
     * Get file instance by id of document
     * Used \MongoGridFS::findOne() instead of \MongoGridFS::get() due to backward compatibility with old mongo extensions
     *
     * @param \MongoId|string|int $id
     * @return \Sokil\Mongo\GridFSFile|null
     */
    public function getFileById($id)
    {
        if($id instanceof \MongoId) {
            $file = $this->getMongoCollection()->findOne(array('_id' => $id));
        } else {
            try {
                $file = $this->getMongoCollection()->findOne(array('_id' => new \MongoId($id)));
            } catch (\MongoException $e) {
                $file = $this->getMongoCollection()->findOne(array('_id' => $id));
            }
        }
        
        if(!$file) {

            return null;
        }
        
        $fileClassName = $this->getFileClassName($file);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return new $fileClassName($this, $file);
    }
    
    /**
     * Delete file by id
     * 
     * @param string|\MongoId $id id of file's document
     * @return \Sokil\Mongo\GridFS
     * @throws Exception
     */
    public function deleteFileById($id)
    {
        if($id instanceof \MongoId) {
            $result = $this->getMongoCollection()->delete($id);

        } else {
            try {
                $result = $this->getMongoCollection()->delete(new \MongoId($id));

            } catch (\MongoException $e) {
                $result = $this->getMongoCollection()->delete($id);

            }
        }
        if($result['ok'] !== (double) 1) {

            throw new Exception('Error deleting file: ' . $result['err'] . ': ' . $result['errmsg']);
        }
        
        return $this;
    }
}


1		<?php
2
3		/**
4		* This file is part of the PHPMongo package.
5		*
6		* (c) Dmytro Sokil <[email protected]>
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 Sokil\Mongo;
13
14		/**
15		* Representation of GridFS as collection of files
16		*
17		* @property \MongoGridFS $collection MongoGridFS Instance
18		*/
19		class GridFS extends Collection
20		{
21		protected $mongoCollectionClassName = '\MongoGridFS';
22
23		/**
24		* Factory method to get document object from array of stored document
25		* @param \MongoGridFSFile $data
26		* @return \Sokil\Mongo\GridFsFile
27		*/
28		public function hydrate($data, $useDocumentPool = true)
29		{
30		if(($data instanceof \MongoGridFSFile) === false) {
31		throw new Exception('Must be \MongoGridFSFile');
32		}
33
34		$className = $this->getFileClassName($data);
35
36		return new $className($this, $data);
37		}
38
39		/**
40		* Override to define class name of file by file data
41		*
42		* @param \MongoGridFSFile $fileData
43		* @return string Document class data
44		*/
45		public function getFileClassName(\MongoGridFSFile $fileData = null)
		0 ignored issues – show Unused Code introduced 2015-12-03 20:44 UTC by Report Bug Copy Issue Report The parameter `$fileData` 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...
46		{
47		return '\Sokil\Mongo\GridFSFile';
48		}
49
50		/**
51		* Create file in GridFS from file in filesystem
52		*
53		* @param string $filename name of source file
54		* @param array $metadata metadata stored with file
55		* @return \MongoId Id of stored file
56		*/
57		public function storeFile($filename, $metadata = array())
58		{
59		return $this->getMongoCollection()->storeFile($filename, $metadata);
		0 ignored issues – show Bug introduced 2016-09-13 20:22 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `MongoCollection` as the method `storeFile()` does only exist in the following sub-classes of `MongoCollection`: `MongoGridFS`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
60		}
61
62		/**
63		* Create file in GridFS from binary data
64		*
65		* @param string $bytes binary data to store in GridFS
66		* @param array $metadata metadata stored with file
67		* @return \MongoId Id of stored file
68		*/
69		public function storeBytes($bytes, $metadata = array())
70		{
71		return $this->getMongoCollection()->storeBytes($bytes, $metadata);
		0 ignored issues – show Bug introduced 2016-09-13 20:22 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `MongoCollection` as the method `storeBytes()` does only exist in the following sub-classes of `MongoCollection`: `MongoGridFS`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
72		}
73
74		/**
75		* Get file instance by id of document
76		* Used \MongoGridFS::findOne() instead of \MongoGridFS::get() due to backward compatibility with old mongo extensions
77		*
78		* @param \MongoId\|string\|int $id
79		* @return \Sokil\Mongo\GridFSFile\|null
80		*/
81		public function getFileById($id)
82		{
83		if($id instanceof \MongoId) {
84		$file = $this->getMongoCollection()->findOne(array('_id' => $id));
85		} else {
86		try {
87		$file = $this->getMongoCollection()->findOne(array('_id' => new \MongoId($id)));
88		} catch (\MongoException $e) {
89		$file = $this->getMongoCollection()->findOne(array('_id' => $id));
90		}
91		}
92
93		if(!$file) {
		0 ignored issues – show Bug Best Practice introduced 2016-09-13 20:22 UTC by Report Bug Copy Issue Report The expression `$file` 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...
94		return null;
95		}
96
97		$fileClassName = $this->getFileClassName($file);
		0 ignored issues – show Documentation introduced 2016-09-13 20:22 UTC by Report Bug Copy Issue Report `$file` is of type `array`, but the function expects a `null\|object<MongoGridFSFile>`. 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...
98		return new $fileClassName($this, $file);
99		}
100
101		/**
102		* Delete file by id
103		*
104		* @param string\|\MongoId $id id of file's document
105		* @return \Sokil\Mongo\GridFS
106		* @throws Exception
107		*/
108		public function deleteFileById($id)
109		{
110		if($id instanceof \MongoId) {
111		$result = $this->getMongoCollection()->delete($id);
		0 ignored issues – show Bug introduced 2016-09-13 20:22 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `MongoCollection`. Did you maybe mean `deleteIndex()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
112		} else {
113		try {
114		$result = $this->getMongoCollection()->delete(new \MongoId($id));
		0 ignored issues – show Bug introduced 2016-09-13 20:22 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `MongoCollection`. Did you maybe mean `deleteIndex()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
115		} catch (\MongoException $e) {
116		$result = $this->getMongoCollection()->delete($id);
		0 ignored issues – show Bug introduced 2016-09-13 20:22 UTC by Report Bug Copy Issue Report The method `delete()` does not exist on `MongoCollection`. Did you maybe mean `deleteIndex()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
117		}
118		}
119	View Code Duplication	if($result['ok'] !== (double) 1) {
		0 ignored issues – show Duplication introduced 2015-12-03 20:44 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
120		throw new Exception('Error deleting file: ' . $result['err'] . ': ' . $result['errmsg']);
121		}
122
123		return $this;
124		}
125		}
126

sokil / php-mongo

GitHub Access Token became invalid

Push — master ( f6151a...357aa0 )

GridFS::storeBytes() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like