transformers.md

currentMenu
transformers

Transformers are classes that transform the data before it is stored or retrieved.

They can be used on top of another storage like so:

$storage = new JsonEncoder(
    new FileStorage('data.json')
);

$storage->setData('Hello World!');
echo $storage->getData();

JsonEncoder

Encodes data from and to JSON.

$storage = new JsonEncoder($anotherStorage);

If $pretty is true, then the JSON will be formatted to be human readable (false by default).

YamlEncoder

Encodes data from and to YAML.

$storage = new YamlEncoder($anotherStorage);

To use this transformer, you will need to install the Symfony\YAML component:

composer require symfony/yaml

ObjectArrayMapper

Maps objects to arrays and vice-versa.

$storage = new ObjectArrayMapper($anotherStorage, 'MyClass');

class MyClass {
    private $foo = 'Hello';
}

// Will be serialized to
array(
    'foo' => 'Hello'
);

On storage, the mapper will extract all the object's properties (including protected and privates) and put them into an array.

On retrieval, it will create a new instance of the class (without calling the constructor) and restore the properties values from the array.

AesEncrypter

Encrypts and decrypts data using AES encryption.

$encrypter = new Crypt_AES(CRYPT_AES_MODE_CBC);
$encrypter->setKey($encryptionKey);

$storage = new AesEncrypter($anotherStorage, $encrypter);

// Same as above:
$storage = AesEncrypter::createDefault($anotherStorage, $encryptionKey);

Remember to store the encryption key securely!

To use this transformer, you will need to install the phpseclib:

composer require phpseclib/phpseclib