Download the PHP package kbsali/redmine-api without Composer

On this page you can find all versions of the php package kbsali/redmine-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
kbsali/redmine-api
Rate from 1 - 5
Rated 3.67 based on 3 reviews

Informations about the package redmine-api

PHP Redmine API

Latest Version Build Status Codecov Total Downloads

A simple PHP Object Oriented wrapper for Redmine API.

Uses Redmine API.

Features

Supported Redmine versions

We support (and run tests against) the latest Redmine versions that are actively maintained.

Nevertheless, you can also use this library for all older Redmine versions. In this case, however, be aware that some features may not yet be supported by your Redmine server.

If a new Redmine version enables new features that are not yet supported with this library, you are welcome to create an issue.

Requirements

Optional

Todo

Limitations / Missing Redmine-API

Redmine is missing some APIs for a full remote management of the data:

Install

By using Composer you can simply run:

at the root of your projects. To utilize the library, include Composer's vendor/autoload.php in the scripts that will use the Redmine classes.

For example,

For a manual installation please follow this instruction.

Running the test suite

You can run test suite to make sure the library will work properly on your system. Simply run vendor/bin/phpunit in the project's directory :

Basic usage of php-redmine-api client

Start your project

Create your project e.g. in the index.php by require the vendor/autoload.php file.

Instantiate a Redmine Client

You can choose between:

  1. a native curl client or
  2. the PSR-18 compatible client.

1. Native curl Client Redmine\Client\NativeCurlClient

:bulb: This client was introduced in php-redmine-api v1.8.0. If you are using the old Redmine\Client please see this migration guide for help to upgrade your code.

You will need a URL to your Redmine instance and either a valid Apikey...

... or valid username/password.

:bulb: For security reason it is recommended that you use an ApiKey rather than your username/password.

cURL configuration

After you instantiate a client you can set some optional cURL settings.

2. Psr-18 compatible Client Redmine\Client\Psr18Client

:bulb: This client was introduced in v1.7.0 of this library. If you are using the old Redmine\Client please follow this migration guide.

The Psr18Client requires

:bulb: For security reason it is recommended that you use an ApiKey rather than your username/password.

Guzzle configuration

Because the Psr18Client is agnostic about the HTTP client implementation every configuration specific to the transport has to be set to the Psr\Http\Client\ClientInterface implementation.

This means that if you want to set any cURL settings to Guzzle you have multiple ways to set them:

  1. Using Guzzle environment variables
  2. Using request options inside a Psr\Http\Client\ClientInterface wrapper:

Built-in Redmine features

Impersonate User

Redmine allows you to impersonate another user. This can be done using the methods startImpersonateUser() and stopImpersonateUser().

API usage

You can now use the getApi() method to create and get a specific Redmine API.

See further examples and read more about usage in the docs.

Thanks!


All versions of redmine-api with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-simplexml Version *
ext-json Version *
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package kbsali/redmine-api contains the following files

Loading the files please wait ....