HasRivetsTrait::attachAsProperty() - Code Metrics - luminark/rivet - Measure and Improve Code Quality continuously with Scrutinizer

HasRivetsTrait::attachAsProperty() A
last analyzed 2016-03-14 10:52 UTC

↳ Parent: HasRivetsTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	8
rs	9.4285
cc	2
eloc	4
nc	2
nop	2

<?php

namespace Luminark\Rivet\Traits;

use Luminark\Rivet\Models\Rivet;
use Luminark\Rivet\Events\AttachingToModel;
use Luminark\Rivet\Events\AttachedToModel;
use Rutorika\Sortable\MorphToSortedManyTrait;
use InvalidArgumentException;

trait HasRivetsTrait
{
    use MorphToSortedManyTrait;

    protected function getRivetsConfig()
    {
        return $this->rivets ?: ['rivets' => []];
<?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.");
        }
    }

}
    }

    protected function getRivetClass()
    {
        return Rivet::class;
    }

    public function attach($attribute, $rivet, $relationShouldLoad = false)
    {
        list($type, $class) = $this->getRivetConfig($attribute);

        if (is_numeric($rivet)) {
            $rivet = $class::findOrFail($rivet);
        } elseif ( ! $rivet instanceof $class) {
            throw new InvalidArgumentException("Invalid object provided for attaching to $attribute. Expected $class, got " . get_class($rivet) . ".");
        }

        if ($type == 'property') {
            $this->attachAsProperty($attribute, $rivet);
        } elseif ($type == 'collection') {
            $this->attachToCollection($attribute, $rivet);
        } else {
            throw new InvalidArgumentException("Invalid type [$type] provided for attaching to $attribute.");
        }

        if ($relationShouldLoad) {
            $this->load($attribute);
        }
    }

    protected function attachAsProperty($attribute, Rivet $rivet)
    {
        if ($this->$attribute) {
            $this->removeRivet($attribute, $this->$attribute->id);
        }

        return $this->attachToCollection($attribute, $rivet);
    }

    protected function attachToCollection($collection, Rivet $rivet)
    {
        $dispatcher = static::getEventDispatcher();
        $dispatcher->fire(new AttachingToModel($this, $collection, $rivet));

        $rivet->save();
        $this->$collection()->attach($rivet, ['collection' => $collection]);

        $dispatcher->fire(new AttachedToModel($this, $collection, $rivet));

        return $rivet;
    }

    public function removeRivet($attribute, $rivet, $relationShouldLoad = false)
    {
        list(, $class) = $this->getRivetConfig($attribute);

        $result = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        if (is_numeric($rivet)) {
            $result = $this->$attribute()->detach($rivet);
        } elseif ($rivet instanceof $class) {
            $result = $this->$attribute()->detach($rivet->id);
        } else {
            throw new InvalidArgumentException('Only an ID or a Rivet object can be passed to removeRivet method.');
        }

        if ( ! $result) {
            throw new InvalidArgumentException('Unrelated ID or Rivet object passed to removeRivet method.');
        }

        if ($relationShouldLoad) {
            $this->load($attribute);
        }

        return $this;
    }

    public function __call($name, $arguments)
    {
        if (preg_match('/^set(\w+)/', $name, $matches)

            && in_array($property = lcfirst($matches[1]), array_keys($this->getRivetsConfig()))
        ) {
            array_unshift($arguments, $property);
            return call_user_func_array([$this, 'attach'], $arguments);
        }

        if (preg_match('/^add(\w+)/', $name, $matches)

            && in_array($collection = str_plural(lcfirst($matches[1])), array_keys($this->getRivetsConfig()))
        ) {
            array_unshift($arguments, $collection);
            return call_user_func_array([$this, 'attach'], $arguments);
        }

        if (preg_match('/^unset(\w+)/', $name, $matches)

            && in_array($property = lcfirst($matches[1]), array_keys($this->getRivetsConfig()))
        ) {
            array_unshift($arguments, $property);
            return call_user_func_array([$this, 'removeRivet'], $arguments);
        }

        if (preg_match('/^remove(\w+)/', $name, $matches)

            && in_array($collection = str_plural(lcfirst($matches[1])), array_keys($this->getRivetsConfig()))
        ) {
            array_unshift($arguments, $collection);
            return call_user_func_array([$this, 'removeRivet'], $arguments);
        }

        if ( ! in_array($name, array_keys($this->getRivetsConfig()))) {
            return parent::__call($name, $arguments);
        }

        list($type, $class) = $this->getRivetConfig($name);

        if ($type == 'property') {
            return $this->getRivetProperty($class, $name);
        }
        if ($type == 'collection') {
            return $this->getRivetCollection($class, $name);
        }
    }

    public function __get($name)
    {
        $result = parent::__get($name);

        if ( ! in_array($name, array_keys($this->getRivetsConfig()))) {
            return $result;
        }

        if ( ! $result) {
            $this->load($name);
            $result = $this->getAttribute($name);
        }

        list($type) = $this->getRivetConfig($name);
        if ($type == 'property') {
            return $result->first();
        }

        return $result;
    }

    protected function getRivetConfig($name)
    {
        return $this->getRivetsConfig()[$name]
        + ['collection', $this->getRivetClass()];
    }

    protected function getRivetProperty($class, $name)
    {
        return $this->getRivetCollection($class, $name);
    }

    protected function getRivetCollection($class, $name)
    {
        return $this->morphToSortedMany(
            $class,
            $class::getMorphToManyName(),
            'position',
            null,
            null,
            $class::getMorphToSortableManyOtherKey()
        )->wherePivot('collection', snake_case($name));
    }

    abstract public function getAttribute($key);

    abstract public function load($relations);
}


