class.NodeRDBMapper.php

Go to the documentation of this file.

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2014 wemove digital solutions GmbH
 *
 * Licensed under the terms of any of the following licenses
 * at your choice:
 *
 * - GNU Lesser General Public License (LGPL)
 *   http://www.gnu.org/licenses/lgpl.html
 * - Eclipse Public License (EPL)
 *   http://www.eclipse.org/org/documents/epl-v10.php
 *
 * See the license.txt file distributed with this work for
 * additional information.
 *
 * $Id: class.NodeRDBMapper.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/model/mapper/class.RDBMapper.php");
require_once(BASE."wcmf/lib/persistence/class.PersistenceFacade.php");
require_once(BASE."wcmf/lib/persistence/converter/class.DataConverter.php");
require_once(BASE."wcmf/lib/model/class.Node.php");

/**
 * @class NodeRDBMapper
 * @ingroup Mapper
 * @brief NodeRDBMapper maps Node objects to a relational database schema where each Node
 * type has its own table.
 * It defines a persistence mechanism that specialized mappers customize by overriding
 * the given template methods.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class NodeRDBMapper extends RDBMapper
{
  /**
   * @see RDBMapper::createObject()
   */
  function &createObject($oid=null)
  {
    return new Node($this->getType(), $oid);
  }
  /**
   * @see RDBMapper::appendObject()
   */
  function appendObject(&$object, &$dependendObject)
  {
    $object->addChild($dependendObject);
  }
  /**
   * @see RDBMapper::applyDataOnLoad()
   */
  function applyDataOnLoad(&$object, $objectData, $attribs)
  {
    // we expect only one result row
    $objectData['_data'] = $objectData['_data'];

    // set parent oids
    $i = 0;
    $parentoids = array();
    while (array_key_exists('pid'.$i, $objectData['_data']))
    {
      if ($objectData['_data'][('pid'.$i)] !== null)
      {
        $parentoid = PersistenceFacade::composeOID(array('type' => $objectData['_data'][('ptype'.$i)], 'id' => array($objectData['_data'][('pid'.$i)])));
        array_push($parentoids, $parentoid);
      }
      $i++;
    }
    $object->setProperty('parentoids', $parentoids);

    // set object data
    foreach($objectData['_datadef'] as $dataItem)
    {
      if ($attribs == null || in_array($dataItem['name'], $attribs))
      {
        $value = $objectData['_data'][$dataItem['name']];
        if (!is_null($value))
          $value = $this->_dataConverter->convertStorageToApplication($value, $dataItem['db_data_type'], $dataItem['name']);
        $object->setValue($dataItem['name'], $value, $dataItem['app_data_type']);
        $valueProperties = array();
        foreach($dataItem as $key => $value)
          if ($key != 'name' && $key != 'app_data_type')
            $valueProperties[$key] = $value;
        $object->setValueProperties($dataItem['name'], $valueProperties, $dataItem['app_data_type']);
      }
    }
  }
  /**
   * @see RDBMapper::applyDataOnCreate()
   */
  function applyDataOnCreate(&$object, $objectData, $attribs)
  {
    // set parent oids
    $parentoids = array();
    foreach($objectData['_parents'] as $parentDef)
    {
      $parentoid = PersistenceFacade::composeOID(array('type' => $parentDef['type'], 'id' => array(PersistenceFacade::getDummyId())));
      array_push($parentoids, $parentoid);
    }
    $object->setProperty('parentoids', $parentoids);

    // set object data
    foreach($objectData['_datadef'] as $dataItem)
    {
      if ($attribs == null || in_array($dataItem['name'], $attribs))
      {
        // don't override dummy ids
        if (!$this->isPkValue($dataItem['name'], $dataItem['app_data_type']))
        {
          $value = $this->_dataConverter->convertStorageToApplication($dataItem['default'], $dataItem['db_data_type'], $dataItem['name']);
          $object->setValue($dataItem['name'], $value, $dataItem['app_data_type']);
        }
        $valueProperties = array();
        foreach($dataItem as $key => $value)
          if ($key != 'name' && $key != 'app_data_type')
            $valueProperties[$key] = $value;
        $object->setValueProperties($dataItem['name'], $valueProperties, $dataItem['app_data_type']);
      }
    }
  }
  /**
   * @see RDBMapper::getObjectDefinition()
   *
   * The _datadef key holds the following structure:
   *
   * An array of assoziative arrays with the keys 'name', 'app_data_type' plus application specific keys for every data item.
   * All keys except 'name' and 'app_data_type' will become keys in the objects valueProperties array hold for each data item while 'name'
   * and 'app_data_type' are used to identify the values, see PersistentObject::getValue().
   * (e.g. array('name' => 'title', 'db_data_type' => 'VARCHAR(255)', 'app_data_type' => DATATYPE_ATTRIBUTE, 'default' => 'Hello World!')) @n
   * Known keys are:
   * - @em db_data_type: The database data type of the attribute. This may be used to decide on value conversions in the assoziated DataConverter class
   * - @em default: The default value (will be set when creating a blank object, see PersistenceMapper::create())
   * - @em restrictions_match: A regular expression that the value must match (e.g. '[0-3][0-9]\.[0-1][0-9]\.[0-9][0-9][0-9][0-9]' for date values)
   * - @em restrictions_not_match:  A regular expression that the value must NOT match
   * - @em is_editable: true, false whether the value should be editable, see FormUtil::getInputControl()
   * - @em input_type: The HTML input type for the value, see FormUtil::getInputControl()
   * - @em display_type: The HTML display type for the value, see NodeUtil::getDisplayValue()
   */
  function getObjectDefinition()
  {
    WCMFException::throwEx("getObjectDefinition() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
}
?>