SerializationManager Class Reference

SerializationManager handles import/export of DataItems via an XML file. More...

Public Member Functions
	__construct ()
	Creates a SerializationManager, building the serialization map from the registered components via the RegisterSerializationHandler event. More...
	registerHandler ($component, $title, $handler)
	Registers a serialization handler for a component. More...
	export ($components)
	Exports data for the specified components. More...
	exportAll ()
	Export data for all registered components. More...
	import ($xml, $components)
	Imports data from the specified XML document for the specified components. More...
	importBackground ()
	importAll ($xml)
	Import data for all registered components. More...

Static Public Member Functions
static	unserialize ($class, $doc, $tx, $save=true)
	Instantiates DataItems from the supplied XML document and stores them in the database. More...
static	store ($class, $doc, $tx)
static	serialize ($class, $constraint="")
	Serializes the specified DataItems to XML. More...

Static Public Attributes
static	$map

Detailed Description

SerializationManager handles import/export of DataItems via an XML file.

This allows data to be transferred between Fakoli instances that provide the same data model (for instance, between development and production versions of the same application).

To implement serialization for your Fakoli component, add a line to your manifest specifying that you can recieve the RegisterSerializationHandler event. Your callback for this event you then use the SerializationManager::registerHandler method to register the serialization handler in charge of serializing your data model. Two standard serializers are provided - SimpleSerializationHandler will serialize a single DataItem class. CompoundSerializationHandler serializes a set of classes grouped together in the XML format under a common tag. You can provide custom serialization handlers for more complex needs (should they arise) by implementing the SerializationHandler interface and providing your own implementation.

Author

Andy Green

Definition at line 47 of file serialization_manager.inc.

Constructor & Destructor Documentation

__construct()

SerializationManager::__construct

(

)

Creates a SerializationManager, building the serialization map from the registered components via the RegisterSerializationHandler event.

Definition at line 55 of file serialization_manager.inc.

     {
          if (!SerializationManager::$map)
          {
               SerializationManager::$map = array();
               ComponentManager::fireEvent("RegisterSerializationHandler");
               asort(SerializationManager::$map);
          }
     }

Member Function Documentation

export()

SerializationManager::export

(

$components

)

Exports data for the specified components.

Parameters

string

$components

a comma-separated list of the components for which data is to be exported

Returns

string the serialized XML data representation

Definition at line 81 of file serialization_manager.inc.

     {
          global $config;
          
          $components = explode(",", $components);
 
          $default_charset = $config["default_charset"];
          if (!$default_charset) $default_charset = "iso-8859-1";
          
          $xml = "<?xml version=\"1.0\" encoding=\"{$default_charset}\"?>";
          $xml .= "\n<Fakoli>";
          
          foreach($components as $component)
          {
               $handler = SerializationManager::$map[$component]['handler'];
               $xml .= $handler->export();
          }
          
          $xml .= "\n</Fakoli>";
          return $xml;
     }

exportAll()

SerializationManager::exportAll

(

)

Export data for all registered components.

Returns

string the serialized XML data representation

Definition at line 107 of file serialization_manager.inc.

     {
          $components = implode(",", array_keys(SerializationManager::$map));
          return $this->export($components);
     }

import()

SerializationManager::import	(		$xml,
			$components
	)

Imports data from the specified XML document for the specified components.

Any other data in the XML document is ignored.

Parameters

string	$xml	the file path of the XML document containing the serialized data
string	$components	a comma-separated list of the components for which data is to be exported

Exceptions

FakoliException
Exception

Definition at line 121 of file serialization_manager.inc.

     {
          $components = explode(",", $components);
          $this->processImport($xml, $components);          
     }

importAll()

SerializationManager::importAll

(

$xml

)

Import data for all registered components.

Parameters

string

$xml

the file path of the XML document containing the serialized data

Definition at line 177 of file serialization_manager.inc.

     {
          $components = implode(",", array_keys(SerializationManager::$map));
          return $this->import($xml, $components);
     }

importBackground()

SerializationManager::importBackground

(

)

Definition at line 127 of file serialization_manager.inc.

     {
          global $process;
          if (!$process)
          {
               throw new FakoliException("Not running as a background process");
          }
          
          $xml = file_get_contents($process->get("xml_import_file_path"));
          $components = $process->get("xml_import_components");
          
          trace("Importing $components from $xml", 3);
          $process->setProgress("Running", "Starting import", 0);
          
          $components = explode(",", $components);
          $this->processImport($xml, $components);
     }