1		<?php
2
3		namespace Luminark\Rivet\Traits;
4
5		use Luminark\Rivet\Models\Rivet;
6		use Luminark\Rivet\Events\AttachingToModel;
7		use Luminark\Rivet\Events\AttachedToModel;
8		use Rutorika\Sortable\MorphToSortedManyTrait;
9		use InvalidArgumentException;
10
11		trait HasRivetsTrait
12		{
13		use MorphToSortedManyTrait;
14
15		protected function getRivetsConfig()
16		{
17		return $this->rivets ?: ['rivets' => []];
		0 ignored issues – show Documentation introduced 2016-03-09 21:01 UTC by Report Bug Copy Issue Report The property `rivets` does not exist on `object<Luminark\Rivet\Traits\HasRivetsTrait>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read 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."); } } } If the property has read access only, you can use the @property-read 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...
18		}
19
20		protected function getRivetClass()
21		{
22		return Rivet::class;
23		}
24
25		public function attach($attribute, $rivet, $relationShouldLoad = false)
26		{
27		list($type, $class) = $this->getRivetConfig($attribute);
28
29		if (is_numeric($rivet)) {
30		$rivet = $class::findOrFail($rivet);
31		} elseif ( ! $rivet instanceof $class) {
32		throw new InvalidArgumentException("Invalid object provided for attaching to $attribute. Expected $class, got " . get_class($rivet) . ".");
33		}
34
35		if ($type == 'property') {
36		$this->attachAsProperty($attribute, $rivet);
37		} elseif ($type == 'collection') {
38		$this->attachToCollection($attribute, $rivet);
39		} else {
40		throw new InvalidArgumentException("Invalid type [$type] provided for attaching to $attribute.");
41		}
42
43		if ($relationShouldLoad) {
44		$this->load($attribute);
45		}
46		}
47
48		protected function attachAsProperty($attribute, Rivet $rivet)
49		{
50		if ($this->$attribute) {
51		$this->removeRivet($attribute, $this->$attribute->id);
52		}
53
54		return $this->attachToCollection($attribute, $rivet);
55		}
56
57		protected function attachToCollection($collection, Rivet $rivet)
58		{
59		$dispatcher = static::getEventDispatcher();
60		$dispatcher->fire(new AttachingToModel($this, $collection, $rivet));
61
62		$rivet->save();
63		$this->$collection()->attach($rivet, ['collection' => $collection]);
64
65		$dispatcher->fire(new AttachedToModel($this, $collection, $rivet));
66
67		return $rivet;
68		}
69
70		public function removeRivet($attribute, $rivet, $relationShouldLoad = false)
71		{
72		list(, $class) = $this->getRivetConfig($attribute);
73
74		$result = null;
		0 ignored issues – show Unused Code introduced 2016-03-09 21:01 UTC by Report Bug Copy Issue Report `$result` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
75		if (is_numeric($rivet)) {
76		$result = $this->$attribute()->detach($rivet);
77		} elseif ($rivet instanceof $class) {
78		$result = $this->$attribute()->detach($rivet->id);
79		} else {
80		throw new InvalidArgumentException('Only an ID or a Rivet object can be passed to removeRivet method.');
81		}
82
83		if ( ! $result) {
84		throw new InvalidArgumentException('Unrelated ID or Rivet object passed to removeRivet method.');
85		}
86
87		if ($relationShouldLoad) {
88		$this->load($attribute);
89		}
90
91		return $this;
92		}
93
94		public function __call($name, $arguments)
95		{
96	View Code Duplication	if (preg_match('/^set(\w+)/', $name, $matches)
		0 ignored issues – show Duplication introduced 2016-03-09 21:01 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...
97		&& in_array($property = lcfirst($matches[1]), array_keys($this->getRivetsConfig()))
98		) {
99		array_unshift($arguments, $property);
100		return call_user_func_array([$this, 'attach'], $arguments);
101		}
102
103	View Code Duplication	if (preg_match('/^add(\w+)/', $name, $matches)
		0 ignored issues – show Duplication introduced 2016-03-09 21:01 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...
104		&& in_array($collection = str_plural(lcfirst($matches[1])), array_keys($this->getRivetsConfig()))
105		) {
106		array_unshift($arguments, $collection);
107		return call_user_func_array([$this, 'attach'], $arguments);
108		}
109
110	View Code Duplication	if (preg_match('/^unset(\w+)/', $name, $matches)
		0 ignored issues – show Duplication introduced 2016-03-09 21:01 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...
111		&& in_array($property = lcfirst($matches[1]), array_keys($this->getRivetsConfig()))
112		) {
113		array_unshift($arguments, $property);
114		return call_user_func_array([$this, 'removeRivet'], $arguments);
115		}
116
117	View Code Duplication	if (preg_match('/^remove(\w+)/', $name, $matches)
		0 ignored issues – show Duplication introduced 2016-03-09 21:01 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...
118		&& in_array($collection = str_plural(lcfirst($matches[1])), array_keys($this->getRivetsConfig()))
119		) {
120		array_unshift($arguments, $collection);
121		return call_user_func_array([$this, 'removeRivet'], $arguments);
122		}
123
124		if ( ! in_array($name, array_keys($this->getRivetsConfig()))) {
125		return parent::__call($name, $arguments);
126		}
127
128		list($type, $class) = $this->getRivetConfig($name);
129
130		if ($type == 'property') {
131		return $this->getRivetProperty($class, $name);
132		}
133		if ($type == 'collection') {
134		return $this->getRivetCollection($class, $name);
135		}
136		}
137
138		public function __get($name)
139		{
140		$result = parent::__get($name);
141
142		if ( ! in_array($name, array_keys($this->getRivetsConfig()))) {
143		return $result;
144		}
145
146		if ( ! $result) {
147		$this->load($name);
148		$result = $this->getAttribute($name);
149		}
150
151		list($type) = $this->getRivetConfig($name);
152		if ($type == 'property') {
153		return $result->first();
154		}
155
156		return $result;
157		}
158
159		protected function getRivetConfig($name)
160		{
161		return $this->getRivetsConfig()[$name]
162		+ ['collection', $this->getRivetClass()];
163		}
164
165		protected function getRivetProperty($class, $name)
166		{
167		return $this->getRivetCollection($class, $name);
168		}
169
170		protected function getRivetCollection($class, $name)
171		{
172		return $this->morphToSortedMany(
173		$class,
174		$class::getMorphToManyName(),
175		'position',
176		null,
177		null,
178		$class::getMorphToSortableManyOtherKey()
179		)->wherePivot('collection', snake_case($name));
180		}
181
182		abstract public function getAttribute($key);
183
184		abstract public function load($relations);
185		}
186

luminark / rivet

HasRivetsTrait::attachAsProperty() A last analyzed 2016-03-14 10:52 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

HasRivetsTrait::attachAsProperty() A
last analyzed 2016-03-14 10:52 UTC