CrudTrait - Code Metrics - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

CrudTrait A
last analyzed 2016-08-19 12:52 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

81.93%

Importance

Changes	14
Bugs	7	Features	1

Metric	Value
wmc	19
c	14
b	7
f	1
lcom	1
cbo	5
dl	0
loc	216
ccs	68
cts	83
cp	0.8193
rs	10

18 Methods

Rating	Name	Size	Complexity
	getLoggedUser()	1	?
	save()	1	?
	queueAssign()	1	?
	queueUpdate()	1	?
	queueAdd()	1	?
	activities()	1	?
	comments()	1	?
	fill()	1	?
	touch()	1	?
	tags()	1	?
	isQuoteLocked()	1	?
	syncTags()	1	?
A	changeUpdatedBy()	7	1
A	reassign()	19	2
C	updateIssue()	40	7
B	createIssue()	41	4
A	changeProject()	18	3
B	delete()	27	2

<?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\Issue;

use Illuminate\Database\Eloquent;
use Illuminate\Support\Collection;
use Tinyissue\Model;
use Tinyissue\Model\Activity;
use Tinyissue\Model\Project;
use Tinyissue\Model\Project\Issue\Attachment;
use Tinyissue\Model\User;

/**
 * CrudTrait is trait class containing the methods for adding/editing/deleting the Project\Issue model.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @property static $this
 */
trait CrudTrait
{
    /**
     * Set the issue is updated by a user.
     *
     * @param int $userId
     *
     * @return Eloquent\Model
     */
    public function changeUpdatedBy($userId)
    {
        $this->updated_by = $userId;
class MyClass { }

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

        return $this->save();
    }

    /**
     * Reassign the issue to a new user.
     *
     * @param int|User $assignTo
     * @param User     $user
     *
     * @return Eloquent\Model
     */
    public function reassign($assignTo, User $user)
    {
        $assignToId        = !$assignTo instanceof User ? $assignTo : $assignTo->id;
        $this->assigned_to = $assignToId;
class MyClass { }

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

        // Add event on successful save
        static::saved(function (Project\Issue $issue) use ($user) {
            $this->queueAssign($issue, $user);
        });

        $this->save();

        return $this->activities()->save(new User\Activity([
            'type_id'   => Activity::TYPE_REASSIGN_ISSUE,
            'parent_id' => $this->project->id,
class MyClass { }

$x = new MyClass();
$x->foo = true;
            'user_id'   => $user->id,
            'action_id' => $this->assigned_to,
        ]));
    }

    /**
     * Update the given issue.
     *
     * @param array $input
     *
     * @return Eloquent\Model
     */
    public function updateIssue(array $input)
    {
        $fill = array_only($input, [
            'title', 'body', 'assigned_to',
        ]);
        $fill['updated_by'] = $this->updatedBy->id;
class MyClass { }

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

        if (isset($input['time_quote']['lock'])) {
            $fill['lock_quote'] = $input['time_quote']['lock'];
        }

        // Only save quote if not locked or locked & user allowed to modify it
        if (array_key_exists('time_quote', $input) &&
            (!$this->isQuoteLocked() || $this->user->permission(Model\Permission::PERM_ISSUE_LOCK_QUOTE))
class MyClass { }

$x = new MyClass();
$x->foo = true;
        ) {
            $fill['time_quote'] = $input['time_quote'];
        }

        /* Add to activity log for assignment if changed */
        $assignToId = (int) array_get($input, 'assigned_to');
        if ($assignToId > 0 && $assignToId !== (int) $this->assigned_to) {
            $this->activities()->save(new User\Activity([
                'type_id'   => Activity::TYPE_REASSIGN_ISSUE,
                'parent_id' => $this->project->id,
                'user_id'   => $this->updatedBy->id,
                'action_id' => $this->assigned_to,
            ]));
        }

        $this->fill($fill);

        $this->syncTags($input, $this->tags()->with('parent')->get());

        // Add event on successful save
        static::saved(function (Project\Issue $issue) {
            $this->queueUpdate($issue, $issue->updatedBy);
        });

        return $this->save();
    }

