class.Formatter.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.Formatter.php 1462 2014-02-04 23:52:27Z iherwig $
 */
require_once(BASE."wcmf/lib/util/class.ObjectFactory.php");

/**
 * @class Formatter
 * @ingroup Format
 * @brief Formatter is is the single entry point for request/response formatting.
 * It chooses the configured formatter based on the format property of the message
 * by getting the value XXXFormat from the configuration section 'implementation'.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class Formatter
{
  /**
   * Deserialize Request data into objects.
   * @note UTF-8 encoded request data is decoded automatically
   * @param request A reference to the Request instance
   */
  function deserialize(&$request)
  {
    // get the formatter that should be used for this request format
    $format = $request->getFormat();
    if ($format == null || strlen($format) == 0)
    {
      // default to html (POST/GET variables) format
      $format = MSG_FORMAT_HTML;
    }
    $objectFactory = &ObjectFactory::getInstance();
    $formatter = &$objectFactory->createInstanceFromConfig('implementation', $format.'Format');
    if ($formatter === null)
      WCMFException::throwEx($objectFactory->getErrorMsg()."\nRequest: ".$request->toString(), __FILE__, __LINE__);

    $formatter->deserialize($request);
  }
  /**
   * Serialize Response according to the output format.
   * @param response A reference to the Response instance
   */
  function serialize(&$response)
  {
    // get the formatter that should be used for this response format
    $format = $response->getFormat();
    if ($format == null)
    {
      // the response format must be given!
      WCMFException::throwEx("No response format defined for ".$response->toString(), __FILE__, __LINE__);
    }
    $objectFactory = &ObjectFactory::getInstance();
    $formatter = &$objectFactory->createInstanceFromConfig('implementation', $format.'Format');
    if ($formatter === null)
      WCMFException::throwEx($objectFactory->getErrorMsg()."\nResponse: ".$response->toString(), __FILE__, __LINE__);
    $formatter->serialize($response);
  }
}
?>