Completed
Push — master ( fa5230...195b94 )
by Mohamed
16:12 queued 06:12
created

CrudTrait::validOrCreate()   B

Complexity

Conditions 6
Paths 8

Size

Total Lines 21
Code Lines 14

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 42

Importance

Changes 4
Bugs 1 Features 1
Metric Value
c 4
b 1
f 1
dl 0
loc 21
ccs 0
cts 0
cp 0
rs 8.7624
cc 6
eloc 14
nc 8
nop 2
crap 42
1
<?php
2
3
/*
4
 * This file is part of the Tinyissue package.
5
 *
6
 * (c) Mohamed Alsharaf <[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 Tinyissue\Model\Traits\Tag;
13
14
use Illuminate\Database\Eloquent;
15
use Tinyissue\Model\Tag;
16
17
/**
18
 * CrudTrait is trait class containing the methods for adding/editing/deleting the Tag model.
19
 *
20
 * @author Mohamed Alsharaf <[email protected]>
21
 *
22
 * @method Eloquent\Model where($column, $operator = null, $value = null, $boolean = 'and')
23
 */
24
trait CrudTrait
25
{
26
    /**
27
     * Create a new tag.
28
     *
29
     * @param array $input
30
     *
31
     * @return mixed
32
     */
33
    public function createTag(array $input)
34 1
    {
35
        return $this->fill($this->prepareTagToSave($input))->save();
0 ignored issues
show
Bug introduced by
It seems like fill() must be provided by classes using this trait. How about adding it as abstract method to this trait?

This check looks for methods that are used by a trait but not required by it.

To illustrate, let’s look at the following code example

trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

The trait Idable provides a method equalsId that in turn relies on the method getId(). If this method does not exist on a class mixing in this trait, the method will fail.

Adding the getId() as an abstract method to the trait will make sure it is available.

Loading history...
36 1
    }
37 1
38
    /**
39
     * Update the tags in the database.
40
     *
41
     * @param array $attributes
42
     *
43
     * @return bool|int
44
     */
45
    public function update(array $attributes = [])
46
    {
47
        return parent::update($this->prepareTagToSave($attributes));
48
    }
49
50
    /**
51
     * Create new tag from string of group name and tag name.
52
     *
53
     * @param string $tagFullName
54
     *
55
     * @return $this|bool
56
     */
57
    public function createTagFromString($tagFullName)
58
    {
59
        list($groupName, $tagName) = explode(':', $tagFullName);
60
61
        // Check if group name is valid
62
        $groupTag = $this->validOrCreate($groupName);
63
64
        if (!$groupTag) {
65
            return false;
66
        }
67
68
        // Create new tag or return existing one
69
        return $this->validOrCreate($tagName, $groupTag);
0 ignored issues
show
Documentation introduced by
$groupTag is of type boolean|object<Tinyissue...l\Traits\Tag\CrudTrait>, but the function expects a null|object<Tinyissue\Model\Tag>.

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...
70
    }
71
72
    /**
73
     * Create a new tag if valid or return existing one.
74
     *
75
     * @param string   $name
76
     * @param null|Tag $parent
77
     *
78
     * @return bool|$this
79
     */
80
    public function validOrCreate($name, Tag $parent = null)
81
    {
82
        $group = $parent === null ? true : false;
83
        $tag   = $this->where('name', '=', $name)->first();
84
        if ($tag && $tag->group != $group) {
85
            return false;
86
        }
87
88
        if (!$tag) {
89
            $tag        = new Tag();
90
            $tag->name  = $name;
91
            $tag->group = $group;
92
            if (!is_null($parent)) {
93
                $tag->parent_id = $parent->id;
94
                $tag->setRelation('parent', $parent);
95
            }
96
            $tag->save();
97
        }
98
99
        return $tag;
100
    }
101
102
    /**
103
     * Prepare tag details to save.
104
     *
105
     * @param array $input
106
     *
107
     * @return array
108
     */
109
    protected function prepareTagToSave(array $input)
110
    {
111
        $input['group'] = 0;
112
113
        return $input;
114
    }
115
}
116