Download the PHP package adeelnawaz/polr-api-client without Composer

On this page you can find all versions of the php package adeelnawaz/polr-api-client. 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?

Informations about the package polr-api-client

Polr API Client

This package is a PHP client API library for open source project Polr Project. It supports all APIs from Polr v2.2.0. Pull requests and improvement suggestions are welcome.
Note: If you are working with Symfony, use this instead.

Installation via composer

In your console, navigate to your project directory and execute the following command to download the latest stable version of this package:

Usage

(see examples/ directory for PHP example code for each API method)

In order to use the API, instantiate an object of PolrApi. Upon instantiation of the object, the following have to be provided:

After instantiating the API, create DTO object(s) (DTO\Link, etc) for the method you intend to use and call the method. This will result in calling the respective REST API endpoint and returning the relative DTO\Response object.
(See Docblocks of the PolrApi methods for further information on input/output DTOs)

In case of a failed API call, the PolrApi methods throw ApiResponseException. The exception has getters for code, message, and a machine readable short string error_code returned by the Polr REST API.

Example:

Note
The Quota is requests per second. Specify the right quota for the key/user otherwise you might run into API overuse, resulting in exceptions. Set 0 for unlimited

Response

The response object for each method is either a DTO or array of DTOs from \Adeelnawaz\PolrApiClient\DTO\Response namespace. Please see API method docblocks for applicable response DTO for each method.

Error Response

In case of an error the API methods throw Adeelnawaz\PolrApiClient\Exception\ApiResponseException. The valuable information contained within the exception includes


All versions of polr-api-client with dependencies

PHP Build Version
Package Version
Requires symfony/serializer Version ^4.4||^5.1
symfony/property-access Version ^4.4||^5.1
doctrine/annotations Version ^1.11
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 adeelnawaz/polr-api-client contains the following files

Loading the files please wait ....