ModuleModel::findByNamespace() - Code Metrics - Inspection of "Fix some issues with caching during install" - anomalylabs/streams-platform - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 460b97...b63ecb )

by Ryan

created 2016-12-20 21:27 UTC

ModuleModel::findByNamespace() A

↳ Parent: ModuleModel

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	4
Ratio	100 %

Importance

Changes

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

<?php namespace Anomaly\Streams\Platform\Addon\Module;

use Anomaly\Streams\Platform\Addon\Module\Contract\ModuleInterface;
use Anomaly\Streams\Platform\Model\EloquentCollection;
use Anomaly\Streams\Platform\Model\EloquentModel;
use Anomaly\Streams\Platform\Model\EloquentObserver;

/**
 * Class ModuleModel
 *
 * @link   http://pyrocms.com/
 * @author PyroCMS, Inc. <[email protected]>
 * @author Ryan Thompson <[email protected]>
 */
class ModuleModel extends EloquentModel implements ModuleInterface

{

    /**
     * Define the table name.
     *
     * @var string
     */
    protected $table = 'addons_modules';

    /**
     * Disable timestamps for modules.
     *
     * @var bool
     */
    public $timestamps = false;

    /**
     * Boot the model
     */
    protected static function boot()
    {
        self::observe(app(EloquentObserver::class));

        parent::boot();
    }

    /**
     * Find a module by it's namespace or return a new
     * module with the given namespace.
     *
     * @param  $namespace
     * @return ModuleModel
     */
    public function findByNamespaceOrNew($namespace)
    {
        $module = $this->findByNamespace($namespace);

        if ($module instanceof ModuleModel) {
            return $module;
        }

        $module = $this->newInstance();

        $module->namespace = $namespace;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $module->save();

        return $module;
    }

    /**
     * Find a module by it's namespace.
     *
     * @param  $namespace
     * @return null|ModuleModel
     */
    public function findByNamespace($namespace)
    {
        return $this->where('namespace', $namespace)->first();
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Get all enabled module namespaces.
     *
     * @return EloquentCollection
     */
    public function getEnabledNamespaces()
    {
        return $this->where('installed', true)->where('enabled', true)->get()->pluck('namespace');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Get all installed module namespaces.
     *
     * @return EloquentCollection
     */
    public function getInstalledNamespaces()
    {
        return $this->where('installed', true)->get()->pluck('namespace');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    /**
     * Return a new collection.
     *
     * @param  array $items
     * @return EloquentCollection
     */
    public function newCollection(array $items = [])
    {
        return new EloquentCollection($items);
    }
}


1		<?php namespace Anomaly\Streams\Platform\Addon\Module;
2
3		use Anomaly\Streams\Platform\Addon\Module\Contract\ModuleInterface;
4		use Anomaly\Streams\Platform\Model\EloquentCollection;
5		use Anomaly\Streams\Platform\Model\EloquentModel;
6		use Anomaly\Streams\Platform\Model\EloquentObserver;
7
8		/**
9		* Class ModuleModel
10		*
11		* @link http://pyrocms.com/
12		* @author PyroCMS, Inc. <[email protected]>
13		* @author Ryan Thompson <[email protected]>
14		*/
15	View Code Duplication	class ModuleModel extends EloquentModel implements ModuleInterface
		0 ignored issues – show Duplication introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report This class seems to be duplicated in 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...
16		{
17
18		/**
19		* Define the table name.
20		*
21		* @var string
22		*/
23		protected $table = 'addons_modules';
24
25		/**
26		* Disable timestamps for modules.
27		*
28		* @var bool
29		*/
30		public $timestamps = false;
31
32		/**
33		* Boot the model
34		*/
35		protected static function boot()
36		{
37		self::observe(app(EloquentObserver::class));
38
39		parent::boot();
40		}
41
42		/**
43		* Find a module by it's namespace or return a new
44		* module with the given namespace.
45		*
46		* @param $namespace
47		* @return ModuleModel
48		*/
49		public function findByNamespaceOrNew($namespace)
50		{
51		$module = $this->findByNamespace($namespace);
52
53		if ($module instanceof ModuleModel) {
54		return $module;
55		}
56
57		$module = $this->newInstance();
58
59		$module->namespace = $namespace;
		0 ignored issues – show Documentation introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The property `namespace` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
60
61		$module->save();
62
63		return $module;
64		}
65
66		/**
67		* Find a module by it's namespace.
68		*
69		* @param $namespace
70		* @return null\|ModuleModel
71		*/
72		public function findByNamespace($namespace)
73		{
74		return $this->where('namespace', $namespace)->first();
		0 ignored issues – show Documentation Bug introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The method `where` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
75		}
76
77		/**
78		* Get all enabled module namespaces.
79		*
80		* @return EloquentCollection
81		*/
82		public function getEnabledNamespaces()
83		{
84		return $this->where('installed', true)->where('enabled', true)->get()->pluck('namespace');
		0 ignored issues – show Documentation Bug introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The method `where` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
85		}
86
87		/**
88		* Get all installed module namespaces.
89		*
90		* @return EloquentCollection
91		*/
92		public function getInstalledNamespaces()
93		{
94		return $this->where('installed', true)->get()->pluck('namespace');
		0 ignored issues – show Documentation Bug introduced 2016-04-22 19:08 UTC by Report Bug Copy Issue Report The method `where` does not exist on `object<Anomaly\Streams\P...don\Module\ModuleModel>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
95		}
96
97		/**
98		* Return a new collection.
99		*
100		* @param array $items
101		* @return EloquentCollection
102		*/
103		public function newCollection(array $items = [])
104		{
105		return new EloquentCollection($items);
106		}
107		}
108

anomalylabs / streams-platform

Push — master ( 460b97...b63ecb )

ModuleModel::findByNamespace() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like