########
Storable
########


****
NAME
****


Kernel::System::Storable - Storable wrapper functions


***********
DESCRIPTION
***********


Functions for Storable serialization / deserialization.

new()
=====


create a Storable object. Do not use it directly, instead use:


.. code-block:: perl

     my $StorableObject = $Kernel::OM->Get('Kernel::System::Storable');



Serialize()
===========


Dump a Perl data structure to an storable string.


.. code-block:: perl

     my $StoableString = $StorableObject->Serialize(
         Data => $Data,          # must be a reference,
         Sort => 1,              # optional 1 or 0, default 0
     );



Deserialize()
=============


Load a serialized storable string to a Perl data structure.


.. code-block:: perl

     my $PerlStructureScalar = $StorableObject->Deserialize(
         Data => $StorableString,
     );



Clone()
=======


Creates a deep copy a Perl data structure.


.. code-block:: perl

     my $StorableData = $StorableObject->Clone(
         Data => $Data,          # must be a reference
     );