DefaultFormatter.php

<?php
/**
 * wCMF - wemove Content Management Framework
 * Copyright (C) 2005-2015 wemove digital solutions GmbH
 *
 * Licensed under the terms of the MIT License.
 *
 * See the LICENSE file distributed with this work for
 * additional information.
 */
namespace wcmf\lib\presentation\format\impl;

use wcmf\lib\config\ConfigurationException;
use wcmf\lib\presentation\format\Formatter;
use wcmf\lib\presentation\Request;
use wcmf\lib\presentation\Response;

/**
 * Default Formatter implementation.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class DefaultFormatter implements Formatter {

  private static $_headersSent = false;

  private $_formats = array();

  /**
   * Constructor
   * @param $formats Array of Format instances to use
   */
  public function __construct(array $formats) {
    $this->_formats = $formats;
  }

  /**
   * @see Formatter::getFormatFromMimeType()
   */
  public function getFormatFromMimeType($mimeType) {
    $firstFormat = null;
    foreach ($this->_formats as $name => $instance) {
      $firstFormat = $firstFormat == null ? $name : $firstFormat;
      if (strpos($mimeType, $instance->getMimeType()) !== false) {
        return $name;
      }
    }
    if ($firstFormat == null) {
      throw new ConfigurationException("Configuration section 'Formats' does not contain a format definition for: ".$mimeType);
    }
    return $firstFormat;
  }

  /**
   * @see Formatter::deserialize()
   */
  public function deserialize(Request $request) {
    // get the format that should be used for this request format
    $formatName = $request->getFormat();
    if (strlen($formatName) == 0) {
      // the format must be given!
      throw new ConfigurationException("No request format defined for ".$request->__toString());
    }
    $format = $this->getFormat($formatName);
    $format->deserialize($request);
  }

  /**
   * @see Formatter::serialize()
   */
  public function serialize(Response $response) {
    self::$_headersSent = headers_sent();
    self::sendHeader('HTTP/1.1 '.$response->getStatus());

    // if the response has a file, we send it and return
    $file = $response->getFile();
    if ($file) {
      self::sendHeader("Content-Type: application/octet-stream");
      self::sendHeader('Content-Disposition: attachment; filename="'.basename($file['filename']).'"');
      self::sendHeader("Pragma: no-cache");
      self::sendHeader("Expires: 0");
      echo $file['content'];
      return;
    }

    // default: delegate to response format
    $formatName = $response->getFormat();
    if (strlen($formatName) == 0) {
      // the format must be given!
      throw new ConfigurationException("No response format defined for ".$response->__toString());
    }
    $format = $this->getFormat($formatName);
    self::sendHeader("Content-Type: ".$format->getMimeType()."; charset=utf-8");
    foreach ($response->getHeaders() as $name => $value) {
      self::sendHeader($name.': '.$value);
    }
    $format->serialize($response);
  }

  /**
   * Send the given header
   * @param $header
   */
  protected function sendHeader($header) {
    if (!self::$_headersSent) {
      header($header);
    }
  }

  /**
   * Get the format with the given name
   * @param $name
   * @return Format
   */
  protected function getFormat($name) {
    if (isset($this->_formats[$name])) {
      return $this->_formats[$name];
    }
    throw new ConfigurationException("Configuration section 'Formats' does not contain a format definition with name: ".$name);
  }
}
?>