프로퍼티 | 타입 | 설명 | |
---|---|---|---|
$authentication | chobie\Jira\Api\Authentication\AuthenticationInterface | Authentication. | |
$client | chobie\Jira\Api\Client\ClientInterface | Client. | |
$endpoint | string | Endpoint URL. | |
$fields | array | null | Client-side cache of fields. List of fields when loaded, null when nothing is fetched yet. | |
$options | integer | Options. | |
$priorities | array | null | Client-side cache of priorities. List of priorities when loaded, null when nothing is fetched yet. | |
$resolutions | array | null | Client-side cache of resolutions. List of resolutions when loaded, null when nothing is fetched yet. | |
$statuses | array | null | Client-side cache of statuses. List of statuses when loaded, null when nothing is fetched yet. |
메소드 | 설명 | |
---|---|---|
__construct ( string $endpoint, chobie\Jira\Api\Authentication\AuthenticationInterface $authentication, chobie\Jira\Api\Client\ClientInterface $client = null ) | Create a JIRA API client. | |
addComment ( string $issue_key, array | string $params ) : |
Add a comment to a ticket. | |
api ( string $method = self::REQUEST_GET, string $url, array | string $data = [], boolean $return_as_array = false, boolean $is_file = false, boolean $debug = false ) : array | |
Send request to specified host. | |
closeIssue ( string $issue_key ) : |
Closes issue. | |
createAttachment ( string $issue_key, string $filename, string $name = null ) : |
Create attachment. | |
createIssue ( string $project_key, string $summary, string $issue_type, array $options = [] ) : |
Creates an issue. | |
createRemotelink ( string $issue_key, array $object = [], string $relationship = null, string $global_id = null, array $application = null ) : array | false | Creates a remote link. | |
createVersion ( string $project_key, string $version, array $options = [] ) : |
Creates new version. | |
downloadAttachment ( string $url ) : array | string | Downloads attachment. | |
editIssue ( string $issue_key, array $params ) : |
Edits the issue. | |
findVersionByName ( string $project_key, string $name ) : array | null | Helper method to find a specific version based on the name of the version. | |
getAttachment ( string $attachment_id ) : array | false | Gets attachment. | |
getAttachmentsMetaInformation ( ) : array | Gets attachments meta information. | |
getCreateMeta ( array $project_ids = null, array $project_keys = null, array $issue_type_ids = null, array $issue_type_names = null, array $expand = null ) : array | false | Returns the meta data for creating issues. | |
getEndpoint ( ) : string | Get Endpoint URL. | |
getFields ( ) : array | Get fields definitions. | |
getIssue ( string $issue_key, string $expand = '' ) : |
Get specified issue. | |
getIssueTypes ( ) : |
Get available issue types. | |
getPriorities ( ) : array | Get available priorities. | |
getProject ( string $project_key ) : array | false | Returns one project. | |
getProjectComponents ( string $project_key ) : array | Returns project components. | |
getProjectIssueTypes ( string $project_key ) : array | Get all issue types with valid status values for a project. | |
getProjects ( ) : |
Returns all projects. | |
getResolutions ( ) : array | Returns a list of all resolutions. | |
getRoleDetails ( string $project_key, string $role_id ) : array | false | Returns role details. | |
getRoles ( string $project_key ) : array | false | Returns all roles of a project. | |
getStatuses ( ) : array | Get available statuses. | |
getTransitions ( string $issue_key, array $params ) : |
Get available transitions for a ticket. | |
getVersions ( string $project_key ) : array | false | Get versions of a project. | |
getWorklogs ( string $issue_key, array $params ) : |
Get all worklogs for an issue. | |
releaseVersion ( integer $version_id, string | null $release_date = null, array $params = [] ) : false | Shorthand to mark a version as Released. | |
search ( string $jql, integer $start_at, integer $max_results = 20, string $fields = '*navigable' ) : |
Query issues. | |
setEndpoint ( string $url ) : void | Set Endpoint URL. | |
setOptions ( integer $options ) : void | Sets options. | |
setWatchers ( string $issue_key, array $watchers ) : |
Set issue watchers. | |
transition ( string $issue_key, array $params ) : |
Transition a ticket. | |
updateVersion ( integer $version_id, array $params = [] ) : false | Updates version. |
메소드 | 설명 | |
---|---|---|
automapFields ( array $issue ) : array | Automaps issue fields. | |
clearLocalCaches ( ) : void | Helper method to clear the local caches. Is called when switching endpoints |
public __construct ( string $endpoint, chobie\Jira\Api\Authentication\AuthenticationInterface $authentication, chobie\Jira\Api\Client\ClientInterface $client = null ) | ||
$endpoint | string | Endpoint URL. |
$authentication | chobie\Jira\Api\Authentication\AuthenticationInterface | Authentication. |
$client | chobie\Jira\Api\Client\ClientInterface | Client. |
public api ( string $method = self::REQUEST_GET, string $url, array | string $data = [], boolean $return_as_array = false, boolean $is_file = false, boolean $debug = false ) : array | |
||
$method | string | Request method. |
$url | string | URL. |
$data | array | string | Data. |
$return_as_array | boolean | Return results as associative array. |
$is_file | boolean | Is file-related request. |
$debug | boolean | Debug this request. |
리턴 | array | |
protected automapFields ( array $issue ) : array | ||
$issue | array | Issue. |
리턴 | array |
protected clearLocalCaches ( ) : void | ||
리턴 | void |
public closeIssue ( string $issue_key ) : |
||
$issue_key | string | Issue key. |
리턴 |
public createRemotelink ( string $issue_key, array $object = [], string $relationship = null, string $global_id = null, array $application = null ) : array | false | ||
$issue_key | string | Issue key. |
$object | array | Object. |
$relationship | string | Relationship. |
$global_id | string | Global ID. |
$application | array | Application. |
리턴 | array | false |
public getAttachment ( string $attachment_id ) : array | false | ||
$attachment_id | string | Attachment ID. |
리턴 | array | false |
public getAttachmentsMetaInformation ( ) : array | ||
리턴 | array |
public getCreateMeta ( array $project_ids = null, array $project_keys = null, array $issue_type_ids = null, array $issue_type_names = null, array $expand = null ) : array | false | ||
$project_ids | array | Combined with the projectKeys param, lists the projects with which to filter the results. If absent, all projects are returned. Specifying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results. |
$project_keys | array | Combined with the projectIds param, lists the projects with which to filter the results. If null, all projects are returned. Specifying a project that does not exist (or that you cannot create issues in) is not an error, but it will not be in the results. |
$issue_type_ids | array | Combined with issuetypeNames, lists the issue types with which to filter the results. If null, all issue types are returned. Specifying an issue type that does not exist is not an error. |
$issue_type_names | array | Combined with issuetypeIds, lists the issue types with which to filter the results. If null, all issue types are returned. This parameter can be specified multiple times, but is NOT interpreted as a comma-separated list. Specifying an issue type that does not exist is not an error. |
$expand | array | Optional list of entities to expand in the response. |
리턴 | array | false |
public getIssueTypes ( ) : |
||
리턴 |
public getProject ( string $project_key ) : array | false | ||
$project_key | string | Project key. |
리턴 | array | false |
public getProjectComponents ( string $project_key ) : array | ||
$project_key | string | Project key. |
리턴 | array |
public getProjectIssueTypes ( string $project_key ) : array | ||
$project_key | string | Project key. |
리턴 | array |
public getProjects ( ) : |
||
리턴 |
public getResolutions ( ) : array | ||
리턴 | array |
public getTransitions ( string $issue_key, array $params ) : |
||
$issue_key | string | Issue key should be "YOURPROJ-22". |
$params | array | Params. |
리턴 |
public getVersions ( string $project_key ) : array | false | ||
$project_key | string | Project key. |
리턴 | array | false |
public getWorklogs ( string $issue_key, array $params ) : |
||
$issue_key | string | Issue key should be "YOURPROJ-22". |
$params | array | Params. |
리턴 |
public setEndpoint ( string $url ) : void | ||
$url | string | Endpoint URL. |
리턴 | void |
public setOptions ( integer $options ) : void | ||
$options | integer | Options. |
리턴 | void |
public setWatchers ( string $issue_key, array $watchers ) : |
||
$issue_key | string | Issue key. |
$watchers | array | Watchers. |
리턴 |
public transition ( string $issue_key, array $params ) : |
||
$issue_key | string | Issue key should be "YOURPROJ-22". |
$params | array | Params. |
리턴 |
public updateVersion ( integer $version_id, array $params = [] ) : false | ||
$version_id | integer | Version ID. |
$params | array | Key->Value list to update the version with. |
리턴 | false |
protected AuthenticationInterface,chobie\Jira\Api\Authentication $authentication | ||
리턴 | chobie\Jira\Api\Authentication\AuthenticationInterface |
protected ClientInterface,chobie\Jira\Api\Client $client | ||
리턴 | chobie\Jira\Api\Client\ClientInterface |