README

👁 Image

RoadRunner PHP API DTO

👁 PHP Version Require
👁 Latest Stable Version
👁 Total Downloads

This is a GitHub repository and Composer package that provides PHP Data Transfer Object (DTO) messages for RoadRunner API protocol buffer files, available at https://github.com/roadrunner-server/api.

With this repository, you can use pre-generated DTO messages for the following RoadRunner plugins:

• Centrifugo
• HTTP
• Jobs
• KV
• Lock
• Plugins
• Service
• Status
• WebSockets

The repository contains the pre-generated DTO files, and you can include the package in your PHP project to use them for making RPC calls to the RoadRunner server.

Installation

You can install the package. Simply run the following command:

composer require roadrunner-php/roadrunner-api-dto

Generating DTOs

If you would like to generate the DTOs yourself, you can use the generate.sh script. This script will generate the DTOs for all of the plugins, and place them in the generated/ directory.

But before that, you will need to compile the grpc_php_plugin. Follow this instruction to build the file.

Then run:

./generate.sh

Note: You will need to have the protoc >= 3.15 binary installed on your system.

Contribution

Contributions are welcome! If you would like to contribute to this project, please open an issue or pull request.

License

This repository is licensed under the MIT license. See LICENSE for more information.