IssueService::removeLabel() - Code Metrics - Dragonqos/php-jira-rest-client - Measure and Improve Code Quality continuously with Scrutinizer

IssueService::removeLabel() A
last analyzed 2018-03-26 10:35 UTC

↳ Parent: IssueService

Complexity

Conditions	2
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	11
Ratio	100 %

Importance

Changes

Metric	Value
dl	11
loc	11
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	6
nc	2
nop	2

<?php

namespace JiraRestApi\Issue;

use JiraRestApi\JiraClient;
use JiraRestApi\JiraClientResponse;
use JiraRestApi\JiraException;
use Symfony\Component\HttpFoundation\Request;

class IssueService extends JiraClient
{
    private $uri = '/issue';
    private $searchUri = '/search';

    /**
     * Get issue
     *
     * @param $issueIdOrKey Issue id or key
     *
     * @return mixed
     */
    public function get($issueIdOrKey)

    {
        $result = $this->exec($this->uri . '/' . $issueIdOrKey);

        return $this->extractErrors($result, [200], function () use ($result) {
            return $this->json_mapper->map(
                $result->getRawData(), new Issue()
            );
        });
    }

    /**
     * Search issues.
     *
     * @param       $jql
     * @param int   $startAt
     * @param int   $maxResults
     * @param array $fields
     *
     * @return mixed
     */
    public function search($jql, $startAt = 0, $maxResults = 15, $fields = [])
    {
        $data = [
            'jql' => $jql,
            'startAt' => $startAt,
            'maxResults' => $maxResults,
            'fields' => $fields,
        ];

        /** @var JiraClientResponse $result */
        $result = $this->exec($this->searchUri, $data, Request::METHOD_POST);

        return $this->extractErrors($result, [200], function () use ($result) {
            return $this->json_mapper->map(
                $result->getRawData(), new IssueSearchResult()
            );
        });
    }

    /**
     * Create new issue.
     *
     * @param IssueField $issueField
     *
     * @return mixed
     */
    public function create(IssueField $issueField)
    {
        $issue = new Issue();
        $issue->fields = $issueField;
        $data = $this->filterNullVariable($issue);

        $result = $this->exec($this->uri, $data, Request::METHOD_POST);

        return $this->extractErrors($result, [201], function () use ($result) {
            return $this->json_mapper->map(
                $result->getRawData(), new Issue()
            );
        });
    }

    /**
     * Update issue.
     *
     * @param            $issueIdOrKey Issue id or key
     * @param IssueField $issueField
     *
     * @return string
     */
    public function update($issueIdOrKey, IssueField $issueField)
    {
        $issue = new Issue();
        $issue->fields = $issueField;

        // ToDO: Do we need to filter null variables?
        $data = $this->filterNullVariable($issue);

        $result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);

