Download the PHP package quangvule/php-jira-rest-client without Composer
On this page you can find all versions of the php package quangvule/php-jira-rest-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package php-jira-rest-client
PHP JIRA Rest Client
Requirements
- PHP >= 5.5.9
- php JsonMapper
- phpdotenv
Installation
-
Download and Install PHP Composer.
-
Next, run the Composer command to install the latest version of php jira rest client.
or add the following to your composer.json file.
-
Then run Composer's install or update commands to complete installation.
- After installing, you need to require Composer's autoloader:
Configuration
you can choose loads environment variables either 'dotenv' or 'array'.
use dotenv
copy .env.example file to .env on your project root.
Important Note: As of March 15, 2018, in accordance to the Atlassian REST API Policy, Basic auth with password to be deprecated. Instead of password, you should using API token.
Laravel Users: If you are developing with laravel framework(5.x), you must append above configuration to your application .env file.
use array
create Service class with ArrayConfiguration parameter.
Usage
Table of Contents
Project
- Get Project Info
- Get All Project list
- Get Project Type
- Get Project Version
Custom Field
- Get All Field list
- Create Custom Field
Issue
- Get Issue Info
- Create Issue
- Create Issue - bulk
- Create Sub Task
- Add Attachment
- Update issue
- Update Labels
- Change assignee
- Remove issue
- Add comment
- Get comment
- Delete comment
- Perform a transition on an issue
- Perform an advanced search, using the JQL
- Simple JQL
- JQL With pagination
- Using JQL Query class
- Remote Issue Link
- Get Remote Issue Link
- Create Remote Issue Link
- Issue time tracking
- Add worklog in Issue
- Edit worklog in Issue
- Get Issue worklog
- Add watcher to Issue
- Send a notification to the recipients
IssueLink
- Create Issue Link
- Get Issue LinkType
User
- Create User
- Get User Info
- Find Users
- Find Assignable Users
Group
- Create Group
- Get Users from group
- Add User to group
Priority
- Get All Priority list
- Get Priority
Attachment
- Get attachment Info
- Remove attachment
Version
- Create version
- Update version
- Delete version
Get Project Info
Get All Project list
Get Project type
See Jira API reference (get all types)
See Jira API reference (get type)
Get Project Version
get all project's versions.
or get pagenated project's versions.
Get All Field List
Create Custom Field
If you need a list of custom field types(ex. com.atlassian.jira.plugin.system.customfieldtypes:grouppicker) , check out Get All Field list.
Get Issue Info
Returns a full representation of the issue for the given issue key.
You can access the custom field associated with issue through $issue->fields->customFields array or through direct custom field id variables(Ex: $issue->fields->customfield_10300).
Create Issue
If you want to set custom field, you can call the addCustomField function with custom field id and value as parameters.
Currently, not tested for all custom field types.
Create Multiple Issues
Create Sub Task
Creating a sub-task is similar to creating a regular issue, with two important method calls:
for example
Add Attachment
Update issue
If you want to change the custom field type when updating an issue, you can call the addCustomField function just as you did for creating issue.
Update labels
This function is a convenient wrapper for add or remove label in the issue.
Change Assignee
Remove Issue
Add comment
Get comment
Delete comment
Perform a transition on an issue
Note: this library uses goal status names instead of transition names.
So, if you want to change issue status to 'Some Status',
you should pass that status name to setTransitionName
i.e. $transition->setTransitionName('Some Status')
Perform an advanced search
Simple Query
JQL with pagination
JQL query class
If you're not familiar JQL then you can use convenience JqlQuery class.
JqlFunction class can be used to add jql functions calls to query.
You can find the names of almost all fields, functions, keywords and operators
defined as constants in JqlQuery
and static methods in JqlFunciton
classes.
For more info see the Jira docs (link above).
Remote Issue Link
get remote issue link
create remote issue link
Issue time tracking
This methods use get issue
and edit issue
methods internally.
See Jira API reference (get issue)
See Jira API reference (edit issue)
Add worklog in issue
edit worklog in issue
Get issue worklog
See Jira API reference (get full issue worklog)
See Jira API reference (get worklog by id)
Add watcher to Issue
issue notify
Create Issue Link
The Link Issue Resource provides functionality to manage issue links.
Get Issue LinkType
Rest resource to retrieve a list of issue link types.
Create User
Create user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.
Get User Info
Returns a user.
Find Users
Returns a list of users that match the search string and/or property.
Find Assignable Users
Returns a list of users that match the search string.
Create Group
Create new group.
Get Users from group
returns a paginated list of users who are members of the specified group and its subgroups.
Add User to group
add user to given group.
Get All Priority list
Get Priority
Get Attachment Info
Gets the attachment information and saves the attachment into the outDir directory.
Remove attachment
Create version
Update version
Delete version
License
Apache V2 License
JIRA Rest API Documents
- 6.4 - https://docs.atlassian.com/jira/REST/6.4/
- Jira Server latest - https://docs.atlassian.com/jira/REST/server/
- Jira Cloud latest - https://docs.atlassian.com/jira/REST/latest/
All versions of php-jira-rest-client with dependencies
ext-curl Version *
netresearch/jsonmapper Version ~0.11|^1.0
monolog/monolog Version ~1.12
vlucas/phpdotenv Version ~1.0|~2.0