Pre-generated PHP DTOs for the RoadRunner API protocol buffers

This package provides PHP Data Transfer Object (DTO) messages generated from the RoadRunner API protocol buffer files. Include it in your PHP project to make RPC calls to the RoadRunner server without compiling the .proto files yourself.

Get Started

Installation

composer require roadrunner/api-dto

What's inside

DTO messages for the following RoadRunner plugins, under the RoadRunner\ namespace:

• App Logger
• Centrifugo
• HTTP
• Jobs
• KV
• Lock
• Service
• Status
• Temporal
• WebSockets

The package also ships the Temporal API and Temporal Cloud API messages and gRPC clients under the Temporal\Api\ namespace. They depend on the google/common-protos package, which you need to install yourself.

Generating DTOs

If you would like to generate the DTOs yourself, use the generate.sh script. It generates the DTOs for all the plugins and places them in the generated/ directory.

You will need:

• the protoc binary — the committed DTOs are generated with protoc v34, matching the google/protobuf runtime constraint;
• the grpc_php_plugin — follow this instruction to build it;
• the API submodules: git submodule update --init --recursive.

Then run:

./generate.sh

Contribution

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