    /**
     * Create a new issue.
     *
     * @param array $input
     *
     * @return static
     */
    public function createIssue(array $input)
    {
        $fill = [
            'created_by' => $this->user->id,
            'project_id' => $this->project->id,
            'title'      => $input['title'],
            'body'       => $input['body'],
        ];

        if ($this->user->permission('issue-modify')) {
            $fill['assigned_to'] = $input['assigned_to'];
            $fill['time_quote']  = $input['time_quote'];
        }

        $this->fill($fill)->save();

        // Add issue to messages queue
        $this->queueAdd($this, $this->user);

        /* Add to user's activity log */
        $this->activities()->save(new User\Activity([
            'type_id'   => Activity::TYPE_CREATE_ISSUE,
            'parent_id' => $this->project->id,
            'user_id'   => $this->user->id,
        ]));

        /* Add attachments to issue */
        Attachment::where('upload_token', '=', $input['upload_token'])
            ->where('uploaded_by', '=', $this->user->id)
            ->update(['issue_id' => $this->id]);
class MyClass { }

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

        // Add default tag to newly created issue
        $defaultTag = app('tinyissue.settings')->getFirstStatusTagId();
        if ($defaultTag > 0 && empty($input['tag_status'])) {
            $input['tag_status'] = $defaultTag;
        }

        $this->syncTags($input);

        return $this;
    }

    /**
     * Move the issue (comments & activities) to another project.
     *
     * @param int $projectId
     *
     * @return $this
     */
    public function changeProject($projectId)
    {
        $this->project_id = $projectId;

        $this->save();
        $comments = $this->comments()->get();
        foreach ($comments as $comment) {
            $comment->project_id = $projectId;
            $comment->save();
        }

        $activities = $this->activities()->get();
        foreach ($activities as $activity) {
            $activity->parent_id = $projectId;
            $activity->save();
        }

        return $this;
    }

    /**
     * Delete an issue.
     *
     * @return bool
     *
     * @throws \Exception
     */
    public function delete()
    {
        $id          = $this->id;
        $projectId   = $this->project_id;

        $comments    = $this->comments;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        $attachments = $this->attachments;
class MyClass { }

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

        $status = parent::delete();

        if ($status) {
            $attachments->each(function (Attachment $attachment) use ($projectId) {
                $path = config('filesystems.disks.local.root')
                    . '/' . config('tinyissue.uploads_dir')
                    . '/' . $projectId
                    . '/' . $attachment->upload_token;
                $attachment->deleteFile($path, $attachment->filename);
                $attachment->delete();
            });
            $comments->each(function (Project\Issue\Comment $comment) {
                $comment->deleteComment($this->getLoggedUser()->user());
            });
            User\Activity::where('parent_id', '=', $projectId)->where('item_id', '=', $id)->delete();
            \DB::table('projects_issues_tags')->where('issue_id', '=', $id)->delete();
        }

        return $status;
    }

