Skip to content

Commit b410403

Browse files
author
Patric Steffen
committed
add availability to define query parameters
1 parent 7bbe146 commit b410403

File tree

2 files changed

+22
-7
lines changed

2 files changed

+22
-7
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -484,9 +484,15 @@ try {
484484
->setDescription("This is a shorthand for a set operation on the summary field")
485485
;
486486

487+
// optionally set some query params
488+
$editParams = array(
489+
'notifyUsers' => false
490+
);
491+
487492
$issueService = new IssueService();
488493

489-
$ret = $issueService->update($issueKey, $issueField);
494+
// You can set the $paramArray param to disable notifications in example
495+
$ret = $issueService->update($issueKey, $issueField, $editParams);
490496

491497
var_dump($ret);
492498
} catch (JiraException $e) {
@@ -514,7 +520,7 @@ try {
514520
// A null assignee will remove the assignee.
515521
$assignee = 'newAssigneeName';
516522

517-
$ret = $issueService->changeAssignee($this->key, $assignee);
523+
$ret = $issueService->changeAssignee($issueKey, $assignee);
518524

519525
var_dump($ret);
520526
} catch (JiraException $e) {
@@ -536,7 +542,9 @@ $issueKey = "TEST-879";
536542
try {
537543
$issueService = new IssueService();
538544

539-
$ret = $issueService->deleteIssue($this->key);
545+
$ret = $issueService->deleteIssue($issueKey);
546+
// if you want to delete issues with sub-tasks
547+
//$ret = $issueService->deleteIssue($issueKey, array('deleteSubtasks' => 'true'));
540548

541549
var_dump($ret);
542550
} catch (JiraException $e) {

src/Issue/IssueService.php

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -159,10 +159,11 @@ public function addAttachments($issueIdOrKey, $filePathArray)
159159
*
160160
* @param $issueIdOrKey Issue Key
161161
* @param $issueField object of Issue class
162+
* @param array $paramArray Query Parameter key-value Array.
162163
*
163164
* @return created issue key
164165
*/
165-
public function update($issueIdOrKey, $issueField)
166+
public function update($issueIdOrKey, $issueField, $paramArray = [])
166167
{
167168
$issue = new Issue();
168169

@@ -175,7 +176,9 @@ public function update($issueIdOrKey, $issueField)
175176

176177
$this->log->addInfo("Update Issue=\n".$data);
177178

178-
$ret = $this->exec($this->uri."/$issueIdOrKey", $data, 'PUT');
179+
$queryParam = '?'.http_build_query($paramArray);
180+
181+
$ret = $this->exec($this->uri."/$issueIdOrKey".$queryParam, $data, 'PUT');
179182

180183
return $ret;
181184
}
@@ -234,13 +237,17 @@ public function changeAssignee($issueIdOrKey, $assigneeName)
234237
* Delete a issue.
235238
*
236239
* @param issueIdOrKey Issue id or key
240+
* @param array $paramArray Query Parameter key-value Array.
241+
* @return true | false
237242
*
238243
*/
239-
public function deleteIssue($issueIdOrKey)
244+
public function deleteIssue($issueIdOrKey, $paramArray = [])
240245
{
241246
$this->log->addInfo("deleteIssue=\n");
242247

243-
$ret = $this->exec($this->uri."/$issueIdOrKey", '', 'DELETE');
248+
$queryParam = '?'.http_build_query($paramArray);
249+
250+
$ret = $this->exec($this->uri."/$issueIdOrKey".$queryParam, '', 'DELETE');
244251

245252
$this->log->addInfo('delete issue '.$issueIdOrKey.' result='.var_export($ret, true));
246253

0 commit comments

Comments
 (0)