• Главная
• chobie
• Jira
• Api

PHP Класс chobie\Jira\Api

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$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 ) : Result | false	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 | Result | false	Send request to specified host.
closeIssue ( string $issue_key ) : Result | array	Closes issue.
createAttachment ( string $issue_key, string $filename, string $name = null ) : Result | false	Create attachment.
createIssue ( string $project_key, string $summary, string $issue_type, array $options = [] ) : Result | false	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 = [] ) : Result | false	Creates new version.
downloadAttachment ( string $url ) : array | string	Downloads attachment.
editIssue ( string $issue_key, array $params ) : Result | false	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 = '' ) : Result | false	Get specified issue.
getIssueTypes ( ) : IssueType[]	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 ( ) : Result | false	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 ) : Result | false	Get available transitions for a ticket.
getVersions ( string $project_key ) : array | false	Get versions of a project.
getWorklogs ( string $issue_key, array $params ) : Result | false	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' ) : Result | false	Query issues.
setEndpoint ( string $url ) : void	Set Endpoint URL.
setOptions ( integer $options ) : void	Sets options.
setWatchers ( string $issue_key, array $watchers ) : Result | false	Set issue watchers.
transition ( string $issue_key, array $params ) : Result | false	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

Описание методов

Описание свойств