Download the PHP package chargemap/ocpi-protocol without Composer

On this page you can find all versions of the php package chargemap/ocpi-protocol. 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?

Example code of chargemap/ocpi-protocol

Informations about the package ocpi-protocol

OCPI Protocol

Library to handle OCPI. Compatible with PSRs.

Functionality

Library provides OCPI request/response classes for eMSP interfaces, models, factories and errors. Listing requests/responses are also supported for GET routes. The responses need a corresponding request to be constructed. It is required to ensure the presence and validity of offset and limit request headers and X-Total-Count, X-Limit and Link response headers. So it is quite easy to construct valid listing response or get the next request.

eMSP interface

Respond to CPO

Each request and response class correspond to an eMSP interface route. Request classes must be instantiated by providing PSR-7 compatible request (got from CPO). Internally, it extracts the authorization token from headers, and validates the body (if necessary) against json schema. Then, it constructs corresponding model class using the factories. The model is accessible via a getter.

Response classes must be instantiated with a model instance, even if it's not used (e.g. in Post/Put/Patch responses). It can be converted to PSR-7 compatible response instance using getResponseInterface method.

Use of listing request/response

Request the CPO

This part provides an API SDK to request the CPO. To use it, you need to instantiate the OcpiClient with OcpiConfiguration and needed endpoints. Then you can perform the requests like that:

Listing request/response

Common

Errors

Each error class corresponds to an OCPI error code. It can be converted to the PSR-7 response instance just like any response class. It ensures correct HTTP error code as well as OCPI status code.

Errors are supposed to be thrown and caught by a middleware/listener and then transformed to the response.

Models

Models fetched from request's/response's json body correspond to the OCPI objects. The exception to the rule is Partial[Class] classes, that are used in PATCH routes. They have the same but nullable properties as their corresponding [Class].

All versions of ocpi-protocol with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4
ext-json Version *
ext-mbstring Version *
psr/log Version ^1.1
psr/http-client Version ^1.0
psr/http-factory Version ^1.0
psr/http-message Version ^1.0
php-http/discovery Version ^1.7
myclabs/php-enum Version ^1.7
justinrainbow/json-schema Version ^5.2
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 chargemap/ocpi-protocol contains the following files

Loading the files please wait ....