2022-07-13 15:42:37 +02:00
|
|
|
# Protobuf How To
|
2022-06-20 17:47:23 +02:00
|
|
|
|
2022-07-13 15:42:37 +02:00
|
|
|
⚠️ Protobuf classes are generated, do NOT modify the classes manually ⚠️
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
|
|
|
|
- Install the protobuf compiler
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
sudo apt install protobuf-compiler
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- Install the protobuf PHP extension
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
sudo pecl install protobuf
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
- Install the composer package
|
2022-06-20 17:47:23 +02:00
|
|
|
|
|
|
|
|
```sh
|
2022-07-13 15:42:37 +02:00
|
|
|
composer require google/protobuf
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Reference: [protobuf/php](https://github.com/protocolbuffers/protobuf/tree/main/php)
|
|
|
|
|
|
|
|
|
|
## Generate the class
|
|
|
|
|
|
|
|
|
|
- Edit the *.proto file
|
|
|
|
|
|
|
|
|
|
>Reference: [protocol-buffers/docs/proto3](https://developers.google.com/protocol-buffers/docs/proto3)
|
|
|
|
|
|
|
|
|
|
- Run the following cli command:
|
|
|
|
|
|
|
|
|
|
```bash
|
2022-06-20 17:47:23 +02:00
|
|
|
protoc --proto_path=app/Protobuf/ --php_out=. app/Protobuf/GoogleAuth.proto
|
|
|
|
|
```
|
2022-07-13 15:42:37 +02:00
|
|
|
|
|
|
|
|
Protoc will generate the files in `app/Protobuf` while we want them to be in `App/protobuf`.
|
|
|
|
|
|
|
|
|
|
- Moves the files from `app/Protobuf` to `App/protobuf`
|
|
|
|
|
- Update the namespace of the moved files to match their new location
|
|
|
|
|
|
|
|
|
|
>Reference: [protocol-buffers/docs/php-generated](https://developers.google.com/protocol-buffers/docs/reference/php-generated#invocation)
|
