(PHP) add experimental support for PHP language.
authorShuhei Taunma <chobieee@gmail.com>
Thu, 5 Nov 2015 07:19:28 +0000 (16:19 +0900)
committerShuhei Tanuma <chobieee@gmail.com>
Tue, 17 Nov 2015 15:26:39 +0000 (00:26 +0900)
commit5ce86826718c938e38b0f57e4bc5840fe15a1565
tree7b34312db70588595b515c21fd8df36814cf27dd
parent3f1c4b41f650a5d4e9f89f606f01ba0a6a164029
(PHP) add experimental support for PHP language.

* codegen for all basic features: WIP (probably implemented all basic feature)
* JSON parsing: NO
* Simple mutation: NO
* Reflection: NO
* Buffer verifier: NO (will be add later)
* Testing: basic: Yes
* Testing: fuzz: Yes
* Performance: Not bad
* Platform: Supported Linux, OS X, Windows (has 32bit integer limitation)
* Engine Unity: No

flatc --php monster_test.fbs

  <?php
  //include neccessary files.
  $fbb = new Google\FlatBuffers\FlatBufferBuilder(1);
  $str = $fbb->createString("monster");
  \MyGame\Example\Monster::startMonster($fbb);
  \MyGame\Example\Monster::addHp($fbb, 80);
  \MyGame\Example\Monster::addName($fbb, $str);
  $mon = \MyGame\Example\Monster::endMonster($fbb);
  $fbb->finish($mon);
  echo $fbb->sizedByteArray();

PHP 5.4 higher

Currently, we do not register this library to packagist as still experimental and versioning problem.
If you intended to use flatbuffers with composer. add repostiories section to composer.json like below.

  "repositories": [{
    "type": "vcs",
    "url": "https://github.com/google/flatbuffers"
  }],

 and just put google/flatbuffers.

  "require": {
    "google/flatbuffers": "*"
  }

* PHP's integer is platform dependant. we strongly recommend use 64bit machine
  and don't use uint, ulong types as prevent overflow issue.
  ref: http://php.net/manual/en/language.types.integer.php

* php don't support float type. floating point numbers are always parsed as double precision internally.
  ref: http://php.net/manual/en/language.types.float.php

* ByteBuffer is little bit slow implemnentation due to many chr/ord function calls. Especially encoding objects.
  This is expected performance as PHP5 has parsing arguments overhead. probably we'll add C-extension.

Basically, PHP implementation respects Java and C# implementation.

Note: ByteBuffer and FlatBuffersBuilder class are not intended to use other purposes.
      we may change internal API foreseeable future.

PSR-2, PSR-4 standards.

Implemented simple assertion class (respect JavaScript testcase implementation) as we prefer small code base.
this also keeps CI iteration speed.

we'll choose phpunit or something when the test cases grown.
20 files changed:
CMakeLists.txt
composer.json [new file with mode: 0644]
include/flatbuffers/idl.h
php/ByteBuffer.php [new file with mode: 0644]
php/Constants.php [new file with mode: 0644]
php/FlatbufferBuilder.php [new file with mode: 0644]
php/Struct.php [new file with mode: 0644]
php/Table.php [new file with mode: 0644]
src/flatc.cpp
src/idl_gen_php.cpp [new file with mode: 0644]
tests/MyGame/Example/Any.php [new file with mode: 0644]
tests/MyGame/Example/Color.php [new file with mode: 0644]
tests/MyGame/Example/Monster.php [new file with mode: 0644]
tests/MyGame/Example/Stat.php [new file with mode: 0644]
tests/MyGame/Example/Test.php [new file with mode: 0644]
tests/MyGame/Example/TestSimpleTableWithEnum.php [new file with mode: 0644]
tests/MyGame/Example/Vec3.php [new file with mode: 0644]
tests/generate_code.bat [new file with mode: 0644]
tests/generate_code.sh
tests/phpTest.php [new file with mode: 0644]