Metable::getMetaItemClassName() - Code Metrics - Inspection of "A few more docs and CS fixes." - boxedcode/laravel-eloquent-meta - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9dd383...b03b84 )

by Oliver

created 2016-01-02 03:32 UTC

Metable::getMetaItemClassName() A

↳ Parent: Metable

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	0

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

<?php

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

namespace BoxedCode\Eloquent\Meta;

use BoxedCode\Eloquent\Meta\Contracts\MetaItem;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

trait Metable
{
    /**
     * Boot the trait.
     *
     * @return void
     */
    public static function bootMetable()
    {
        static::observeSaveAndCascade();

        static::observeDeleteAndCascade();
    }

    /**
     * Get the primary key for the model.
     *
     * @return string
     */
    abstract function getKeyName();


    /**
     * Meta item relationship.
     *
     * @return \BoxedCode\Eloquent\Meta\HasMeta
     */
    public function meta()
    {
        return $this->hasMeta($this->getMetaItemClassName(), 'model');
    }

    /**
     * Determine if the model or given attribute(s) have been modified.
     *
     * @param  array|string|null  $attributes
     * @return bool
     */
    public function isDirty($attributes = null)
    {
        if (parent::isDirty($attributes)) {
            return true;
        }

        else {
            foreach ($this->meta as $item) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
                if ($item->isDirty($attributes)) {
                    return true;
                }
            }
        }

        return false;
    }

    /**
     * Get the class name of meta relationship items.
     *
     * @return string
     */
    public function getMetaItemClassName()
    {
        if (isset($this->metaItemClassname)) {
            $class = $this->metaItemClassname;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        } else {
            $class = MetaItem::class;
        }

        return $class;
    }

    /**
     * Get an instance of the meta relationship item class.
     *
     * @param array $attr
     * @return MetaItem
     */
    public function getMetaItemInstance($attr = [])
    {
        $class = $this->getMetaItemClassName();

        return new $class($attr);
    }

    /**
     * Get the polymorphic relationship columns.
     *
     * @param  string  $name
     * @param  string  $type
     * @param  string  $id
     * @return array
     */
    abstract function getMorphs($name, $type, $id);

    /**
     * Define the polymorphic one-to-many relationship with the meta data.
     *
     * @param  string  $related
     * @param  string  $name
     * @param  string  $type
     * @param  string  $id
     * @param  string  $localKey
     * @return \BoxedCode\Eloquent\Meta\HasMeta
     */
    public function hasMeta($related, $name, $type = null, $id = null, $localKey = null)
    {
        $instance = new $related;

        // Here we will gather up the morph type and ID for the relationship so that we
        // can properly query the intermediate table of a relation. Finally, we will
        // get the table and create the relationship instances for the developers.
        list($type, $id) = $this->getMorphs($name, $type, $id);

        $table = $instance->getTable();

        $localKey = $localKey ?: $this->getKeyName();

        return new HasMeta($instance->newQuery(), $this, $table.'.'.$type, $table.'.'.$id, $localKey);
    }

    /**
     * Observes the model and saves dirty meta data on save.
     *
     * @return void
     */
    public static function observeSaveAndCascade()
    {
        $onSave = function($model) {

            /*
             * Remove any keys not present in the collection
             */
            $key = $model->getMetaItemInstance()->getKeyName();

            $to_remove = array_diff($model->meta->originalModelKeys(), $model->meta->modelKeys());

            $model->meta()->whereIn($key, $to_remove)->delete();

            /*
             * Save dirty meta items
             */
            foreach ($model->meta as $meta) {

                if ($meta->isDirty()) {
                    if ($meta->exists) {
                        $meta->save();
                    } else {
                        $model->meta()->save($meta);
                    }
                }

            }

        };

        static::saved($onSave);
    }

    /**
     * Observes the model and deletes meta entries on delete.
     *
     * @return void
     */
    public static function observeDeleteAndCascade()
    {
        $onDelete = function($model) {
            foreach ($model->meta as $meta) {
                $meta->delete();
            }
        };

        static::deleted($onDelete);
    }

}


1			<?php
2
3			/*
4			* This file is part of Mailable.
5			*
6			* (c) Oliver Green <[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 BoxedCode\Eloquent\Meta;
13
14			use BoxedCode\Eloquent\Meta\Contracts\MetaItem;
			0 ignored issues – show Bug introduced 2016-01-02 03:35 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `BoxedCode\Eloquent\Meta\MetaItem`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
15
16			trait Metable
17			{
18			/**
19			* Boot the trait.
20			*
21			* @return void
22			*/
23			public static function bootMetable()
24			{
25			static::observeSaveAndCascade();
26
27			static::observeDeleteAndCascade();
28			}
29
30			/**
31			* Get the primary key for the model.
32			*
33			* @return string
34			*/
35			abstract function getKeyName();
			0 ignored issues – show Best Practice introduced 2016-01-02 03:35 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
