Protobuf for PHP
Protobuf for PHP is an implementation of Google's Protocol Buffers for the PHP
language, supporting its binary data serialization and including a
plugin to generate PHP classes from .proto files.
Great effort has been put into generating PHP files that include all sort of type hints to aide IDE's with autocompletion. Therefore, it can not only be used to communicate with Protocol Buffers services but also as a generation tool for data objects no matter what the final serialization is.
For more information see the included man pages.
- PHP 5.3
- Pear's Console_CommandLine (for the protoc wrapper tool)
protoccompiler version 2.3 or above
- GMP or BC Math extensions ¹
¹ Only needed for negative values in
fixed64 types. See
the known issues section.
- Standard types (numbers, string, enums, messages, etc)
- Pluggable serialization backends (codecs)
- Standard Binary
- Standard TextFormat ¹
- ProtoJson (TagMap and Indexed variants)
- Protoc compiler plugin to generate the PHP classes
- Unknown fields
- Packed fields
- Dynamic messages with annotations support
- Generates service interfaces
- Includes comments from .proto files in the generated files
- Pear package for easy installation
¹ Only serialization is supported
- Speed optimized code generation mode
- Support numbers beyond PHP's native limits
<?php require_once 'DrSlump/Protobuf.php'; \DrSlump\Protobuf::autoload(); $person = new Tutorial\Person(); $person->name = 'DrSlump'; $person->setId(12); $book = new Tutorial\AddressBook(); $book->addPerson($person); // Use default codec $data = $book->serialize(); // Use custom codec $codec = new \DrSlump\Protobuf\Codec\Binary(); $data = $codec->encode($book); // ... or ... $data = $book->serialize($codec);
Install with Pear
rake pear:package version=1.0 [sudo] pear install Protobuf-1.0.tgz
You can also get the latest version by checking out a copy of the repository in your computer.
PHP is very weak when dealing with numbers processing. Several work arounds have been applied to the standard binary codec to reduce incompatibilities between Protobuf types and PHP ones.
Protobuf stores floating point values using the IEEE 754 standard with 64bit words for the
doubleand 32bit for the
floattypes. PHP supports IEEE 754 natively although the precission is platform dependant, however it typically supports 64bit doubles. It means that if your PHP was compiled with 64bit sized doubles (or greater) you shouldn't have any problem encoding and decoded float and double typed values with Protobuf.
Integer values are also platform dependant in PHP. The library has been developed and tested against PHP binaries compiled with 64bit integers. The encoding and decoding algorithm should in theory work no matter if PHP uses 32bit or 64bit integers internally, just take into account that with 32bit integers the numbers cannot exceed in any case the
While Protobuf supports unsigned integers PHP does not. In fact, numbers above the compiled PHP maximum integer (
PHP_INT_MAX, 0x7FFFFFFFFFFFFFFF for 64bits) will be automatically casted to doubles, which typically will offer 53bits of decimal precission, allowing to safely work with numbers upto 0x20000000000000 (2^53), even if they are represented in PHP as floats instead of integers. Higher numbers will loose precission or might even return an infinity value, note that the library does not include any checking for these numbers and using them might provoke unexpected behaviour.
Negative values when encoded as
fixed64types require the big integer extensions GMP or BC Math (the later only for 64bit architectures) to be available in your PHP environment. The reason is that when encoding these negative numbers without using zigzag the binary representation uses the most significant bit for the sign, thus the numbers become above the maximum supported values in PHP. The library will check for these conditions and will automatically try to use GMP or BC to process the value.
The binary codec expects strings to be encoded using UTF-8. PHP does not natively support string encodings,
PHP's string data type is basically a length delimited stream of bytes, so it's not trivial to include
automatic encoding conversion into the library encoding and decoding routines. Instead of trying to guess
or offer a configuration interface for the encoding, the binary codec will process the
string type just as
it would process
byte one, delegating on your application the task of encoding or decoding in the desired
Large messages might be troublesome since the way the library is modelled does not allow to parse or serialize messages as a streams, instead the whole operation is performed in memory, which allows for faster processing but could consume too much RAM if messages are too large.
Since wire types are different across different codec's formats, it's not possible to transcode unkwnon fields consumed in one codec to another. This means, for example, that when consuming a message using the binary codec, if it contains unknown fields, they won't be included when serializing the message using the Json codec.
Generating PHP classes
The generation tool is designed to be run as a
protoc plugin, thus it should
work with any proto file supported by the official compiler.
protoc --plugin=protoc-gen-php --php_out=./build tutorial.proto
To make use of non-standard options in your proto files (like
have to import the
php.proto file included with the library. It's location will
depend on where you've installed this library.
protoc -I=./Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos \ --plugin=protoc-gen-php --php_out=./build tutorial.proto
In order to make your life easier, the supplied protoc plugin offers an additional
execution mode, where it acts as a wrapper for the
protoc invocation. It will
automatically include the
php.proto path so that you don't need to worry about it.
protoc-gen-php -o ./build tutorial.proto
The MIT License Copyright (c) 2011 Iván -DrSlump- Montes Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.