Files
flatbuffers/tests/MyGame/Example/Monster.php
Shuhei Taunma 5ce8682671 (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.
2015-11-18 00:26:39 +09:00

760 lines
19 KiB
PHP

<?php
// automatically generated, do not modify
namespace MyGame\Example;
use \Google\FlatBuffers\Struct;
use \Google\FlatBuffers\Table;
use \Google\FlatBuffers\ByteBuffer;
use \Google\FlatBuffers\FlatBufferBuilder;
/// an example documentation comment: monster object
class Monster extends Table
{
/**
* @param ByteBuffer $bb
* @return Monster
*/
public static function getRootAsMonster(ByteBuffer $bb)
{
$obj = new Monster();
return ($obj->init($bb->getInt($bb->getPosition()) + $bb->getPosition(), $bb));
}
public static function MonsterIdentifier()
{
return "MONS";
}
public static function MonsterBufferHasIdentifier(ByteBuffer $buf)
{
return self::__has_identifier($buf, self::MonsterIdentifier());
}
public static function MonsterExtension()
{
return "mon";
}
/**
* @param int $_i offset
* @param ByteBuffer $_bb
* @return Monster
**/
public function init($_i, ByteBuffer $_bb)
{
$this->bb_pos = $_i;
$this->bb = $_bb;
return $this;
}
public function getPos()
{
$obj = new Vec3();
$o = $this->__offset(4);
return $o != 0 ? $obj->init($o + $this->bb_pos, $this->bb) : 0;
}
/**
* @return short
*/
public function getMana()
{
$o = $this->__offset(6);
return $o != 0 ? $this->bb->getShort($o + $this->bb_pos) : 150;
}
/**
* @return short
*/
public function getHp()
{
$o = $this->__offset(8);
return $o != 0 ? $this->bb->getShort($o + $this->bb_pos) : 100;
}
public function getName()
{
$o = $this->__offset(10);
return $o != 0 ? $this->__string($o + $this->bb_pos) : null;
}
/**
* @param int offset
* @return byte
*/
public function getInventory($j)
{
$o = $this->__offset(14);
return $o != 0 ? $this->bb->getByte($this->__vector($o) + $j * 1) : 0;
}
/**
* @return int
*/
public function getInventoryLength()
{
$o = $this->__offset(14);
return $o != 0 ? $this->__vector_len($o) : 0;
}
/**
* @return sbyte
*/
public function getColor()
{
$o = $this->__offset(16);
return $o != 0 ? $this->bb->getSbyte($o + $this->bb_pos) : \MyGame\Example\Color::Blue;
}
/**
* @return byte
*/
public function getTestType()
{
$o = $this->__offset(18);
return $o != 0 ? $this->bb->getByte($o + $this->bb_pos) : \MyGame\Example\Any::NONE;
}
/**
* @returnint
*/
public function getTest($obj)
{
$o = $this->__offset(20);
return $o != 0 ? $this->__union($obj, $o) : null;
}
/**
* @returnVectorOffset
*/
public function getTest4($j)
{
$o = $this->__offset(22);
$obj = new Test();
return $o != 0 ? $obj->init($this->__vector($o) + $j *4, $this->bb) : null;
}
/**
* @return int
*/
public function getTest4Length()
{
$o = $this->__offset(22);
return $o != 0 ? $this->__vector_len($o) : 0;
}
/**
* @param int offset
* @return string
*/
public function getTestarrayofstring($j)
{
$o = $this->__offset(24);
return $o != 0 ? $this->__string($this->__vector($o) + $j * 4) : 0;
}
/**
* @return int
*/
public function getTestarrayofstringLength()
{
$o = $this->__offset(24);
return $o != 0 ? $this->__vector_len($o) : 0;
}
/// an example documentation comment: this will end up in the generated code
/// multiline too
/**
* @returnVectorOffset
*/
public function getTestarrayoftables($j)
{
$o = $this->__offset(26);
$obj = new Monster();
return $o != 0 ? $obj->init($this->__indirect($this->__vector($o) + $j * 4), $this->bb) : null;
}
/**
* @return int
*/
public function getTestarrayoftablesLength()
{
$o = $this->__offset(26);
return $o != 0 ? $this->__vector_len($o) : 0;
}
public function getEnemy()
{
$obj = new Monster();
$o = $this->__offset(28);
return $o != 0 ? $obj->init($o + $this->bb_pos, $this->bb) : 0;
}
/**
* @param int offset
* @return byte
*/
public function getTestnestedflatbuffer($j)
{
$o = $this->__offset(30);
return $o != 0 ? $this->bb->getByte($this->__vector($o) + $j * 1) : 0;
}
/**
* @return int
*/
public function getTestnestedflatbufferLength()
{
$o = $this->__offset(30);
return $o != 0 ? $this->__vector_len($o) : 0;
}
public function getTestempty()
{
$obj = new Stat();
$o = $this->__offset(32);
return $o != 0 ? $obj->init($o + $this->bb_pos, $this->bb) : 0;
}
/**
* @return bool
*/
public function getTestbool()
{
$o = $this->__offset(34);
return $o != 0 ? $this->bb->getBool($o + $this->bb_pos) : false;
}
/**
* @return int
*/
public function getTesthashs32Fnv1()
{
$o = $this->__offset(36);
return $o != 0 ? $this->bb->getInt($o + $this->bb_pos) : 0;
}
/**
* @return uint
*/
public function getTesthashu32Fnv1()
{
$o = $this->__offset(38);
return $o != 0 ? $this->bb->getUint($o + $this->bb_pos) : 0;
}
/**
* @return long
*/
public function getTesthashs64Fnv1()
{
$o = $this->__offset(40);
return $o != 0 ? $this->bb->getLong($o + $this->bb_pos) : 0;
}
/**
* @return ulong
*/
public function getTesthashu64Fnv1()
{
$o = $this->__offset(42);
return $o != 0 ? $this->bb->getUlong($o + $this->bb_pos) : 0;
}
/**
* @return int
*/
public function getTesthashs32Fnv1a()
{
$o = $this->__offset(44);
return $o != 0 ? $this->bb->getInt($o + $this->bb_pos) : 0;
}
/**
* @return uint
*/
public function getTesthashu32Fnv1a()
{
$o = $this->__offset(46);
return $o != 0 ? $this->bb->getUint($o + $this->bb_pos) : 0;
}
/**
* @return long
*/
public function getTesthashs64Fnv1a()
{
$o = $this->__offset(48);
return $o != 0 ? $this->bb->getLong($o + $this->bb_pos) : 0;
}
/**
* @return ulong
*/
public function getTesthashu64Fnv1a()
{
$o = $this->__offset(50);
return $o != 0 ? $this->bb->getUlong($o + $this->bb_pos) : 0;
}
/**
* @param int offset
* @return bool
*/
public function getTestarrayofbools($j)
{
$o = $this->__offset(52);
return $o != 0 ? $this->bb->getBool($this->__vector($o) + $j * 1) : 0;
}
/**
* @return int
*/
public function getTestarrayofboolsLength()
{
$o = $this->__offset(52);
return $o != 0 ? $this->__vector_len($o) : 0;
}
/**
* @param FlatBufferBuilder $builder
* @return void
*/
public static function startMonster(FlatBufferBuilder $builder)
{
$builder->StartObject(25);
}
/**
* @param FlatBufferBuilder $builder
* @return Monster
*/
public static function createMonster(FlatBufferBuilder $builder, $pos, $mana, $hp, $name, $inventory, $color, $test_type, $test, $test4, $testarrayofstring, $testarrayoftables, $enemy, $testnestedflatbuffer, $testempty, $testbool, $testhashs32_fnv1, $testhashu32_fnv1, $testhashs64_fnv1, $testhashu64_fnv1, $testhashs32_fnv1a, $testhashu32_fnv1a, $testhashs64_fnv1a, $testhashu64_fnv1a, $testarrayofbools)
{
$builder->startObject(25);
self::addPos($builder, $pos);
self::addMana($builder, $mana);
self::addHp($builder, $hp);
self::addName($builder, $name);
self::addInventory($builder, $inventory);
self::addColor($builder, $color);
self::addTestType($builder, $test_type);
self::addTest($builder, $test);
self::addTest4($builder, $test4);
self::addTestarrayofstring($builder, $testarrayofstring);
self::addTestarrayoftables($builder, $testarrayoftables);
self::addEnemy($builder, $enemy);
self::addTestnestedflatbuffer($builder, $testnestedflatbuffer);
self::addTestempty($builder, $testempty);
self::addTestbool($builder, $testbool);
self::addTesthashs32Fnv1($builder, $testhashs32_fnv1);
self::addTesthashu32Fnv1($builder, $testhashu32_fnv1);
self::addTesthashs64Fnv1($builder, $testhashs64_fnv1);
self::addTesthashu64Fnv1($builder, $testhashu64_fnv1);
self::addTesthashs32Fnv1a($builder, $testhashs32_fnv1a);
self::addTesthashu32Fnv1a($builder, $testhashu32_fnv1a);
self::addTesthashs64Fnv1a($builder, $testhashs64_fnv1a);
self::addTesthashu64Fnv1a($builder, $testhashu64_fnv1a);
self::addTestarrayofbools($builder, $testarrayofbools);
$o = $builder->endObject();
$builder->required($o, 10); // name
return $o;
}
/**
* @param FlatBufferBuilder $builder
* @param int
* @return void
*/
public static function addPos(FlatBufferBuilder $builder, $pos)
{
$builder->addStructX(0, $pos, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param short
* @return void
*/
public static function addMana(FlatBufferBuilder $builder, $mana)
{
$builder->addShortX(1, $mana, 150);
}
/**
* @param FlatBufferBuilder $builder
* @param short
* @return void
*/
public static function addHp(FlatBufferBuilder $builder, $hp)
{
$builder->addShortX(2, $hp, 100);
}
/**
* @param FlatBufferBuilder $builder
* @param StringOffset
* @return void
*/
public static function addName(FlatBufferBuilder $builder, $name)
{
$builder->addOffsetX(3, $name, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param VectorOffset
* @return void
*/
public static function addInventory(FlatBufferBuilder $builder, $inventory)
{
$builder->addOffsetX(5, $inventory, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param array offset array
* @return int vector offset
*/
public static function createInventoryVector(FlatBufferBuilder $builder, array $data)
{
$builder->startVector(1, count($data), 1);
for ($i = count($data) - 1; $i >= 0; $i--) {
$builder->addByte($data[$i]);
}
return $builder->endVector();
}
/**
* @param FlatBufferBuilder $builder
* @param int $numElems
* @return void
*/
public static function startInventoryVector(FlatBufferBuilder $builder, $numElems)
{
$builder->startVector(1, $numElems, 1);
}
/**
* @param FlatBufferBuilder $builder
* @param sbyte
* @return void
*/
public static function addColor(FlatBufferBuilder $builder, $color)
{
$builder->addSbyteX(6, $color, 8);
}
/**
* @param FlatBufferBuilder $builder
* @param byte
* @return void
*/
public static function addTestType(FlatBufferBuilder $builder, $testType)
{
$builder->addByteX(7, $testType, 0);
}
public static function addTest(FlatBufferBuilder $builder, $offset)
{
$builder->addOffsetX(8, $offset, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param VectorOffset
* @return void
*/
public static function addTest4(FlatBufferBuilder $builder, $test4)
{
$builder->addOffsetX(9, $test4, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param array offset array
* @return int vector offset
*/
public static function createTest4Vector(FlatBufferBuilder $builder, array $data)
{
$builder->startVector(4, count($data), 2);
for ($i = count($data) - 1; $i >= 0; $i--) {
$builder->addOffset($data[$i]);
}
return $builder->endVector();
}
/**
* @param FlatBufferBuilder $builder
* @param int $numElems
* @return void
*/
public static function startTest4Vector(FlatBufferBuilder $builder, $numElems)
{
$builder->startVector(4, $numElems, 2);
}
/**
* @param FlatBufferBuilder $builder
* @param VectorOffset
* @return void
*/
public static function addTestarrayofstring(FlatBufferBuilder $builder, $testarrayofstring)
{
$builder->addOffsetX(10, $testarrayofstring, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param array offset array
* @return int vector offset
*/
public static function createTestarrayofstringVector(FlatBufferBuilder $builder, array $data)
{
$builder->startVector(4, count($data), 4);
for ($i = count($data) - 1; $i >= 0; $i--) {
$builder->addOffset($data[$i]);
}
return $builder->endVector();
}
/**
* @param FlatBufferBuilder $builder
* @param int $numElems
* @return void
*/
public static function startTestarrayofstringVector(FlatBufferBuilder $builder, $numElems)
{
$builder->startVector(4, $numElems, 4);
}
/**
* @param FlatBufferBuilder $builder
* @param VectorOffset
* @return void
*/
public static function addTestarrayoftables(FlatBufferBuilder $builder, $testarrayoftables)
{
$builder->addOffsetX(11, $testarrayoftables, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param array offset array
* @return int vector offset
*/
public static function createTestarrayoftablesVector(FlatBufferBuilder $builder, array $data)
{
$builder->startVector(4, count($data), 4);
for ($i = count($data) - 1; $i >= 0; $i--) {
$builder->addOffset($data[$i]);
}
return $builder->endVector();
}
/**
* @param FlatBufferBuilder $builder
* @param int $numElems
* @return void
*/
public static function startTestarrayoftablesVector(FlatBufferBuilder $builder, $numElems)
{
$builder->startVector(4, $numElems, 4);
}
/**
* @param FlatBufferBuilder $builder
* @param int
* @return void
*/
public static function addEnemy(FlatBufferBuilder $builder, $enemy)
{
$builder->addOffsetX(12, $enemy, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param VectorOffset
* @return void
*/
public static function addTestnestedflatbuffer(FlatBufferBuilder $builder, $testnestedflatbuffer)
{
$builder->addOffsetX(13, $testnestedflatbuffer, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param array offset array
* @return int vector offset
*/
public static function createTestnestedflatbufferVector(FlatBufferBuilder $builder, array $data)
{
$builder->startVector(1, count($data), 1);
for ($i = count($data) - 1; $i >= 0; $i--) {
$builder->addByte($data[$i]);
}
return $builder->endVector();
}
/**
* @param FlatBufferBuilder $builder
* @param int $numElems
* @return void
*/
public static function startTestnestedflatbufferVector(FlatBufferBuilder $builder, $numElems)
{
$builder->startVector(1, $numElems, 1);
}
/**
* @param FlatBufferBuilder $builder
* @param int
* @return void
*/
public static function addTestempty(FlatBufferBuilder $builder, $testempty)
{
$builder->addOffsetX(14, $testempty, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param bool
* @return void
*/
public static function addTestbool(FlatBufferBuilder $builder, $testbool)
{
$builder->addBoolX(15, $testbool, false);
}
/**
* @param FlatBufferBuilder $builder
* @param int
* @return void
*/
public static function addTesthashs32Fnv1(FlatBufferBuilder $builder, $testhashs32Fnv1)
{
$builder->addIntX(16, $testhashs32Fnv1, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param uint
* @return void
*/
public static function addTesthashu32Fnv1(FlatBufferBuilder $builder, $testhashu32Fnv1)
{
$builder->addUintX(17, $testhashu32Fnv1, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param long
* @return void
*/
public static function addTesthashs64Fnv1(FlatBufferBuilder $builder, $testhashs64Fnv1)
{
$builder->addLongX(18, $testhashs64Fnv1, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param ulong
* @return void
*/
public static function addTesthashu64Fnv1(FlatBufferBuilder $builder, $testhashu64Fnv1)
{
$builder->addUlongX(19, $testhashu64Fnv1, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param int
* @return void
*/
public static function addTesthashs32Fnv1a(FlatBufferBuilder $builder, $testhashs32Fnv1a)
{
$builder->addIntX(20, $testhashs32Fnv1a, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param uint
* @return void
*/
public static function addTesthashu32Fnv1a(FlatBufferBuilder $builder, $testhashu32Fnv1a)
{
$builder->addUintX(21, $testhashu32Fnv1a, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param long
* @return void
*/
public static function addTesthashs64Fnv1a(FlatBufferBuilder $builder, $testhashs64Fnv1a)
{
$builder->addLongX(22, $testhashs64Fnv1a, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param ulong
* @return void
*/
public static function addTesthashu64Fnv1a(FlatBufferBuilder $builder, $testhashu64Fnv1a)
{
$builder->addUlongX(23, $testhashu64Fnv1a, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param VectorOffset
* @return void
*/
public static function addTestarrayofbools(FlatBufferBuilder $builder, $testarrayofbools)
{
$builder->addOffsetX(24, $testarrayofbools, 0);
}
/**
* @param FlatBufferBuilder $builder
* @param array offset array
* @return int vector offset
*/
public static function createTestarrayofboolsVector(FlatBufferBuilder $builder, array $data)
{
$builder->startVector(1, count($data), 1);
for ($i = count($data) - 1; $i >= 0; $i--) {
$builder->addBool($data[$i]);
}
return $builder->endVector();
}
/**
* @param FlatBufferBuilder $builder
* @param int $numElems
* @return void
*/
public static function startTestarrayofboolsVector(FlatBufferBuilder $builder, $numElems)
{
$builder->startVector(1, $numElems, 1);
}
/**
* @param FlatBufferBuilder $builder
* @return int table offset
*/
public static function endMonster(FlatBufferBuilder $builder)
{
$o = $builder->endObject();
$builder->required($o, 10); // name
return $o;
}
public static function finishMonsterBuffer(FlatBufferBuilder $builder, $offset)
{
$builder->finish($offset, "MONS");
}
}