Completed
Push — master ( 195b94...858be2 )
by Mohamed
07:34
created

CrudTrait::delete()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 11
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 1

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 11
ccs 8
cts 8
cp 1
rs 9.4285
cc 1
eloc 7
nc 1
nop 0
crap 1
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\Project;
13
14
use Illuminate\Database\Query;
15
use Tinyissue\Model\Project;
16
use Tinyissue\Model\User;
17
use Illuminate\Support\Collection;
18
use Tinyissue\Model\Tag;
19
20
/**
21
 * CrudTrait is trait class containing the methods for adding/editing/deleting the Project model.
22
 *
23
 * @author Mohamed Alsharaf <[email protected]>
24
 *
25
 * @property int $id
26
 *
27
 * @method   Query\Builder where($column, $operator = null, $value = null, $boolean = 'and')
28
 * @method   Query\Builder join($table, $one, $operator = null, $two = null, $type = 'inner', $where = false)
29
 * @method   Project       fill(array $attributes)
30
 * @method   RelationTrait projectUsers()
31
 */
32
trait CrudTrait
33
{
34
    /**
35
     * removes a user from a project.
36
     *
37
     * @param int $userId
38
     *
39
     * @return mixed
40
     */
41 1
    public function unassignUser($userId)
42
    {
43 1
        return $this->projectUsers()->where('user_id', '=', $userId)->delete();
0 ignored issues
show
Bug introduced by
It seems like where() 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...
44
    }
45
46
    /**
47
     * Create a new project.
48
     *
49
     * @param array $input
50
     *
51
     * @return $this
52
     */
53 42
    public function createProject(array $input = [])
54
    {
55 42
        $this->fill($input)->save();
56
57 42
        if (!empty($input['columns'])) {
58
            $this->saveTags($input['columns']);
59
60
            unset($input['columns']);
61
        }
62
63
        /* Assign selected users to the project */
64 42
        if (isset($input['user']) && count($input['user']) > 0) {
65 24
            foreach ($input['user'] as $id) {
66 24
                $this->assignUser($id);
67
            }
68
        }
69
70 42
        return $this;
71
    }
72
73
    /**
74
     * Update project details.
75
     *
76
     * @param array $attributes
77
     *
78
     * @return bool
79
     */
80 1
    public function update(array $attributes = [])
81
    {
82 1
        if (array_key_exists('columns', $attributes)) {
83
            $this->saveTags($attributes['columns']);
84
85
            unset($attributes['columns']);
86
        }
87
88 1
        return parent::update($attributes);
89
    }
90
91
    /**
92
     * Save the project tags.
93
     *
94
     * @param array $tagIds
95
     *
96
     * @return bool
97
     */
98
    public function saveTags(array $tagIds)
99
    {
100
        // Transform the user input tags into tag objects
101
        // Filter out invalid tags entered by the user
102
        $tags = new Collection($tagIds);
103
        $tags = $tags->transform(function ($tagNameOrId) {
104
            return Tag::find($tagNameOrId);
105
        })->filter(function ($tag) {
106
            return $tag instanceof Tag;
107
        });
108
109
        // Delete all existing
110
        $this->kanbanTags()->detach();
0 ignored issues
show
Bug introduced by
It seems like kanbanTags() 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...
111
112
        // Save tags
113
        $kanbanTags = $this->kanbanTags();
0 ignored issues
show
Bug introduced by
It seems like kanbanTags() 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...
114
        foreach ($tags as $position => $tag) {
115
            $kanbanTags->attach([$tag->id => ['position' => $position]]);
116
        }
117
118
        return true;
119
    }
120
121
    /**
122
     * Assign a user to a project.
123
     *
124
     * @param int $userId
125
     * @param int $roleId
126
     *
127
     * @return Project\User
128
     */
129 25
    public function assignUser($userId, $roleId = 0)
130
    {
131 25
        return $this->projectUsers()->save(new Project\User([
0 ignored issues
show
Bug introduced by
It seems like save() 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...
132 25
            'user_id' => $userId,
133 25
            'role_id' => $roleId,
134
        ]));
135
    }
136
137
    /**
138
     *  Delete a project.
139
     *
140
     * @return void
141
     *
142
     * @throws \Exception
143
     */
144 1
    public function delete()
145
    {
146 1
        $id = $this->id;
147 1
        parent::delete();
148
149
        /* Delete all children from the project */
150 1
        Project\Issue::where('project_id', '=', $id)->delete();
151 1
        Project\Issue\Comment::where('project_id', '=', $id)->delete();
152 1
        Project\User::where('project_id', '=', $id)->delete();
153 1
        User\Activity::where('parent_id', '=', $id)->delete();
154 1
    }
155
}
156