36
37			/**
38			* Meta item relationship.
39			*
40			* @return \BoxedCode\Eloquent\Meta\HasMeta
41			*/
42			public function meta()
43			{
44			return $this->hasMeta($this->getMetaItemClassName(), 'model');
45			}
46
47			/**
48			* Determine if the model or given attribute(s) have been modified.
49			*
50			* @param array\|string\|null $attributes
51			* @return bool
52			*/
53			public function isDirty($attributes = null)
54			{
55			if (parent::isDirty($attributes)) {
56			return true;
57			}
58
59			else {
60			foreach ($this->meta as $item) {
			1 ignored issue – show Bug introduced 2016-01-02 02:28 UTC by Report Bug Copy Issue Report The property `meta` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
61			if ($item->isDirty($attributes)) {
62			return true;
63			}
64			}
65			}
66
67			return false;
68			}
69
70			/**
71			* Get the class name of meta relationship items.
72			*
73			* @return string
74			*/
75			public function getMetaItemClassName()
76			{
77			if (isset($this->metaItemClassname)) {
78			$class = $this->metaItemClassname;
			1 ignored issue – show Bug introduced 2016-01-02 03:35 UTC by Report Bug Copy Issue Report The property `metaItemClassname` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
79			} else {
80			$class = MetaItem::class;
81			}
82
83			return $class;
84			}
85
86			/**
87			* Get an instance of the meta relationship item class.
88			*
89			* @param array $attr
90			* @return MetaItem
91			*/
92			public function getMetaItemInstance($attr = [])
93			{
94			$class = $this->getMetaItemClassName();
95
96			return new $class($attr);
97			}
98
99			/**
100			* Get the polymorphic relationship columns.
101			*
102			* @param string $name
103			* @param string $type
104			* @param string $id
105			* @return array
106			*/
107			abstract function getMorphs($name, $type, $id);
108
109			/**
110			* Define the polymorphic one-to-many relationship with the meta data.
111			*
112			* @param string $related
113			* @param string $name
114			* @param string $type
115			* @param string $id
116			* @param string $localKey
117			* @return \BoxedCode\Eloquent\Meta\HasMeta
118			*/
119			public function hasMeta($related, $name, $type = null, $id = null, $localKey = null)
120			{
121			$instance = new $related;
122
123			// Here we will gather up the morph type and ID for the relationship so that we
124			// can properly query the intermediate table of a relation. Finally, we will
125			// get the table and create the relationship instances for the developers.
126			list($type, $id) = $this->getMorphs($name, $type, $id);
127
128			$table = $instance->getTable();
129
130			$localKey = $localKey ?: $this->getKeyName();
131
132			return new HasMeta($instance->newQuery(), $this, $table.'.'.$type, $table.'.'.$id, $localKey);
133			}
134
135			/**
136			* Observes the model and saves dirty meta data on save.
137			*
138			* @return void
139			*/
140			public static function observeSaveAndCascade()
141			{
142			$onSave = function($model) {
143
144			/*
145			* Remove any keys not present in the collection
146			*/
147			$key = $model->getMetaItemInstance()->getKeyName();
148
149			$to_remove = array_diff($model->meta->originalModelKeys(), $model->meta->modelKeys());
150
151			$model->meta()->whereIn($key, $to_remove)->delete();
152
153			/*
154			* Save dirty meta items
155			*/
156			foreach ($model->meta as $meta) {
157
158			if ($meta->isDirty()) {
159			if ($meta->exists) {
160			$meta->save();
161			} else {
162			$model->meta()->save($meta);
163			}
164			}
165
166			}
167
168			};
169
170			static::saved($onSave);
171			}
172
173			/**
174			* Observes the model and deletes meta entries on delete.
175			*
176			* @return void
177			*/
178			public static function observeDeleteAndCascade()
179			{
180			$onDelete = function($model) {
181			foreach ($model->meta as $meta) {
182			$meta->delete();
183			}
184			};
185
186			static::deleted($onDelete);
187			}
188
189			}
190

boxedcode / laravel-eloquent-meta

Push — master ( 9dd383...b03b84 )

Metable::getMetaItemClassName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like