registerHandler()

SerializationManager::registerHandler	(		$component,
			$title,
			$handler
	)

Registers a serialization handler for a component.

Parameters

string	$component	the component for which the handler is being registered (i.e. "blog")
string	$title	the display title describing the data that is serialized for this component (i.e. "Blogs and Articles")
SerializationHandler	$handler	the serialization handler object providing the implementation

Definition at line 71 of file serialization_manager.inc.

     {
          SerializationManager::$map[$component] = array('title' => $title, 'handler' => $handler);
     }

serialize()

static SerializationManager::serialize (   $class,   $constraint = ""  )

static

Serializes the specified DataItems to XML.

This utility method is provided to simplify the implementation of SerializationHandlers.

Parameters

string	$class	the target DataItem class
string	$constraint	optional database constraint for the objects to be serialized

Returns

string serialized XML representation of the DataItems

Definition at line 309 of file serialization_manager.inc.

     {
          $objects = IteratedQuery::create($class, $constraint)->execute();
          return toXML($class."List", $objects, "");
     }

store()

static SerializationManager::store (   $class,   $doc,   $tx  )

static

Definition at line 259 of file serialization_manager.inc.

     {
          global $process;
          trace("== Instantiating $class Records", 3);
          
          // Check to see if there are any list tags for the class present.
          // If not, the class was not serialized in this document, so return
          // without processing. If there is a list tag (even if it is empty)
          // we continue processing. This allows for correct deletion of items
          // as part of the import process.
          
          $lists = $doc->getElementsByTagName($class . "List");
          if ($lists->length == 0) return;
          
          $nodes = $doc->getElementsByTagName($class);
          
          $count = count($nodes);  
          
          if ($process)
          {
               $process->setProgress("Running", pluralize("Reading $count {$class}", $count), 0);
          }
          
          $objects = array();
          
          $c = 0;
          
          $object = new $class;
          
          foreach($nodes as $node)
          {
               $object->fromXML($node);
               $object->_disablePK = true;
               $object->joinTransaction($tx);
               $object->save();
               ++$c;
               if ($process)
               {
                    $process->setProgress("Running", pluralize("Imported $c of $count {$class}", $count), intval((100*$c)/$count));
               }
          }         
     }

unserialize()

static SerializationManager::unserialize (   $class,   $doc,   $tx,   $save = true  )

static

Instantiates DataItems from the supplied XML document and stores them in the database.

This utility method is provided to simplify the implementation of SerializationHandlers.

Parameters

string	$class	the target DataItem class
DOMDocument	$doc	the source XML document
DataTransaction	$tx	The database transaction to join when creating imported objects
bool	$save	true to save to the database, false to just return the reconstituted objects

Definition at line 192 of file serialization_manager.inc.

     {
          global $process;
          trace("== Instantiating $class Records", 3);
          
          // Check to see if there are any list tags for the class present.
          // If not, the class was not serialized in this document, so return
          // without processing. If there is a list tag (even if it is empty)
          // we continue processing. This allows for correct deletion of items
          // as part of the import process.
          
          $lists = $doc->getElementsByTagName($class . "List");
          if ($lists->length == 0) return;
          
          $nodes = $doc->getElementsByTagName($class);
     
          $count = count($nodes);
          
          
          if ($process)
          {
               $process->setProgress("Running", pluralize("Reading $count {$class}", $count), 0);
          }
          
          $objects = array();
          
          $c = 0;
          
          foreach($nodes as $node)
          {
               $object = new $class;
               $object->fromXML($node);
               $objects[] = $object;
               ++$c;
               
               if ($process)
               {
                    $process->setProgress("Running", pluralize("Reading $c of $count {$class}", $count), intval((100*$c)/$count));
               }
               
          }
                    
          if ($save)
          {
               $o = new $class;
               $o->joinTransaction($tx);
               $o->deleteAll();
               
               $c = 0;
               
               foreach($objects as $object)
               {
                    $object->_disablePK = true;
                    $object->joinTransaction($tx);
                    $object->save();
                    ++$c;
                    if ($process)
                    {
                         $process->setProgress("Running", pluralize("Imported $c of $count {$class}", $count), intval((100*$c)/$count));
                    }
               }
          }
          
          return $objects;
     }

Member Data Documentation

$map

SerializationManager::$map

static

Definition at line 49 of file serialization_manager.inc.

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/component/serialization_manager.inc