IssueScopes::scopeNumber() - Code Metrics - Inspection of "Misc: in progress" - satrun77/tinyissue - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop-3.0 ( bd5ff0...545efb )

by Mohamed

created 2016-11-20 08:25 UTC

IssueScopes::scopeNumber() A

↳ Parent: IssueScopes

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	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\Project;

use Illuminate\Database\Eloquent;
use Illuminate\Database\Eloquent\Builder;
use Tinyissue\Model;

/**
 * IssueScopes is trait class containing the model scope methods.
 *
 * @author Mohamed Alsharaf <[email protected]>
 *
 * @property static $this
 */
trait IssueScopes
{
    /**
     * Filter status by open status.
     *
     * @param Builder $query
     *
     * @return Builder
     */
    public function scopeOpen(Builder $query)
    {
        return $this->scopeStatus($query, Issue::STATUS_OPEN);
    }

    /**
     * Filter status by closed status.
     *
     * @param Builder $query
     *
     * @return Builder
     */
    public function scopeClosed(Builder $query)
    {
        return $this->scopeStatus($query, Issue::STATUS_CLOSED);
    }

    /**
     * Filter status by a status.
     *
     * @param Builder $query
     * @param int     $status
     *
     * @return Builder
     */
    public function scopeStatus(Builder $query, $status = Issue::STATUS_OPEN)
    {
        return $query->where('status', '=', $status);
    }

    /**
     * Filter issue by created by or assigned to field based on user role.
     *
     * @param Builder   $query
     * @param Model\User|null $user
     *
     * @return Builder
     */
    public function scopeAssignedOrCreated(Builder $query, Model\User $user = null)
    {
        if ($user instanceof Model\User && $user->isUser()) {
            return $this->scopeCreatedBy($query, $user);
        }

        return $this->scopeAssignedTo($query, $user);
    }

    /**
     * Filter issue by assigned to.
     *
     * @param Builder         $query
     * @param null|Model\User $user
     *
     * @return Builder
     */
    public function scopeAssignedTo(Builder $query, $user = null)
    {
        return $this->whereIdEqual($query, 'assigned_to', $user);
    }

    /**
     * Filter issue by created by.
     *
     * @param Builder   $query
     * @param Model\User|null $user
     *
     * @return Builder
     */
    public function scopeCreatedBy(Builder $query, Model\User $user = null)
    {
        return $this->whereIdEqual($query, 'created_by', $user);
    }

    /**
     * Filter issue by created by if user logged in as User role adn current project is private internal.
     *
     * @param Builder       $query
     * @param Model\Project $project
     * @param Model\User|null     $user
     *
     * @return Builder
     */
    public function scopeLimitByCreatedForInternalProject(Builder $query, Model\Project $project, Model\User $user = null)
    {
        if ($user && $user->isUser() && $project->isPrivateInternal()) {
            $query = $this->scopeCreatedBy($query, $user);
        }

        return $query;
    }

    /**
     * Filter issue by project id.
     *
     * @param Builder $query
     * @param int     $projectId
     *
     * @return Builder
     */
    public function scopeForProject(Builder $query, $projectId)
    {
        return $this->whereIdEqual($query, 'project_id', $projectId);
    }

    /**
     * Filter issue by internal issue number.
     *
     * @param Builder $query
     * @param int     $number
     *
     * @return Builder
     */
    public function scopeNumber(Builder $query, $number)
    {
        return $this->whereIdEqual($query, 'issue_no', $number);
    }

    /**
     * Helper method to filter by a field and a value.
     *
     * @param Builder            $query
     * @param string             $field
     * @param int|Eloquent\Model|null $idOrObject
     *
     * @return $this|Builder
     */
    protected function whereIdEqual(Builder $query, $field, $idOrObject)
    {
        $id = $idOrObject instanceof Eloquent\Model ? $idOrObject->id : $idOrObject;
        if ($id > 0) {
            return $query->where($field, '=', $id);
        }

        return $query;
    }

    /**
     * Filter with like %% on issue string fields title/body.
     *
     * @param Builder $query
     * @param string  $keyword
     *
     * @return Builder
     */
    public function scopeSearchContent(Builder $query, $keyword)
    {
        if (!empty($keyword)) {
            return $query->where(function (Builder $query) use ($keyword) {
                $query->where('title', 'like', '%' . $keyword . '%');
                $query->orWhere('body', 'like', '%' . $keyword . '%');
            });
        }

        return $query;
    }

