/ 
App-Context-0.968
River stage one • 2 direct dependents • 2 total dependents
/ App::Serializer

NAME

App::Serializer - Interface for serialization and deserialization

SYNOPSIS

use App;

$context = App->context();
$serializer = $context->service("Serializer");  # or ...
$serializer = $context->serializer();
$data = {
    an => 'arbitrary',
    collection => [ 'of', 'data', ],
    of => {
        arbitrary => 'depth',
    },
};
$serialized_data = $serializer->serialize($data);
$data = $serializer->deserialize($serialized_data);
print $serializer->dump($data), "\n";

DESCRIPTION

A Serializer is a means by which a structure of data of arbitrary depth may be serialized or deserialized.

Serializers may be used for configuration files, data persistence, or transmission of data across a network.

Serializers include the ability to compress, encrypt, and/or MIME the serialized data. (These are all scalar-to-scalar transformations.)

Class Group: Serializer

The following classes might be a part of the Serializer Class Group.

  • Class: App::Serializer

  • Class: App::Serializer::Storable

  • Class: App::Serializer::XMLSimple

  • Class: App::Serializer::XML

  • Class: App::Serializer::Ini

  • Class: App::Serializer::Properties

Class: App::Serializer

A Serializer serves to serialize and deserialize perl data structures of arbitrary depth. The base class serializes the data as Perl code using Data::Dumper. (This behavior is overridden with customized serialization techniques by the derived subclasses.)

* Throws: App::Exception::Serializer
* Since:  0.01

Class Design

The class is entirely made up of static (class) methods. However, they are each intended to be called as methods on the instance itself.

Constructor Methods:

new()

The constructor is inherited from App::Service.

Public Methods:

serialize()

* Signature: $serialized_data = $serializer->serialize($data);
* Param:     $data              ref
* Return:    $serialized_data   binary
* Throws:    App::Exception::Serializer
* Since:     0.01

Sample Usage: 

$context = App->context();
$serializer = $context->service("Serializer");  # or ...
$serializer = $context->serializer();
$data = {
    an => 'arbitrary',
    collection => [ 'of', 'data', ],
    of => {
        arbitrary => 'depth',
    },
};
$serialized_data = $serializer->serialize($data);

deserialize()

* Signature: $serialized_data = $serializer->deserialize($data);
* Signature: $serialized_data = App::Serializer->deserialize($data);
* Param:     $data              ref
* Return:    $serialized_data   binary
* Throws:    App::Exception::Serializer
* Since:     0.01

Sample Usage: 

$context = App->context();
$serializer = $context->service("Serializer");  # or ...
$serializer = $context->serializer();
$data = $serializer->deserialize($serialized_data);
print $serializer->dump($data), "\n";

serialized_content_type()

* Signature: $serialized_content_type = $service->serialized_content_type();
* Param:     void
* Return:    $serialized_content_type   string
* Throws:    App::Exception
* Since:     0.01

Sample Usage: 

$serialized_content_type = $service->serialized_content_type();

dump()

* Signature: $perl = $serializer->dump($data);
* Param:     $data      ref
* Return:    $perl      text
* Throws:    App::Exception::Serializer
* Since:     0.01

Sample Usage: 

$context = App->context();
$serializer = $context->service("Serializer");  # or ...
$serializer = $context->serializer();
$data = $serializer->deserialize($serialized_data);
print $serializer->dump($data), "\n";

Protected Methods:

service_type()

Returns 'Serializer';

* Signature: $service_type = App::Serializer->service_type();
* Param:     void
* Return:    $service_type  string
* Since:     0.01

$service_type = $serializer->service_type();

ACKNOWLEDGEMENTS

* Author:  Stephen Adkins <spadkins@gmail.com>
* License: This is free software. It is licensed under the same terms as Perl itself.

SEE ALSO

App::Context, App::Service