eggbe/compact

This package is abandoned and no longer maintained. No replacement package was suggested.

Universal object packer and unpacker

dev-master 2021-08-05 01:57 UTC

Requires

• php: >=7.2.0
• able/helpers: dev-master
• able/prototypes: dev-master
• able/statics: dev-master
• eggbe/utilities: dev-master

MIT

• hacpaka

• serialization
• packer
• unpacker
• compactor

README

This is the lightweight and high-performance library provides the simple way to transfer any objects or arrays between two applications.

Requirements

• PHP >= 7.2.0
• Eggbe/Utilities
• Able/Helpers
• Able/Prototype

Install

Here's the simpler way to install the Eggbe/Compact package via composer:

composer require eggbe/compact

Usage

Now we can use the library features anywhere in the code:

$SerializedDataArray = Compactor::compact($OriginalDataArray, $FlagsCombination);

The binary flags combination define the library behavior in contentious cases. Currently only two flags are supported: Compactor::CO_STRICT and Compactor::CO_ALLOW_ARRAYABLE. The Compactor::CO_STRICT flag is always set by default.

In the strict mode the library requires that all objects implement the \Able\Prototypes\IPresentable interface defined in the Able/Prototypes package. This interface provides an universal way to present an object as an array by the simple implementation of IPresentable::present() method.

In other case when the Compactor::CO_ALLOW_ARRAYABLE flag is provided and an object don't implement the \Able\Prototypes\IPresentable interface then the library tries to convert this object into an array via toArray() method. If this method don't exists an exception will be thrown.

The following code is return data back from the serialized representation:

$OriginalDataArray = Compactor::decompact($SerializedDataArray, $Aliaser);

The library requires that all restorable objects implement the \Able\Prototypes\IRestorable interface defined in the Able/Prototypes package. This interface provides an universal way to create an object and fill its with data by the simple implementation of IRestorable constructor.

Sometimes it's important to make class overloading during the deserialization process. The second parameter of the Compactor::decompact() provids the simplest way to do it. Please, see the Aliaser component documentation for more information.

License

This package is released under the MIT license.