cstabor/protoc-gen-php

protoc generator plugin for PECL ProtocolBuffers

0.3 2017-10-16 09:10 UTC

Requires

• php: >=5.3.3
• ext-pcre: *
• ext-protocolbuffers: *
• symfony/console: >=2.4.2
• symfony/yaml: >=2.4.2

Requires (Dev)

• nikic/php-parser: dev-master
• phpspec/prophecy-phpunit: ~1.0
• phpunit/phpunit: 3.7.*

BSD-2-Clause

• Shuhei Tanuma

• protoc
• protocol buffers

README

protoc php generator plugin .

Installation

you can install protoc-gen-php with composer command.

# add protocolbuffers/protoc-gen-php entry to your global composer.json ($HOME/.composer/composer.json)
{
    "require": {
        "cstabor/protoc-gen-php": "0.3"
    }
}

# install with composer
composer global install
# set PATH (add this line to your .bashrc or .zshrc.)
export PATH=$HOME/.composer/vendor/bin/:$PATH

Usage

# this will link composer/bin/protoc-gen-php to /usr/local/bin/protoc-gen-php
protoc --php_out=<output_directory> -I. person.proto

# you can also specify the command.
protoc --plugin=vendor/bin/protoc-gen-php --php_out=<output_directory> -I. person.proto

Features

Yaml based insertion

protoc has comment based insertion point mechanism. it's very usefull to customize generated message. but you need to write custom plugin when using that. protoc-gen-php has pragmatic feature which will check .protoc.php.yml and insert contents when matched.

see https://github.com/chobie/protoc-gen-php/blob/master/proto/.protoc.php.yml

Environments

you can override protoc-gen-php behavior with environemnts.

key	description	example
PACKAGE	over ride package name. expects dot delimited package name	PACKAGE=chobie.io
PEAR_STYLE	don't use namespace.	PEAR_STYLE=1

requirements

• php-protocolbuffers

License

new BSD License