CompoundSerializationHandler Class Reference

Provides serialization for a number of DataItem classes, grouped under a common tag in the serialized XML. More...

Public Member Functions
	__construct ($groupTag)
	Creates the CompoundSerializationHandler. More...
	addTarget ($class, $constraint="")
	Add a target DataItem with optional constraint. More...
	export ()
	Exports the target DataItems to XML. More...
	import ($doc, $tx)
	Import from a serialized XML document. More...
	retrieve ($doc, $class)
	Retrieves serialized objects from the provided XML document, but does not store them in the database. More...

Public Attributes
	$groupTag
	$classes = array()
	$constraints = array()

Detailed Description

Provides serialization for a number of DataItem classes, grouped under a common tag in the serialized XML.

Use this when your component needs to serialize a number of related objects under the same transaction.

To serialize two or more items, you would create the handler like this: new ComponentSerializationHandler("GroupTag", Class1, Class2)

You can provide database constraints for export for each class by passing an array containing the class name and the constraint:

new CompoundSerializationHandler("GroupTag", array(Class1, "WHERE active=1"), Class2)

Author

Andy Green

Definition at line 456 of file serialization_manager.inc.

Constructor & Destructor Documentation

__construct()

CompoundSerializationHandler::__construct

(

$groupTag

)

Creates the CompoundSerializationHandler.

Parameters

string

$groupTag

the tag name to be used to group the XML output

Exceptions

FakoliException

Definition at line 467 of file serialization_manager.inc.

     {
          if (!$groupTag)
          {
               throw new FakoliException("No group tag specified for compound serialization handler");
          }
          
          $this->groupTag = $groupTag;
          for($i = 1; $i < func_num_args(); ++$i)
          {
               $arg = func_get_arg($i);
               if (is_array($arg))
               {
                    $this->classes[] = $arg;
               }
               else
               {
                    $this->classes[] = array($arg, "");
               }
          }
     }

Member Function Documentation

addTarget()

CompoundSerializationHandler::addTarget	(		$class,
			$constraint = ""
	)

Add a target DataItem with optional constraint.

Parameters

string	$class	the target DataItem class
string	$constraint	optional database constraint to use for export

Definition at line 494 of file serialization_manager.inc.

     {
          $this->classes[] = array($class, $constraint);
     }

export()

CompoundSerializationHandler::export

(

)

Exports the target DataItems to XML.

Returns

string the XML serialization of the objects

Definition at line 503 of file serialization_manager.inc.

     {
          $xml  = "\n<{$this->groupTag}>";
          foreach($this->classes as $class)
          {
               $xml.= SerializationManager::serialize($class[0], $class[1]);
          }
          
          $xml .= "\n</{$this->groupTag}>";
          return $xml;
     }

import()

CompoundSerializationHandler::import	(		$doc,
			$tx
	)

Import from a serialized XML document.

Parameters

DOMDocument	$doc	The document to be used as the source of the import
DataTransaction	$tx	The database transaction to join when creating imported objects

Definition at line 520 of file serialization_manager.inc.

     {
          global $process;
          
          foreach($this->classes as $class)
          {
               SerializationManager::store($class[0], $doc, $tx);
          }
          
          if ($process)
          {
               $process->setProgress("Completed", "Import successful", 100);
          }
     }

retrieve()

CompoundSerializationHandler::retrieve	(		$doc,
			$class
	)

Retrieves serialized objects from the provided XML document, but does not store them in the database.

Instead they are returned as an array so that further processing can be carried out.

Parameters

DOMDocument	$doc	The document to be used as the source of the retrieval
string	$class	The class of objects to retrieve

Returns

array an array of DataItems

Definition at line 542 of file serialization_manager.inc.

     {
          return SerializationManager::unserialize($class, $doc, null, false);
     }

Member Data Documentation

$classes

CompoundSerializationHandler::$classes = array()

Definition at line 459 of file serialization_manager.inc.

$constraints

CompoundSerializationHandler::$constraints = array()

Definition at line 460 of file serialization_manager.inc.

$groupTag

CompoundSerializationHandler::$groupTag

Definition at line 458 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