meta-serializer
Production ready simple and flexible PHP serializer and deserializer.
Support array, ArrayObject, nested objects and associative arrays.
Install
composer require meta-serializer/meta-serializerUsing
Control serialization/deserialization by phpdoc @annotations or by field-related class methods. Methods have a higher priority. Class attributes for serialization/deserialization must be public.
Serializer:
- support special phpdoc annotations:
@ignore,@ignoreNulland@renameTo(see example); - override
onRecursiveObjectReferenceDetectedif need (throws exception by default); - override
serializeValueto support additional types; - catch
MetaSerializerExceptionto detect deserialization errors.
Deserializer:
- use type from @var phpdoc (specify full class name with namespace like
\MyNamespace\MyNestedClassor\DateTime); - support special phpdoc annotations:
@ignore,@optionaland@sourceName(see example); - override
onNoValueProvidedif need (throws exception by default); - override
onNotNullableValueIsNullif need (throws exception by default); - override
deserializeValueNotNullableTypeto support additional types; -
\DateTimesupported from string (in format suatable for\DateTimeconstructor) or number (unix timestamp); - catch
MetaDeserializerExceptionto detect deserialization errors.
Example
class MyClass
{
/**
* @var int|null This is a nullable integer.
*/
public $a = 5;
/**
* Using field-related methods.
*/
public $b = "str";
protected function b__toJson(array &$data, string $prop, MetaSerializer $ser) { $data['myJsonFieldName'] = $this->b . "InJson"; }
protected function b__fromJson(array $data, string $prop, MetaDeserializer $des) { $this->b = $data['myJsonFieldName']; }
/**
* Using phpdoc annotations.
* @var string
* @toJson_ignoreNull
* @toJson_renameTo fieldC
* @fromJson_optional
* @fromJson_sourceName fieldC
*/
public $c = "thisIsC";
}
// SERIALIZATION
$serializer = new MetaSerializer("__toJson", "toJson_");
$data = $serializer->serializeObject(new MyClass());
// data: [ "a" => 5, "myJsonFieldName" => "strInJson", "fieldC" => "thisIsC" ]
// DESERIALIZATION
$deserializer = new MetaDeserializer("__fromJson", "fromJson_");
// object will be created by deserializeObject(), so
// it must has constructor with no/default parameters
$obj = $deserializer->deserializeObject($data, MyClass::class);
// obj: MyClass { a:5, b:"strInJson", c:"thisIsC" }
// manually object creating
$obj = new MyClass();
$deserializer->deserializeObjectProperties($data, $obj);
