protobuf/php
Paul Yang d7c4409589
Php 7.3 fix (#5434)
* Inherit from message instead of implement

When regestering class (implmenets other class) during MINIT, zend_class_implements
would call zend_class_entry->interface_gets_implemented(). In PHP-7.3 interface_gets_implemented shares the same location with create_object.
However, during MINIT, the global object storeage hasn't been initialized. And thus, caused segment fault in php 7.3.

* Use zend_string_init where interned string may be the value.
zend_string_dup will keep using the existing interned string.
In php 7.3, interned string cannot be destroyed from user's code.

* Uncommment debug code

* Use latest phpunit for each php versions

* Revert change in Dockerfile

* Update php test to use the new docker image

* Update composer

* Change docker organization

* Update phpunit

* Debug phpunit

* Store phpunit into bin dir in docker image

* Install valgrind to docker

* Fix compatibility test

* Remove generated_service_test from compatibility c extension test

* Update 32bit php test to the new docker image

* Install bison

* Fix build.sh

* Fix DOCKERIMAGE_PREFIX

* Fix basename

* Add comment to build_and_run_docker2.sh

* Remove commented code

* Fix comments
2018-12-18 10:57:03 -08:00
..
ext/google/protobuf Php 7.3 fix (#5434) 2018-12-18 10:57:03 -08:00
src Down-integrate internal changes (#5467) 2018-12-14 16:05:03 -08:00
tests Php 7.3 fix (#5434) 2018-12-18 10:57:03 -08:00
composer.json PHP: Add support for primitive types in setters (#5126) 2018-10-07 16:56:41 -07:00
generate_descriptor_protos.sh Add file option php_class_prefix (#2849) 2017-03-17 11:08:06 -07:00
phpunit.xml PHP: Add support for primitive types in setters (#5126) 2018-10-07 16:56:41 -07:00
README.md adding of hyperlink of the PHP (#4985) 2018-08-02 19:49:44 -07:00

This directory contains the Protocol Buffers runtime implementation via both a pure PHP package and a native c extension. The pure PHP package is intended to provide usability to wider range of PHP platforms, while the c extension is intended to provide higher performance. Both implementations provide the same runtime APIs and share the same generated code. Users dont need to re-generate code for the same proto definition when they want to switch the implementation later.

Both implementations make use of generated PHP code that defines message and enum types in PHP. We strongly recommend using protoc's PHP generation support with .proto files. The build process in this directory only installs the extension/package; you need to install protoc as well to have PHP code generation functionality.

Requirements

To use PHP runtime library requires:

  • C extension: PHP 5.5, 5.6, or 7.
  • PHP package: PHP 5.5, 5.6 or 7.

Installation

C Extension

Prerequirements

To install the c extension, the following tools are needed:

  • autoconf
  • automake
  • libtool
  • make
  • gcc
  • pear
  • pecl

On Ubuntu, you can install them with:

sudo apt-get install -y php-pear php5-dev autoconf automake libtool make gcc

On other platforms, please use the corresponding package managing tool to install them before proceeding.

Installation from Source (Building extension)

To build the c extension, run the following command:

cd ext/google/protobuf
pear package
sudo pecl install protobuf-{VERSION}.tgz

Installation from PECL

When we release a version of Protocol Buffers, we will upload the extension to PECL. To use this pre-packaged extension, simply install it as you would any other extension:

sudo pecl install protobuf-{VERSION}

PHP Package

Installation from composer

Simply add "google/protobuf" to the 'require' section of composer.json in your project.

Protoc

Once the extension or package is installed, if you wish to generate PHP code from a .proto file, you will also want to install the Protocol Buffers compiler (protoc), as described in this repository's main README file. The version of protoc included in the latest release supports the --php_out option to generate PHP code:

protoc --php_out=out_dir test.proto

Usage

For generated code: https://developers.google.com/protocol-buffers/docs/reference/php-generated

Known Issues

  • Missing native support for well known types.
  • Missing support for proto2.
  • No API provided for clear/copy messages.
  • No API provided for encoding/decoding with stream.
  • Map fields may not be garbage-collected if there is cycle reference.
  • No debug information for messages in c extension.
  • HHVM not tested.
  • C extension not tested on windows, mac, php 7.0.
  • Message name cannot be Empty.