CrudTrait::assignUser() - Code Metrics - Inspection of "Misc: increment version & update changes doc" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (7a36f1)

by Mohamed

created 2016-08-19 12:48 UTC

CrudTrait::assignUser() A

↳ Parent: CrudTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2.0185

Importance

Changes	1
Bugs	1	Features	0

Metric	Value
c	1
b	1
f	0
dl	0
loc	11
ccs	5
cts	6
cp	0.8333
rs	9.4285
cc	2
eloc	6
nc	2
nop	2
crap	2.0185

<?php

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

namespace Tinyissue\Model\Traits\Project;

use Tinyissue\Model\Project;
use Tinyissue\Model\User;
use Illuminate\Support\Collection;
use Tinyissue\Model\Tag;

/**
 * CrudTrait is trait class containing the methods for adding/editing/deleting the Project model.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @property static $this
 */
trait CrudTrait
{
    /**
     * removes a user from a project.
     *
     * @param int $userId
     *
     * @return mixed
     */
    public function unassignUser($userId)
    {
        return $this->projectUsers()->where('user_id', '=', $userId)->delete();
    }

    /**
     * Create a new project.
     *
     * @param array $input
     *
     * @return $this
     */
    public function createProject(array $input = [])
    {
        $this->fill($input)->save();

        if (!empty($input['columns'])) {
            $this->saveTags($input['columns']);

            unset($input['columns']);
        }

        /* Assign selected users to the project */
        if (isset($input['user']) && count($input['user']) > 0) {
            foreach ($input['user'] as $id) {
                $this->assignUser($id);
            }
        }

        return $this;
    }

    /**
     * Update project details.
     *
     * @param array $attributes
     *
     * @return bool
     */
    public function update(array $attributes = [])
    {
        if (array_key_exists('columns', $attributes)) {
            $this->saveTags($attributes['columns']);

            unset($attributes['columns']);
        }

        return parent::update($attributes);
    }

    /**
     * Save the project tags.
     *
     * @param array $tagIds
     *
     * @return bool
     */
    public function saveTags(array $tagIds)
    {
        // Transform the user input tags into tag objects
        // Filter out invalid tags entered by the user
        $tags = new Collection($tagIds);
        $tags = $tags->transform(function ($tagNameOrId) {
            return Tag::find($tagNameOrId);
        })->filter(function ($tag) {
            return $tag instanceof Tag;
        });

        // Delete all existing
        $this->kanbanTags()->detach();

        // Save tags
        $kanbanTags = $this->kanbanTags();
        foreach ($tags as $position => $tag) {
            $kanbanTags->attach([$tag->id => ['position' => $position]]);
        }

        return true;
    }

    /**
     * Assign a user to a project.
     *
     * @param int $userId
     * @param int $roleId
     *
     * @return Project\User
     */
    public function assignUser($userId, $roleId = 0)
    {
        if ($userId <= 0) {
            return false;
        }

        return $this->projectUsers()->save(new Project\User([
            'user_id' => $userId,
            'role_id' => $roleId,
        ]));
    }

    /**
     *  Delete a project.
     *
     * @return void
     *
     * @throws \Exception
     */
    public function delete()
    {
        // Remove issues
        $issues = $this->issues()->get();
        foreach ($issues as $issue) {
            $issue->delete();
        }

        // Remove project notes
        $notes = $this->notes()->get();
        foreach ($notes as $note) {
            $note->delete();
        }

        // Remove project users
        Project\User::where('project_id', '=', $this->id)->delete();
class MyClass { }

$x = new MyClass();
$x->foo = true;

        // Remove user activities
        User\Activity::where('parent_id', '=', $this->id)->delete();

        // Remove kanban tags
        \DB::table('projects_kanban_tags')->where('project_id', '=', $this->id)->delete();

        // Remove the project
        $dir = config('filesystems.disks.local.root') . '/' . config('tinyissue.uploads_dir') . '/' . $this->id;
        if (is_dir($dir)) {
            rmdir($dir);
        }

        return parent::delete();
    }