        return $this->extractErrors($result, [204], function () use ($result) {
            return $result;
        });
    }

    /**
     * Add one or more file to an issue.
     *
     * @param       $issueIdOrKey  Issue id or key
     * @param array $filePathArray attachment file path.
     *
     * @return array
     */
    public function addAttachments($issueIdOrKey, array $filePathArray)
    {
        $results = $this->upload($this->uri . '/' . $issueIdOrKey .'/attachments', $filePathArray);

        $resArr = [];
        foreach ($results as $result) {
            $extracted = $this->extractErrors($result, [200], function () use ($result) {
                return $this->json_mapper->mapArray(
                    $result->getRawData(), new \ArrayObject(), '\JiraRestApi\Issue\Attachment'
                );
            });

            array_push($resArr, $extracted);
        }

        return $resArr;
    }

    /**
     * @param      $uri
     * @param null $toResource
     *
     * @return mixed
     */
    public function getAttachmentStream($uri, $toResource = null)
    {
        return $this->download($uri, $toResource);
    }

    /**
     * Adds a new comment to an issue.
     *
     * @param         $issueIdOrKey Issue id or key
     * @param Comment $comment
     *
     * @return mixed
     */
    public function addComment($issueIdOrKey, Comment $comment)
    {
        $data = $this->filterNullVariable($comment);
        $result = $this->exec($this->uri . '/' . $issueIdOrKey . '/comment', $data, Request::METHOD_POST);

        return $this->extractErrors($result, [201], function () use ($result) {
            return $this->json_mapper->map(
                $result->getRawData(), new Comment()
            );
        });
    }

    /**
     * Update comment to an issue.
     *
     * @param         $issueIdOrKey Issue id or key
     * @param Comment $comment
     *
     * @return mixed
     * @throws JiraException
     */
    public function updateComment($issueIdOrKey, Comment $comment)
    {
        $data = $this->filterNullVariable($comment);

        if (!isset($data['id'])) {
            throw new JiraException('CommentId not found in Comment object.');
        }

        $commentId = $data['id'];
        unset($data['id']);

        $result = $this->exec($this->uri . '/' . $issueIdOrKey . '/comment/' . $commentId, $data, Request::METHOD_PUT);

        return $this->extractErrors($result, [200], function () use ($result) {
            return $this->json_mapper->map(
                $result->getRawData(), new Comment()
            );
        });
    }

    /**
     * Get a list of the transitions possible for this
     * issue by the current user, along with fields that
     * are required and their types.
     *
     * @param $issueIdOrKey
     *
     * @return mixed|string
     */
    public function getTransition($issueIdOrKey)
    {
        $result = $this->exec($this->uri . '/' . $issueIdOrKey . '/transitions');

        return $this->extractErrors($result, [200], function () use ($result) {
            $data = $result->getRawData();
            return $this->json_mapper->mapArray(
                $data['transitions'], new \ArrayObject(), '\JiraRestApi\Issue\Transition'
            );
        });
    }

    /**
     * Find transition id by transition's to field name(aka 'Resolved').
     *
     * @param $issueIdOrKey
     * @param $transitionToName
     *
     * @return mixed
     * @throws JiraException
     */
    public function findTransitionId($issueIdOrKey, $transitionToName)
    {
        $ret = $this->getTransition($issueIdOrKey);

        foreach ($ret as $trans) {
            $toName = $trans->to->name;

            if (strcmp($toName, $transitionToName) == 0) {
                return $trans->id;
            }
        }

        // transition keyword not found
        throw new JiraException('Transition name \'' . $transitionToName . '\' not found on JIRA Server.');
    }

    /**
     * Perform a transition on an issue.
     *
     * @param            $issueIdOrKey Issue id or key
     * @param Transition $transition
     *
     * @return mixed - if transition was successful return http 204(no contents)
     * @throws JiraException
     */
    public function doTransition($issueIdOrKey, Transition $transition)
    {
        if (!isset($transition->transition['id'])) {
            $transition->transition['id'] = $this->findTransitionId($issueIdOrKey, $transition->transition['name']);
        }

        $data = $this->filterNullVariable($transition);

        $result = $this->exec($this->uri . '/' . $issueIdOrKey . '/transitions', $data, Request::METHOD_POST);

        return $this->extractErrors($result, [204], function () use ($result) {
            return $result;
        });
    }

    /**
     * Get TimeTracking info.
     *
     * @param $issueIdOrKey
     *
     * @return bool|TimeTracking
     */
    public function getTimeTracking($issueIdOrKey)
    {
        $result = $this->get($issueIdOrKey);

        if ($result instanceof Issue) {
            return $result->fields->timeTracking;
        }

        return false;
    }

    /**
     * TimeTracking issues.
     *
     * @param $issueIdOrKey
     * @param $timeTracking
     *
     * @return string
     */
    public function setTimeTracking($issueIdOrKey, TimeTracking $timeTracking)
    {
        $data['update']['timetracking']['edit'] = $timeTracking;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
        $data = $this->filterNullVariable($data);

        $result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);

        return $this->extractErrors($result, [204], function () use ($result) {
            return $result;
        });
    }

    /**
     * Get getWorklog.
     *
     * @param mixed $issueIdOrKey
     *
     * @return Worklog Return Worklog object
     */
    public function getWorklog($issueIdOrKey)

    {
        $result = $this->exec($this->uri . '/' . $issueIdOrKey . '/worklog');

        return $this->extractErrors($result, [200], function () use ($result) {
            return $this->json_mapper->map(
                $result->getRawData(), new Worklog()
            );
        });
    }

    /**
     * @param $issueIdOrKey
     * @param $label
     *
     * @return mixed
     */
    public function setLabel($issueIdOrKey, $label)

    {
        $labels = is_array($label) ? $label : [$label];

        $data['update']['labels'][]['set'] = $labels;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        $result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);
        return $this->extractErrors($result, [204], function () use ($result) {
            return $result;
        });
    }

    /**
     * @param $issueIdOrKey
     * @param $label
     *
     * @return mixed
     */
    public function removeLabel($issueIdOrKey, $label)

    {
        $labels = is_array($label) ? $label : [$label];

        $data['update']['labels'][]['remove'] = $labels;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        $result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);
        return $this->extractErrors($result, [204], function () use ($result) {
            return $result;
        });
    }
}


