pecl/ion

About:#

PHP extension wrapping amzn/ion-c. See the Amazon ION specification.

License:#

BSD-2-Clause; see spdx.org.

Installation:#

PECL and PHARext is WIP.

Dependencies:#

Required:#

• PHP-8.1
  • ext/date (standard)
  • ext/spl (standard)

Optional:#

• amzn/ion-c (bundled as git submodule)

Trinity:#

phpize
./configure
make # -j$(nproc)
sudo make install # INSTALL=install

Try with Docker:#

docker build -t php-ion
docker run --rm php-ion -r 'echo ion\serialize(ion\Symbol\Table\PHP());'

Editor Stub:#

See ion.stub.php.

Known Issues:#

Due to private internal state of ion-c's readers and writers, instances of the following PHP classes cannot be cloned:

• ion\Reader\Reader
• ion\Writer\Writer
• ion\Serializer\PHP
• ion\Unserializer\PHP

Editor Stub:

This extension provides a stub file four your editor's auto-completion.

Functions:

• serialize

  Serialize a PHP value as ION data.

  string ion\serialize(mixed $data, [?ion\Serializer $serializer = NULL])

• unserialize

  Unserialize ION data (stream) as PHP value(s).

  mixed ion\unserialize(string|resource $data, [?ion\Unserializer $unserializer = NULL])

Namespaces, Interfaces and Classes:

• Catalog

  The Catalog holds a collection of ion\Symbol\Table instances queried from ion\Reader and ion\Writer instances.

  class ion\Catalog implements Countable

• Decimal

  An arbitrary precision fixed point decimal.

  class ion\Decimal implements Stringable

• Exception

  Base exception for the ION extension.

  class ion\Exception extends Exception implements Stringable, Throwable

• LOB

  A large object.

  class ion\LOB

• Reader

  ION reader API.

  interface ion\Reader implements Iterator, RecursiveIterator, Traversable

• Serializer

  Serializer interface, used to customize ion\serialize()'s behavior.

  interface ion\Serializer

• Symbol

  class ion\Symbol implements Stringable

• Timestamp

  An ION Timestamp.

  class ion\Timestamp extends DateTime implements DateTimeInterface, Stringable

• Type

  ION data type.

  enum ion\Type implements BackedEnum, UnitEnum

• Unserializer

  Unserializer interface, used to customize ion\unserialize()'s behavior.

  interface ion\Unserializer

• Writer

  ION writer API.

  interface ion\Writer