class.IFormat.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.IFormat.php 1462 2014-02-04 23:52:27Z iherwig $
 */

/**
 * @class IFormat
 * @ingroup Format
 * @brief IFormat defines the interface for all formatter classes. Formatter 
 * classes are used to map external data representations like JSON, XML/SOAP or HTML 
 * to internal ones. All data values are supposed to be scalar or array values
 * except for Nodes, for which each external representation defines a special notation.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class IFormat
{
  /**
   * Deserialize Request data from the external representation into Nodes and scalars/arrays.
   * @param request A reference to the Request instance
   */
  function deserialize(&$request)
  {
    WCMFException::throwEx("deserialize() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
  /**
   * Serialize Response data according to the external representation.
   * @param response A reference to the Response instance
   */
  function serialize(&$response)
  {
    WCMFException::throwEx("serialize() must be implemented by derived class: ".get_class($this), __FILE__, __LINE__);
  }
}
?>