1		<?php
2
3		namespace JiraRestApi\Issue;
4
5		use JiraRestApi\JiraClient;
6		use JiraRestApi\JiraClientResponse;
7		use JiraRestApi\JiraException;
8		use Symfony\Component\HttpFoundation\Request;
9
10		class IssueService extends JiraClient
11		{
12		private $uri = '/issue';
13		private $searchUri = '/search';
14
15		/**
16		* Get issue
17		*
18		* @param $issueIdOrKey Issue id or key
19		*
20		* @return mixed
21		*/
22	View Code Duplication	public function get($issueIdOrKey)
		0 ignored issues – show Duplication introduced 2018-03-26 10:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
23		{
24		$result = $this->exec($this->uri . '/' . $issueIdOrKey);
25
26		return $this->extractErrors($result, [200], function () use ($result) {
27		return $this->json_mapper->map(
28		$result->getRawData(), new Issue()
29		);
30		});
31		}
32
33		/**
34		* Search issues.
35		*
36		* @param $jql
37		* @param int $startAt
38		* @param int $maxResults
39		* @param array $fields
40		*
41		* @return mixed
42		*/
43		public function search($jql, $startAt = 0, $maxResults = 15, $fields = [])
44		{
45		$data = [
46		'jql' => $jql,
47		'startAt' => $startAt,
48		'maxResults' => $maxResults,
49		'fields' => $fields,
50		];
51
52		/** @var JiraClientResponse $result */
53		$result = $this->exec($this->searchUri, $data, Request::METHOD_POST);
54
55		return $this->extractErrors($result, [200], function () use ($result) {
56		return $this->json_mapper->map(
57		$result->getRawData(), new IssueSearchResult()
58		);
59		});
60		}
61
62		/**
63		* Create new issue.
64		*
65		* @param IssueField $issueField
66		*
67		* @return mixed
68		*/
69		public function create(IssueField $issueField)
70		{
71		$issue = new Issue();
72		$issue->fields = $issueField;
73		$data = $this->filterNullVariable($issue);
74
75		$result = $this->exec($this->uri, $data, Request::METHOD_POST);
76
77		return $this->extractErrors($result, [201], function () use ($result) {
78		return $this->json_mapper->map(
79		$result->getRawData(), new Issue()
80		);
81		});
82		}
83
84		/**
85		* Update issue.
86		*
87		* @param $issueIdOrKey Issue id or key
88		* @param IssueField $issueField
89		*
90		* @return string
91		*/
92		public function update($issueIdOrKey, IssueField $issueField)
93		{
94		$issue = new Issue();
95		$issue->fields = $issueField;
96
97		// ToDO: Do we need to filter null variables?
98		$data = $this->filterNullVariable($issue);
99
100		$result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);
101
102		return $this->extractErrors($result, [204], function () use ($result) {
103		return $result;
104		});
105		}
106
107		/**
108		* Add one or more file to an issue.
109		*
110		* @param $issueIdOrKey Issue id or key
111		* @param array $filePathArray attachment file path.
112		*
113		* @return array
114		*/
115		public function addAttachments($issueIdOrKey, array $filePathArray)
116		{
117		$results = $this->upload($this->uri . '/' . $issueIdOrKey .'/attachments', $filePathArray);
118
119		$resArr = [];
120		foreach ($results as $result) {
121		$extracted = $this->extractErrors($result, [200], function () use ($result) {
122		return $this->json_mapper->mapArray(
123		$result->getRawData(), new \ArrayObject(), '\JiraRestApi\Issue\Attachment'
124		);
125		});
126
127		array_push($resArr, $extracted);
128		}
129
130		return $resArr;
131		}
132
133		/**
134		* @param $uri
135		* @param null $toResource
136		*
137		* @return mixed
138		*/
139		public function getAttachmentStream($uri, $toResource = null)
140		{
141		return $this->download($uri, $toResource);
142		}
143
144		/**
145		* Adds a new comment to an issue.
146		*
147		* @param $issueIdOrKey Issue id or key
148		* @param Comment $comment
149		*
150		* @return mixed
151		*/
152		public function addComment($issueIdOrKey, Comment $comment)
153		{
154		$data = $this->filterNullVariable($comment);
155		$result = $this->exec($this->uri . '/' . $issueIdOrKey . '/comment', $data, Request::METHOD_POST);
156
157		return $this->extractErrors($result, [201], function () use ($result) {
158		return $this->json_mapper->map(
159		$result->getRawData(), new Comment()
160		);
161		});
162		}
163
164		/**
165		* Update comment to an issue.
166		*
167		* @param $issueIdOrKey Issue id or key
168		* @param Comment $comment
169		*
170		* @return mixed
171		* @throws JiraException
172		*/
173		public function updateComment($issueIdOrKey, Comment $comment)
174		{
175		$data = $this->filterNullVariable($comment);
176
177		if (!isset($data['id'])) {
178		throw new JiraException('CommentId not found in Comment object.');
179		}
180
181		$commentId = $data['id'];
182		unset($data['id']);
183
184		$result = $this->exec($this->uri . '/' . $issueIdOrKey . '/comment/' . $commentId, $data, Request::METHOD_PUT);
185
186		return $this->extractErrors($result, [200], function () use ($result) {
187		return $this->json_mapper->map(
188		$result->getRawData(), new Comment()
189		);
190		});
191		}
192
193		/**
194		* Get a list of the transitions possible for this
195		* issue by the current user, along with fields that
196		* are required and their types.
197		*
198		* @param $issueIdOrKey
199		*
200		* @return mixed\|string
201		*/
202		public function getTransition($issueIdOrKey)
203		{
204		$result = $this->exec($this->uri . '/' . $issueIdOrKey . '/transitions');
205
206		return $this->extractErrors($result, [200], function () use ($result) {
207		$data = $result->getRawData();
208		return $this->json_mapper->mapArray(
209		$data['transitions'], new \ArrayObject(), '\JiraRestApi\Issue\Transition'
210		);
211		});
212		}
213
214		/**
215		* Find transition id by transition's to field name(aka 'Resolved').
216		*
217		* @param $issueIdOrKey
218		* @param $transitionToName
219		*
220		* @return mixed
221		* @throws JiraException
222		*/
223		public function findTransitionId($issueIdOrKey, $transitionToName)
224		{
225		$ret = $this->getTransition($issueIdOrKey);
226
227		foreach ($ret as $trans) {
228		$toName = $trans->to->name;
229
230		if (strcmp($toName, $transitionToName) == 0) {
231		return $trans->id;
232		}
233		}
234
235		// transition keyword not found
236		throw new JiraException('Transition name \'' . $transitionToName . '\' not found on JIRA Server.');
237		}
238
239		/**
240		* Perform a transition on an issue.
241		*
242		* @param $issueIdOrKey Issue id or key
243		* @param Transition $transition
244		*
245		* @return mixed - if transition was successful return http 204(no contents)
246		* @throws JiraException
247		*/
248		public function doTransition($issueIdOrKey, Transition $transition)
249		{
250		if (!isset($transition->transition['id'])) {
251		$transition->transition['id'] = $this->findTransitionId($issueIdOrKey, $transition->transition['name']);
252		}
253
254		$data = $this->filterNullVariable($transition);
255
256		$result = $this->exec($this->uri . '/' . $issueIdOrKey . '/transitions', $data, Request::METHOD_POST);
257
258		return $this->extractErrors($result, [204], function () use ($result) {
259		return $result;
260		});
261		}
262
263		/**
264		* Get TimeTracking info.
265		*
266		* @param $issueIdOrKey
267		*
268		* @return bool\|TimeTracking
269		*/
270		public function getTimeTracking($issueIdOrKey)
271		{
272		$result = $this->get($issueIdOrKey);
273
274		if ($result instanceof Issue) {
275		return $result->fields->timeTracking;
276		}
277
278		return false;
279		}
280
281		/**
282		* TimeTracking issues.
283		*
284		* @param $issueIdOrKey
285		* @param $timeTracking
286		*
287		* @return string
288		*/
289		public function setTimeTracking($issueIdOrKey, TimeTracking $timeTracking)
290		{
291		$data['update']['timetracking']['edit'] = $timeTracking;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-03 13:03 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
292		$data = $this->filterNullVariable($data);
293
294		$result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);
295
296		return $this->extractErrors($result, [204], function () use ($result) {
297		return $result;
298		});
299		}
300
301		/**
302		* Get getWorklog.
303		*
304		* @param mixed $issueIdOrKey
305		*
306		* @return Worklog Return Worklog object
307		*/
308	View Code Duplication	public function getWorklog($issueIdOrKey)
		0 ignored issues – show Duplication introduced 2018-03-26 10:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