    abstract public function touch();
    abstract public function getLoggedUser();
    abstract public function save(array $options = []);
    abstract public function queueAssign(Project\Issue $issue, User $changeBy);
    abstract public function queueUpdate(Project\Issue $issue, User $changeBy);
    abstract public function queueAdd(Project\Issue $issue, User $changeBy);
    abstract public function activities();
    abstract public function comments();
    abstract public function tags();
    abstract public function isQuoteLocked();
    abstract public function fill(array $attributes);
    abstract public function syncTags(array $input, Collection $currentTags = null);
}


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\Issue;
13
14		use Illuminate\Database\Eloquent;
15		use Illuminate\Support\Collection;
16		use Tinyissue\Model;
17		use Tinyissue\Model\Activity;
18		use Tinyissue\Model\Project;
19		use Tinyissue\Model\Project\Issue\Attachment;
20		use Tinyissue\Model\User;
21
22		/**
23		* CrudTrait is trait class containing the methods for adding/editing/deleting the Project\Issue model.
24		*
25		* @author Mohamed Alsharaf <[email protected]>
26		*
27		* @property static $this
28		*/
29		trait CrudTrait
30		{
31		/**
32		* Set the issue is updated by a user.
33		*
34		* @param int $userId
35		*
36		* @return Eloquent\Model
37		*/
38	10	public function changeUpdatedBy($userId)
39		{
40	10	$this->updated_by = $userId;
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `updated_by` 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...
41	10	$this->touch();
42
43	10	return $this->save();
44		}
45
46		/**
47		* Reassign the issue to a new user.
48		*
49		* @param int\|User $assignTo
50		* @param User $user
51		*
52		* @return Eloquent\Model
53		*/
54	3	public function reassign($assignTo, User $user)
55		{
56	3	$assignToId = !$assignTo instanceof User ? $assignTo : $assignTo->id;
57	3	$this->assigned_to = $assignToId;
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `assigned_to` 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...
58
59		// Add event on successful save
60		static::saved(function (Project\Issue $issue) use ($user) {
61	3	$this->queueAssign($issue, $user);
62	3	});
63
64	3	$this->save();
65
66	3	return $this->activities()->save(new User\Activity([
67	3	'type_id' => Activity::TYPE_REASSIGN_ISSUE,
68	3	'parent_id' => $this->project->id,
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `project` 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...
69	3	'user_id' => $user->id,
70	3	'action_id' => $this->assigned_to,
71		]));
72		}
73
74		/**
75		* Update the given issue.
76		*
77		* @param array $input
78		*
79		* @return Eloquent\Model
80		*/
81	6	public function updateIssue(array $input)
82		{
83	6	$fill = array_only($input, [
84	6	'title', 'body', 'assigned_to',
85		]);
86	6	$fill['updated_by'] = $this->updatedBy->id;
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `updatedBy` 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...
87
88	6	if (isset($input['time_quote']['lock'])) {
89		$fill['lock_quote'] = $input['time_quote']['lock'];
90		}
91
92		// Only save quote if not locked or locked & user allowed to modify it
93	6	if (array_key_exists('time_quote', $input) &&
94	6	(!$this->isQuoteLocked() \|\| $this->user->permission(Model\Permission::PERM_ISSUE_LOCK_QUOTE))
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `user` 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...
95		) {
96	6	$fill['time_quote'] = $input['time_quote'];
97		}
98
99		/* Add to activity log for assignment if changed */
100	6	$assignToId = (int) array_get($input, 'assigned_to');
101	6	if ($assignToId > 0 && $assignToId !== (int) $this->assigned_to) {
102	1	$this->activities()->save(new User\Activity([
103	1	'type_id' => Activity::TYPE_REASSIGN_ISSUE,
104	1	'parent_id' => $this->project->id,
105	1	'user_id' => $this->updatedBy->id,
106	1	'action_id' => $this->assigned_to,
107		]));
108		}
109
110	6	$this->fill($fill);
111
112	6	$this->syncTags($input, $this->tags()->with('parent')->get());
113
114		// Add event on successful save
115		static::saved(function (Project\Issue $issue) {
116	6	$this->queueUpdate($issue, $issue->updatedBy);
117	6	});
118
119	6	return $this->save();
120		}
121
122		/**
123		* Create a new issue.
124		*
125		* @param array $input
126		*
127		* @return static
128		*/
129	37	public function createIssue(array $input)
130		{
131		$fill = [
132	37	'created_by' => $this->user->id,
133	37	'project_id' => $this->project->id,
134	37	'title' => $input['title'],
135	37	'body' => $input['body'],
136		];
137
138	37	if ($this->user->permission('issue-modify')) {
139	36	$fill['assigned_to'] = $input['assigned_to'];
140	36	$fill['time_quote'] = $input['time_quote'];
141		}
142
143	37	$this->fill($fill)->save();
144
145		// Add issue to messages queue
146	37	$this->queueAdd($this, $this->user);
147
148		/* Add to user's activity log */
149	37	$this->activities()->save(new User\Activity([
150	37	'type_id' => Activity::TYPE_CREATE_ISSUE,
151	37	'parent_id' => $this->project->id,
152	37	'user_id' => $this->user->id,
153		]));
154
155		/* Add attachments to issue */
156	37	Attachment::where('upload_token', '=', $input['upload_token'])
157	37	->where('uploaded_by', '=', $this->user->id)
158	37	->update(['issue_id' => $this->id]);
		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...
159
160		// Add default tag to newly created issue
161	37	$defaultTag = app('tinyissue.settings')->getFirstStatusTagId();
162	37	if ($defaultTag > 0 && empty($input['tag_status'])) {
163		$input['tag_status'] = $defaultTag;
164		}
165
166	37	$this->syncTags($input);
167
168	37	return $this;
169		}
170
171		/**
172		* Move the issue (comments & activities) to another project.
173		*
174		* @param int $projectId
175		*
176		* @return $this
177		*/
178	1	public function changeProject($projectId)
179		{
180	1	$this->project_id = $projectId;
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `project_id` does not seem to exist. Did you mean `project`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
181	1	$this->save();
182	1	$comments = $this->comments()->get();
183	1	foreach ($comments as $comment) {
184	1	$comment->project_id = $projectId;
185	1	$comment->save();
186		}
187
188	1	$activities = $this->activities()->get();
189	1	foreach ($activities as $activity) {
190	1	$activity->parent_id = $projectId;
191	1	$activity->save();
192		}
193
194	1	return $this;
195		}
196
197		/**
198		* Delete an issue.
199		*
200		* @return bool
201		*
202		* @throws \Exception
203		*/
204		public function delete()
205		{
206		$id = $this->id;
207		$projectId = $this->project_id;
		0 ignored issues – show Bug introduced 2016-08-11 00:01 UTC by Report Bug Copy Issue Report The property `project_id` does not seem to exist. Did you mean `project`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
208		$comments = $this->comments;
		0 ignored issues – show Bug introduced 2016-06-25 13:20 UTC by Report Bug Copy Issue Report The property `comments` 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...
209		$attachments = $this->attachments;
		0 ignored issues – show Bug introduced 2016-06-25 13:20 UTC by Report Bug Copy Issue Report The property `attachments` 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...
210
211		$status = parent::delete();
212
213		if ($status) {
214		$attachments->each(function (Attachment $attachment) use ($projectId) {
215		$path = config('filesystems.disks.local.root')
216		. '/' . config('tinyissue.uploads_dir')
217		. '/' . $projectId
218		. '/' . $attachment->upload_token;
219		$attachment->deleteFile($path, $attachment->filename);
220		$attachment->delete();
221		});
222		$comments->each(function (Project\Issue\Comment $comment) {
223		$comment->deleteComment($this->getLoggedUser()->user());
224		});
225		User\Activity::where('parent_id', '=', $projectId)->where('item_id', '=', $id)->delete();
226		\DB::table('projects_issues_tags')->where('issue_id', '=', $id)->delete();
227		}
228
229		return $status;
230		}
231
232		abstract public function touch();
233		abstract public function getLoggedUser();
234		abstract public function save(array $options = []);
235		abstract public function queueAssign(Project\Issue $issue, User $changeBy);
236		abstract public function queueUpdate(Project\Issue $issue, User $changeBy);
237		abstract public function queueAdd(Project\Issue $issue, User $changeBy);
238		abstract public function activities();
239		abstract public function comments();
240		abstract public function tags();
241		abstract public function isQuoteLocked();
242		abstract public function fill(array $attributes);
243		abstract public function syncTags(array $input, Collection $currentTags = null);
244		}
245

satrun77 / tinyissue

CrudTrait A last analyzed 2016-08-19 12:52 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

Duplication Side-by-Side

Filter issues like

CrudTrait A
last analyzed 2016-08-19 12:52 UTC