CMS  Version 3.9
SimpleSerializationHandler Class Reference

Provides a simple implementation of a SerializationHandler that can serialize a single DataItem class. More...

Public Member Functions

 __construct ($class, $constraint="")
 Creates a new SimpleSerializationHandler. More...
 
 export ()
 Exports the DataItems to XML. More...
 
 import ($doc, $tx)
 Imports the DataItems from XML. More...
 

Public Attributes

 $class
 
 $constraint
 

Detailed Description

Provides a simple implementation of a SerializationHandler that can serialize a single DataItem class.

Author
Andy Green

Definition at line 391 of file serialization_manager.inc.

Constructor & Destructor Documentation

◆ __construct()

SimpleSerializationHandler::__construct (   $class,
  $constraint = "" 
)

Creates a new SimpleSerializationHandler.

Parameters
string$classthe target DataItem class
string$constraintoptional database constraint to use when exporting

Definition at line 401 of file serialization_manager.inc.

402  {
403  $this->class = $class;
404 
405  if ($constraint)
406  {
407  $this->constraint = $constraint;
408  }
409  else
410  {
411  $obj = new $class;
412  $this->constraint = "ORDER BY ".$obj->getPrimaryKey();
413  }
414  }

Member Function Documentation

◆ export()

SimpleSerializationHandler::export ( )

Exports the DataItems to XML.

Returns
string the serialized XML representation

Definition at line 420 of file serialization_manager.inc.

421  {
422  return SerializationManager::serialize($this->class, $this->constraint);
423  }
static serialize($class, $constraint="")
Serializes the specified DataItems to XML.

◆ import()

SimpleSerializationHandler::import (   $doc,
  $tx 
)

Imports the DataItems from XML.

Parameters
DOMDocument$docthe source XML document
DataTransaction$txThe database transaction to join when creating imported objects

Definition at line 430 of file serialization_manager.inc.

431  {
432  global $process;
433  SerializationManager::unserialize($this->class, $doc, $tx);
434  if ($process)
435  {
436  $process->setProgress("Completed", "Import successful", 100);
437  }
438  }
static unserialize($class, $doc, $tx, $save=true)
Instantiates DataItems from the supplied XML document and stores them in the database.
$process
Definition: run.php:54

Member Data Documentation

◆ $class

SimpleSerializationHandler::$class

Definition at line 393 of file serialization_manager.inc.

◆ $constraint

SimpleSerializationHandler::$constraint

Definition at line 394 of file serialization_manager.inc.


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