    abstract public function fill(array $attributes);
    abstract public function projectUsers();
    abstract public function kanbanTags();
    abstract public function issues();
    abstract public function notes();
}


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 Tinyissue\Model\Project;
15		use Tinyissue\Model\User;
16		use Illuminate\Support\Collection;
17		use Tinyissue\Model\Tag;
18
19		/**
20		* CrudTrait is trait class containing the methods for adding/editing/deleting the Project model.
21		*
22		* @author Mohamed Alsharaf <[email protected]>
23		*
24		* @property static $this
25		*/
26		trait CrudTrait
27		{
28		/**
29		* removes a user from a project.
30		*
31		* @param int $userId
32		*
33		* @return mixed
34		*/
35	1	public function unassignUser($userId)
36		{
37	1	return $this->projectUsers()->where('user_id', '=', $userId)->delete();
38		}
39
40		/**
41		* Create a new project.
42		*
43		* @param array $input
44		*
45		* @return $this
46		*/
47	54	public function createProject(array $input = [])
48		{
49	54	$this->fill($input)->save();
50
51	54	if (!empty($input['columns'])) {
52		$this->saveTags($input['columns']);
53
54		unset($input['columns']);
55		}
56
57		/* Assign selected users to the project */
58	54	if (isset($input['user']) && count($input['user']) > 0) {
59	35	foreach ($input['user'] as $id) {
60	35	$this->assignUser($id);
61		}
62		}
63
64	54	return $this;
65		}
66
67		/**
68		* Update project details.
69		*
70		* @param array $attributes
71		*
72		* @return bool
73		*/
74	2	public function update(array $attributes = [])
75		{
76	2	if (array_key_exists('columns', $attributes)) {
77	1	$this->saveTags($attributes['columns']);
78
79	1	unset($attributes['columns']);
80		}
81
82	2	return parent::update($attributes);
83		}
84
85		/**
86		* Save the project tags.
87		*
88		* @param array $tagIds
89		*
90		* @return bool
91		*/
92	1	public function saveTags(array $tagIds)
93		{
94		// Transform the user input tags into tag objects
95		// Filter out invalid tags entered by the user
96	1	$tags = new Collection($tagIds);
97		$tags = $tags->transform(function ($tagNameOrId) {
98	1	return Tag::find($tagNameOrId);
99	1	})->filter(function ($tag) {
100	1	return $tag instanceof Tag;
101	1	});
102
103		// Delete all existing
104	1	$this->kanbanTags()->detach();
105
106		// Save tags
107	1	$kanbanTags = $this->kanbanTags();
108	1	foreach ($tags as $position => $tag) {
109	1	$kanbanTags->attach([$tag->id => ['position' => $position]]);
110		}
111
112	1	return true;
113		}
114
115		/**
116		* Assign a user to a project.
117		*
118		* @param int $userId
119		* @param int $roleId
120		*
121		* @return Project\User
122		*/
123	36	public function assignUser($userId, $roleId = 0)
124		{
125	36	if ($userId <= 0) {
126		return false;
127		}
128
129	36	return $this->projectUsers()->save(new Project\User([
130	36	'user_id' => $userId,
131	36	'role_id' => $roleId,
132		]));
133		}
134
135		/**
136		* Delete a project.
137		*
138		* @return void
139		*
140		* @throws \Exception
141		*/
142	1	public function delete()
143		{
144		// Remove issues
145	1	$issues = $this->issues()->get();
146	1	foreach ($issues as $issue) {
147		$issue->delete();
148		}
149
150		// Remove project notes
151	1	$notes = $this->notes()->get();
152	1	foreach ($notes as $note) {
153		$note->delete();
154		}
155
156		// Remove project users
157	1	Project\User::where('project_id', '=', $this->id)->delete();
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `id` 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...
158
159		// Remove user activities
160	1	User\Activity::where('parent_id', '=', $this->id)->delete();
161
162		// Remove kanban tags
163	1	\DB::table('projects_kanban_tags')->where('project_id', '=', $this->id)->delete();
164
165		// Remove the project
166	1	$dir = config('filesystems.disks.local.root') . '/' . config('tinyissue.uploads_dir') . '/' . $this->id;
167	1	if (is_dir($dir)) {
168		rmdir($dir);
169		}
170
171	1	return parent::delete();
172		}
173
174		abstract public function fill(array $attributes);
175		abstract public function projectUsers();
176		abstract public function kanbanTags();
177		abstract public function issues();
178		abstract public function notes();
179		}
180

satrun77 / tinyissue

Branch — master (7a36f1)

CrudTrait::assignUser() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like