git.m6w6.name Git - awesomized/ext-ion/blob - README.md

   1 # pecl/ion
   2
   3 ## About:
   4 PHP extension wrapping [amzn/ion-c](https://github.com/amzn/ion-c).
   5 See the [Amazon ION specification](https://amzn.github.io/ion-docs/).
   6
   7 ## License:
   8 [BSD-2-Clause](https://github.com/awesomized/ext-ion/blob/master/LICENSE);
   9 see [spdx.org](https://spdx.org/licenses/BSD-2-Clause.html).
  10
  11 ## Installation:
  12
  13 [PECL](https://pecl.php.net) and [PHARext](https://pharext.org) is WIP.
  14
  15 ### Dependencies:
  16 #### Required:
  17 * PHP-8.1
  18   * ext/date (standard)
  19   * ext/spl (standard)
  20 #### Optional:
  21 * [amzn/ion-c](https://github.com/amzn/ion-c) (bundled as git submodule)
  22
  23 ### Trinity:
  24 ```shell
  25 phpize
  26 ./configure
  27 make # -j$(nproc)
  28 sudo make install # INSTALL=install
  29 ```
  30 ### Try with Docker:
  31 ```shell
  32 docker build -t php-ion
  33 docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\PHP::asTable());'
  34 ```
  35
  36 ## Editor Stub:
  37 See [ion.stub.php](https://github.com/awesomized/ext-ion/blob/master/ion.stub.php).
  38
  39 ## Known Issues:
  40 Due to private internal state of ion-c's readers and writers,
  41 instances of the following PHP classes cannot be cloned:
  42 * ion\Reader\Reader
  43 * ion\Writer\Writer
  44 * ion\Serializer\PHP
  45 * ion\Unserializer\PHP