lum/lum-ubjson

A UBJSON (draft-12) implementation

v1.0.0 2022-10-04 22:31 UTC

This package is auto-updated.

Last update: 2024-03-05 03:51:41 UTC


README

Summary

A UBJSON (draft-12) implementation.

Classes

Name Description
Lum\Encode\UBJSON The main transcoder class.

Example Usage

Quick with defaults

use Lum\Encode\UBJSON;

$encodedString = UBJSON::encode($anArrayOrObject);

$decodedArray = UBJSON::decode($encodedString);

With extra options

use Lum\Encode\UBJSON;

// Default option values shown below.
// Only include the ones you want to override.
// 'optimized' and 'draft9' are mutually exclusive.
$ubj = new UBJSON(
[
  'throw'     => true,
  'asArray'   => true,
  'optimized' => false,
  'draft9'    => false,
]);

$encodedString = $ubj->encodeValue($arrayOrObject);

$decodedArrayOrObject = $ubj->decodeValue($encodedString);

The draft9 option is kept only for compatibility with the previous UBJSON implementation that lived in the lum-encode package. It should not be used in new code.

Official URLs

This library can be found in two places:

Authors

  • Timothy Totten

License

MIT