PHP Class JiraRestApi\Issue\IssueService

Inheritance: extends JiraRestApi\JiraClient
Show file Open project: lesstif/php-jira-rest-client Class Usage Examples

Public Methods

Method Description
addAttachments ( $issueIdOrKey, $filePathArray ) Add one or more file to an issue.
addComment ( $issueIdOrKey, $comment ) : JiraRestApi\Issue\Comment Adds a new comment to an issue.
addWorklog ( mixed $issueIdOrKey, object $worklog ) : Worklog add work log to issue.
create ( $issueField ) : created create new issue.
createMultiple ( IssueField[] $issueFields, integer $batchSize = 50 ) : [] Create multiple issues using bulk insert.
editWorklog ( $issueIdOrKey, $worklog, string $worklogId ) : object edit the worklog
findTransitonId ( $issueIdOrKey, $transitionToName ) find transition id by transition's to field name(aka 'Resolved').
get ( $issueIdOrKey, array $paramArray = [], Issue $issueObject = null ) : Issue get all project list.
getAllPriorities ( ) : array Get all priorities.
getCustomFields ( $priorityId ) : string Get priority by id.
getIssueFromJSON ( $json )
getPriority ( $priorityId ) : string Get priority by id.
getTimeTracking ( type $issueIdOrKey ) : type get TimeTracking info.
getTransition ( $issueIdOrKey ) : array Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
getWorklog ( mixed $issueIdOrKey ) : PaginatedWorklog get getWorklog.
getWorklogById ( mixed $issueIdOrKey, integer $workLogId ) : PaginatedWorklog get getWorklog by Id.
search ( $jql, integer $startAt, integer $maxResults = 15, array $fields = [] ) : IssueSearchResult Search issues.
timeTracking ( $issueIdOrKey, $timeTracking ) : type TimeTracking issues.
transition ( $issueIdOrKey, $transition ) : nothing Perform a transition on an issue.
update ( $issueIdOrKey, $issueField ) : created update issue.

Private Methods

Method Description
bulkInsert ( [] $issues ) : [] Makes API call to bulk insert issues.

Method Details

addAttachments() public method

Add one or more file to an issue.
public addAttachments ( $issueIdOrKey, $filePathArray )

addComment() public method

Adds a new comment to an issue.
public addComment ( $issueIdOrKey, $comment ) : JiraRestApi\Issue\Comment
return JiraRestApi\Issue\Comment class

addWorklog() public method

add work log to issue.
public addWorklog ( mixed $issueIdOrKey, object $worklog ) : Worklog
$issueIdOrKey mixed
$worklog object
return Worklog Object

create() public method

create new issue.
public create ( $issueField ) : created
return created issue key

createMultiple() public method

Create multiple issues using bulk insert.
public createMultiple ( IssueField[] $issueFields, integer $batchSize = 50 ) : []
$issueFields IssueField[] Array of IssueField objects
$batchSize integer Maximum number of issues to send in each request
return []

editWorklog() public method

edit the worklog
public editWorklog ( $issueIdOrKey, $worklog, string $worklogId ) : object
$issueIdOrKey
$worklog
$worklogId string
return object

findTransitonId() public method

find transition id by transition's to field name(aka 'Resolved').
public findTransitonId ( $issueIdOrKey, $transitionToName )

get() public method

get all project list.
public get ( $issueIdOrKey, array $paramArray = [], Issue $issueObject = null ) : Issue
$issueIdOrKey
$paramArray array Query Parameter key-value Array.
$issueObject Issue
return Issue class

getAllPriorities() public method

Get all priorities.
public getAllPriorities ( ) : array
return array of priority class

getCustomFields() public method

Get priority by id.
public getCustomFields ( $priorityId ) : string
return string priority id

getIssueFromJSON() public method

public getIssueFromJSON ( $json )

getPriority() public method

Get priority by id.
public getPriority ( $priorityId ) : string
return string priority id

getTimeTracking() public method

get TimeTracking info.
public getTimeTracking ( type $issueIdOrKey ) : type
$issueIdOrKey type
return type @TimeTracking

getTransition() public method

Get a list of the transitions possible for this issue by the current user, along with fields that are required and their types.
public getTransition ( $issueIdOrKey ) : array
return array of Transition class

getWorklog() public method

get getWorklog.
public getWorklog ( mixed $issueIdOrKey ) : PaginatedWorklog
$issueIdOrKey mixed
return PaginatedWorklog object

getWorklogById() public method

get getWorklog by Id.
public getWorklogById ( mixed $issueIdOrKey, integer $workLogId ) : PaginatedWorklog
$issueIdOrKey mixed
$workLogId integer
return PaginatedWorklog object

timeTracking() public method

TimeTracking issues.
public timeTracking ( $issueIdOrKey, $timeTracking ) : type
return type @TimeTracking

transition() public method

Perform a transition on an issue.
public transition ( $issueIdOrKey, $transition ) : nothing
return nothing - if transition was successful return http 204(no contents)

update() public method

update issue.
public update ( $issueIdOrKey, $issueField ) : created
$issueIdOrKey Issue Key
$issueField object of Issue class
return created issue key