Skip to content

Commit

Permalink
Api methods (except those that return issue lists) now consistently r…
Browse files Browse the repository at this point in the history 
…eturn as associative arrays instead of Result
  • Loading branch information
@jpastoor
jpastoor committed Aug 18, 2016
1 parent 27e4b4b commit a199525
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 45 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
- Remove trailing slash from endpoint url by [@Procta].
- Added local cache to getResolutions by [@jpastoor].
- Renamed Api::api() parameter $return_as_json to $return_as_array by [@jpastoor].
- Changed default Api::api() parameter $return_as_array to TRUE by [@jpastoor].
- Api methods (except those that return issue lists) now consistently return as associative arrays instead of Result by [@jpastoor].

### Removed
...
Expand Down
83 changes: 38 additions & 45 deletions src/Jira/Api.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,14 @@ protected function clearLocalCaches()
/**
* Get fields definitions.
*
* @return array
* @return array|false
*/
public function getFields()
{
// Fetch fields when the method is called for the first time.
if ( $this->fields === null ) {
$fields = array();
$result = $this->api(self::REQUEST_GET, '/rest/api/2/field', array(), true);
$result = $this->api(self::REQUEST_GET, '/rest/api/2/field');

/* set hash key as custom field id */
foreach ( $result as $field ) {
Expand All @@ -199,7 +199,7 @@ public function getFields()
* @param string $issue_key Issue key should be "YOURPROJ-221".
* @param string $expand Expand.
*
* @return Result|false
* @return array|false
*/
public function getIssue($issue_key, $expand = '')
{
Expand All @@ -212,7 +212,7 @@ public function getIssue($issue_key, $expand = '')
* @param string $issue_key Issue key.
* @param array $params Params.
*
* @return Result|false
* @return array|false
*/
public function editIssue($issue_key, array $params)
{
Expand All @@ -222,7 +222,7 @@ public function editIssue($issue_key, array $params)
/**
* Gets attachments meta information.
*
* @return array
* @return array|false
* @since 2.0.0
*/
public function getAttachmentsMetaInformation()
Expand All @@ -239,13 +239,13 @@ public function getAttachmentsMetaInformation()
*/
public function getAttachment($attachment_id)
{
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/attachment/%s', $attachment_id), array(), true);
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/attachment/%s', $attachment_id));
}

/**
* Returns all projects.
*
* @return Result|false
* @return array|false
*/
public function getProjects()
{
Expand All @@ -261,7 +261,7 @@ public function getProjects()
*/
public function getProject($project_key)
{
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s', $project_key), array(), true);
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s', $project_key));
}

/**
Expand All @@ -273,7 +273,7 @@ public function getProject($project_key)
*/
public function getRoles($project_key)
{
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/role', $project_key), array(), true);
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/role', $project_key));
}

/**
Expand All @@ -286,12 +286,7 @@ public function getRoles($project_key)
*/
public function getRoleDetails($project_key, $role_id)
{
return $this->api(
self::REQUEST_GET,
sprintf('/rest/api/2/project/%s/role/%s', $project_key, $role_id),
array(),
true
);
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/role/%s', $project_key, $role_id));
}

/**
Expand Down Expand Up @@ -350,7 +345,7 @@ public function getCreateMeta(
$data['expand'] = implode(',', $expand);
}

return $this->api(self::REQUEST_GET, '/rest/api/2/issue/createmeta', $data, true);
return $this->api(self::REQUEST_GET, '/rest/api/2/issue/createmeta', $data);
}

/**
Expand All @@ -359,7 +354,7 @@ public function getCreateMeta(
* @param string $issue_key Issue key should be "YOURPROJ-221".
* @param array|string $params Params.
*
* @return Result|false
* @return array|false
*/
public function addComment($issue_key, $params)
{
Expand All @@ -379,7 +374,7 @@ public function addComment($issue_key, $params)
* @param string $issue_key Issue key should be "YOURPROJ-22".
* @param array $params Params.
*
* @return Result|false
* @return array|false
* @since 2.0.0
*/
public function getWorklogs($issue_key, array $params)
Expand All @@ -393,7 +388,7 @@ public function getWorklogs($issue_key, array $params)
* @param string $issue_key Issue key should be "YOURPROJ-22".
* @param array $params Params.
*
* @return Result|false
* @return array|false
*/
public function getTransitions($issue_key, array $params)
{
Expand All @@ -406,7 +401,7 @@ public function getTransitions($issue_key, array $params)
* @param string $issue_key Issue key should be "YOURPROJ-22".
* @param array $params Params.
*
* @return Result|false
* @return array|false
*/
public function transition($issue_key, array $params)
{
Expand All @@ -421,7 +416,7 @@ public function transition($issue_key, array $params)
public function getIssueTypes()
{
$result = array();
$types = $this->api(self::REQUEST_GET, '/rest/api/2/issuetype', array(), true);
$types = $this->api(self::REQUEST_GET, '/rest/api/2/issuetype');

foreach ( $types as $issue_type ) {
$result[] = new IssueType($issue_type);
Expand All @@ -439,7 +434,7 @@ public function getIssueTypes()
*/
public function getVersions($project_key)
{
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/versions', $project_key), array(), true);
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/versions', $project_key));
}

/**
Expand Down Expand Up @@ -473,15 +468,15 @@ public function findVersionByName($project_key, $name)
/**
* Get available priorities.
*
* @return array
* @return array|false
* @since 2.0.0
*/
public function getPriorities()
{
// Fetch priorities when the method is called for the first time.
if ( $this->priorities === null ) {
$priorities = array();
$result = $this->api(self::REQUEST_GET, '/rest/api/2/priority', array(), true);
$result = $this->api(self::REQUEST_GET, '/rest/api/2/priority');

/* set hash key as custom field id */
foreach ( $result as $priority ) {
Expand All @@ -504,7 +499,7 @@ public function getStatuses()
// Fetch statuses when the method is called for the first time.
if ( $this->statuses === null ) {
$statuses = array();
$result = $this->api(self::REQUEST_GET, '/rest/api/2/status', array(), true);
$result = $this->api(self::REQUEST_GET, '/rest/api/2/status');

/* set hash key as custom field id */
foreach ( $result as $status ) {
Expand All @@ -525,7 +520,7 @@ public function getStatuses()
* @param string $issue_type Issue type.
* @param array $options Options.
*
* @return Result|false
* @return array|false
*/
public function createIssue($project_key, $summary, $issue_type, array $options = array())
{
Expand Down Expand Up @@ -564,7 +559,7 @@ public function search($jql, $start_at = 0, $max_results = 20, $fields = '*navig
'startAt' => $start_at,
'maxResults' => $max_results,
'fields' => $fields,
)
), false
);

return $result;
Expand All @@ -577,7 +572,7 @@ public function search($jql, $start_at = 0, $max_results = 20, $fields = '*navig
* @param string $version Version.
* @param array $options Options.
*
* @return Result|false
* @return array|false
*/
public function createVersion($project_key, $version, array $options = array())
{
Expand All @@ -603,7 +598,7 @@ public function createVersion($project_key, $version, array $options = array())
* @param integer $version_id Version ID.
* @param array $params Key->Value list to update the version with.
*
* @return false
* @return array|false
* @since 2.0.0
* @link https://docs.atlassian.com/jira/REST/latest/#api/2/version-updateVersion
*/
Expand Down Expand Up @@ -646,7 +641,7 @@ public function releaseVersion($version_id, $release_date = null, array $params
* @param string $filename Filename.
* @param array $options Options.
*
* @return Result|false
* @return array|false
*/
public function createAttachment($issue_key, $filename, array $options = array())
{
Expand All @@ -661,7 +656,7 @@ public function createAttachment($issue_key, $filename, array $options = array()
self::REQUEST_POST,
sprintf('/rest/api/2/issue/%s/attachments', $issue_key),
$options,
false,
true,
true
);
}
Expand Down Expand Up @@ -695,7 +690,7 @@ public function createRemotelink(
$options['application'] = $application;
}

return $this->api(self::REQUEST_POST, sprintf('/rest/api/2/issue/%s/remotelink', $issue_key), $options, true);
return $this->api(self::REQUEST_POST, sprintf('/rest/api/2/issue/%s/remotelink', $issue_key), $options);
}

/**
Expand All @@ -714,7 +709,7 @@ public function api(
$method = self::REQUEST_GET,
$url,
$data = array(),
$return_as_array = false,
$return_as_array = true,
$is_file = false,
$debug = false
) {
Expand Down Expand Up @@ -810,7 +805,7 @@ protected function automapFields(array $issue)
* @param string $issue_key Issue key.
* @param array $watchers Watchers.
*
* @return Result|false
* @return array|false
*/
public function setWatchers($issue_key, array $watchers)
{
Expand All @@ -828,20 +823,18 @@ public function setWatchers($issue_key, array $watchers)
*
* @param string $issue_key Issue key.
*
* @return Result|array
* @return array|false
* @TODO: Should have parameters? (e.g comment)
*/
public function closeIssue($issue_key)
{
$result = array();

// Get available transitions.
$tmp_transitions = $this->getTransitions($issue_key, array());
$tmp_transitions_result = $tmp_transitions->getResult();
$transitions = $tmp_transitions_result['transitions'];
$transitions = $this->getTransitions($issue_key, array());

// Look for "Close Issue" transition in issue transitions.
foreach ( $transitions as $v ) {
foreach ( $transitions['transitions'] as $v ) {
// Close issue if required id was found.
if ( $v['name'] == 'Close Issue' ) {
$result = $this->transition(
Expand All @@ -862,39 +855,39 @@ public function closeIssue($issue_key)
*
* @param string $project_key Project key.
*
* @return array
* @return array|false
* @since 2.0.0
*/
public function getProjectComponents($project_key)
{
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/components', $project_key), array(), true);
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/components', $project_key));
}

/**
* Get all issue types with valid status values for a project.
*
* @param string $project_key Project key.
*
* @return array
* @return array|false
* @since 2.0.0
*/
public function getProjectIssueTypes($project_key)
{
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/statuses', $project_key), array(), true);
return $this->api(self::REQUEST_GET, sprintf('/rest/api/2/project/%s/statuses', $project_key));
}

/**
* Returns a list of all resolutions.
*
* @return array
* @return array|false
* @since 2.0.0
*/
public function getResolutions()
{
// Fetch resolutions when the method is called for the first time.
if ( $this->resolutions === null ) {
$resolutions = array();
$result = $this->api(self::REQUEST_GET, '/rest/api/2/resolution', array(), true);
$result = $this->api(self::REQUEST_GET, '/rest/api/2/resolution');

foreach ( $result as $resolution ) {
$resolutions[$resolution['id']] = $resolution;
Expand Down

0 comments on commit a199525

Please sign in to comment.