Class::Prevayler 0.02

Class::Prevayler - aka 'Perlvayler' - is a Perl implementation of the prevayler concept.<br /><br />You can find an introduction to this concept on www.prevayler.org.<br /><br />This module overloads the 'time', 'localtime' and 'gmtime' functions to make the system deterministic.<br />USAGE ^<br />new<br /><br /> Usage : $prevayler->new()<br /> Purpose : creates a new object <br /> Returns : the new prevayler-object<br /> Argument : you can use key-value pairs to initialize the attributes<br /><br />start<br /><br /> Usage : $prevayler->start()<br /> Purpose : recovers the old system state<br /> Returns : nothing<br /> Argument : none<br /> Comments : You have to call it before you can use execute(), even if there is no old serialized state<br /><br />start<br /><br /> Usage : $prevayler->execute()<br /> Purpose : execute one command object on the system, and log it<br /> Returns : nothing<br /> Argument : command object<br /> Comments : all command objects must implement a 'execute()' method<br /><br />take_snapshot<br /><br /> Usage : $prevayler->take_snapshot()<br /> Purpose : produce a serialized image of the system <br /> Returns : nothing<br /> Argument : command object<br /> Comments : all command objects must implement a 'execute()' method<br /><br />system<br /><br /> Usage : $prevayler->system( new My::System )<br /> my $system = $prevayler->system();<br /> Purpose : access to the prevalent system <br /> Returns : returns the actual system if called without argument<br /> Argument : new prevalent system<br /><br />directory<br /><br /> Usage : $prevayler->directory( './prevayler/' )<br /> my $directory = $prevayler->directory();<br /> Purpose : sets the directory where all serialized objects are stored <br /> Returns : returns the actual directory if called without argument<br /> Argument : new directory<br /><br />serializer<br /><br /> Usage : $prevayler->serializer( &mySerializer )<br /> my $serializer = $prevayler->serializer();<br /> Purpose : define the serializer. <br /> The serializer is called with a structure (an object)<br /> and returns a string representation of this structure.<br /> The default serializer is implemented with Data::Dumper.<br /> Returns : returns the actual serializer if called without argument<br /> Argument : reference to a subroutine<br /><br />deserializer<br /><br /> Usage : $prevayler->deserializer( &myDeSerializer )<br /> my $deserializer = $prevayler->deserializer();<br /> Purpose : define the deserializer. <br /> The deserializer is called with a serialized structure<br /> and returns this structure.<br /> The default deserializer is implemented with eval.<br /> Returns : returns the actual deserializer if called without argument<br /> Argument : reference to a subroutine

Requirements:	No special requirements
Platforms:	*nix, Linux
Keyword:	Actual,  Argument,  Called,  Command,  Comments,  Deserializer,  Directory,  Object,  Objects,  Purpose,  Returns,  Serialized,  Serializer,  Structure,  System,  Usage
Users rating:	0/10