honzabrecka/transit-php

Transit for PHP.

0.8.5 2023-11-21 08:48 UTC

Requires

• php: >=5.6.0
• nette/utils: 4.0.*

Requires (Dev)

• nette/tester: 2.5.*

MIT

• Jan Břečka

• data
• format
• transit

README

Transit is a data format and a set of libraries for conveying values between applications written in different languages. This library provides support for marshalling Transit data to/from PHP. Unlike the Java and Clojure implementations it relies on the non-streaming JSON parsing mechanism of the host PHP environment.

• Rationale
• Specification

This implementation's major.minor version number corresponds to the version of the Transit specification it supports.

NOTE: Transit is a work in progress and may evolve based on feedback. As a result, while Transit is a great option for transferring data between applications, it should not yet be used for storing data durably over time. This recommendation will change when the specification is complete.

Installation

composer require honzabrecka/transit-php

Usage

use transit\JSONReader;
use transit\JSONWriter;
use transit\Transit;
use transit\Map;

$transit = new Transit(new JSONReader(), new JSONWriter());
$transit->read('["^ ","foo","bar"]');
$transit->write(new Map(['foo', 'bar']));

You can use assoc array instead of transit\Map. It comes with a price (string keys only), therefore it's disabled by default.

use transit\JSONReader;
use transit\JSONWriter;
use transit\Transit;

$transit = new Transit(new JSONReader(true), new JSONWriter(true));
$transit->read('["^ ","foo","bar"]');
$transit->write(['foo' => 'bar']);

Default Type Mapping

Transit type	Write accepts	Read returns
null	null	null
string	string	string
boolean	bool	bool
integer	int	int
decimal	float	float
bytes	transit\Bytes	transit\Bytes
keyword	transit\Keyword	transit\Keyword
symbol	transit\Symbol	transit\Symbol
time	DateTime	DateTime
array	array	array
map	transit\Map or assoc array	transit\Map or assoc array
cmap	transit\CMap	transit\CMap
set	transit\Set	transit\Set
list	SplDoublyLinkedList	SplDoublyLinkedList
uri	transit\URI	transit\URI
uuid	transit\UUID	transit\UUID
char	transit\Char	transit\Char