309		{
310		$result = $this->exec($this->uri . '/' . $issueIdOrKey . '/worklog');
311
312		return $this->extractErrors($result, [200], function () use ($result) {
313		return $this->json_mapper->map(
314		$result->getRawData(), new Worklog()
315		);
316		});
317		}
318
319		/**
320		* @param $issueIdOrKey
321		* @param $label
322		*
323		* @return mixed
324		*/
325	View Code Duplication	public function setLabel($issueIdOrKey, $label)
		0 ignored issues – show Duplication introduced 2018-03-26 10:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
326		{
327		$labels = is_array($label) ? $label : [$label];
328
329		$data['update']['labels'][]['set'] = $labels;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-03 13:03 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
330
331		$result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);
332		return $this->extractErrors($result, [204], function () use ($result) {
333		return $result;
334		});
335		}
336
337		/**
338		* @param $issueIdOrKey
339		* @param $label
340		*
341		* @return mixed
342		*/
343	View Code Duplication	public function removeLabel($issueIdOrKey, $label)
		0 ignored issues – show Duplication introduced 2018-03-26 10:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
344		{
345		$labels = is_array($label) ? $label : [$label];
346
347		$data['update']['labels'][]['remove'] = $labels;
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-06-03 13:03 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
348
349		$result = $this->exec($this->uri . '/' . $issueIdOrKey, $data, Request::METHOD_PUT);
350		return $this->extractErrors($result, [204], function () use ($result) {
351		return $result;
352		});
353		}
354		}
355

Dragonqos / php-jira-rest-client

GitHub Access Token became invalid

IssueService::removeLabel() A last analyzed 2018-03-26 10:35 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

IssueService::removeLabel() A
last analyzed 2018-03-26 10:35 UTC