    /**
     * Filter issues by an array of tag ids.
     *
     * @param Builder $query
     * @param array   ...$tags
     *
     * @return Builder
     */
    public function scopeWhereTags(Builder $query, ...$tags)
    {
        $tags = array_filter($tags);

        if (!empty($tags)) {
            $query->whereHas('tags', function (Builder $query) use ($tags) {
                $query->whereIn('id', $tags);
            });
        }

        return $query;
    }
}


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\Project;
13
14			use Illuminate\Database\Eloquent;
15			use Illuminate\Database\Eloquent\Builder;
16			use Tinyissue\Model;
17
18			/**
19			* IssueScopes is trait class containing the model scope methods.
20			*
21			* @author Mohamed Alsharaf <[email protected]>
22			*
23			* @property static $this
24			*/
25			trait IssueScopes
26			{
27			/**
28			* Filter status by open status.
29			*
30			* @param Builder $query
31			*
32			* @return Builder
33			*/
34			public function scopeOpen(Builder $query)
35			{
36			return $this->scopeStatus($query, Issue::STATUS_OPEN);
37			}
38
39			/**
40			* Filter status by closed status.
41			*
42			* @param Builder $query
43			*
44			* @return Builder
45			*/
46			public function scopeClosed(Builder $query)
47			{
48			return $this->scopeStatus($query, Issue::STATUS_CLOSED);
49			}
50
51			/**
52			* Filter status by a status.
53			*
54			* @param Builder $query
55			* @param int $status
56			*
57			* @return Builder
58			*/
59			public function scopeStatus(Builder $query, $status = Issue::STATUS_OPEN)
60			{
61			return $query->where('status', '=', $status);
62			}
63
64			/**
65			* Filter issue by created by or assigned to field based on user role.
66			*
67			* @param Builder $query
68			* @param Model\User\|null $user
69			*
70			* @return Builder
71			*/
72			public function scopeAssignedOrCreated(Builder $query, Model\User $user = null)
73			{
74			if ($user instanceof Model\User && $user->isUser()) {
75			return $this->scopeCreatedBy($query, $user);
76			}
77
78			return $this->scopeAssignedTo($query, $user);
79			}
80
81			/**
82			* Filter issue by assigned to.
83			*
84			* @param Builder $query
85			* @param null\|Model\User $user
86			*
87			* @return Builder
88			*/
89			public function scopeAssignedTo(Builder $query, $user = null)
90			{
91			return $this->whereIdEqual($query, 'assigned_to', $user);
92			}
93
94			/**
95			* Filter issue by created by.
96			*
97			* @param Builder $query
98			* @param Model\User\|null $user
99			*
100			* @return Builder
101			*/
102			public function scopeCreatedBy(Builder $query, Model\User $user = null)
103			{
104			return $this->whereIdEqual($query, 'created_by', $user);
105			}
106
107			/**
108			* Filter issue by created by if user logged in as User role adn current project is private internal.
109			*
110			* @param Builder $query
111			* @param Model\Project $project
112			* @param Model\User\|null $user
113			*
114			* @return Builder
115			*/
116			public function scopeLimitByCreatedForInternalProject(Builder $query, Model\Project $project, Model\User $user = null)
117			{
118			if ($user && $user->isUser() && $project->isPrivateInternal()) {
119			$query = $this->scopeCreatedBy($query, $user);
120			}
121
122			return $query;
123			}
124
125			/**
126			* Filter issue by project id.
127			*
128			* @param Builder $query
129			* @param int $projectId
130			*
131			* @return Builder
132			*/
133			public function scopeForProject(Builder $query, $projectId)
134			{
135			return $this->whereIdEqual($query, 'project_id', $projectId);
136			}
137
138			/**
139			* Filter issue by internal issue number.
140			*
141			* @param Builder $query
142			* @param int $number
143			*
144			* @return Builder
145			*/
146			public function scopeNumber(Builder $query, $number)
147			{
148			return $this->whereIdEqual($query, 'issue_no', $number);
149			}
150
151			/**
152			* Helper method to filter by a field and a value.
153			*
154			* @param Builder $query
155			* @param string $field
156			* @param int\|Eloquent\Model\|null $idOrObject
157			*
158			* @return $this\|Builder
159			*/
160			protected function whereIdEqual(Builder $query, $field, $idOrObject)
161			{
162			$id = $idOrObject instanceof Eloquent\Model ? $idOrObject->id : $idOrObject;
163			if ($id > 0) {
164			return $query->where($field, '=', $id);
165			}
166
167			return $query;
168			}
169
170			/**
171			* Filter with like %% on issue string fields title/body.
172			*
173			* @param Builder $query
174			* @param string $keyword
175			*
176			* @return Builder
177			*/
178			public function scopeSearchContent(Builder $query, $keyword)
179			{
180			if (!empty($keyword)) {
181			return $query->where(function (Builder $query) use ($keyword) {
182			$query->where('title', 'like', '%' . $keyword . '%');
183			$query->orWhere('body', 'like', '%' . $keyword . '%');
184			});
185			}
186
187			return $query;
188			}
189
190			/**
191			* Filter issues by an array of tag ids.
192			*
193			* @param Builder $query
194			* @param array ...$tags
195			*
196			* @return Builder
197			*/
198			public function scopeWhereTags(Builder $query, ...$tags)
199			{
200			$tags = array_filter($tags);
201
202			if (!empty($tags)) {
203			$query->whereHas('tags', function (Builder $query) use ($tags) {
204			$query->whereIn('id', $tags);
205			});
206			}
207
208			return $query;
209			}
210			}
211

satrun77 / tinyissue

Push — develop-3.0 ( bd5ff0...545efb )

IssueScopes::scopeNumber() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like