JsonFormat.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\core\LogManager;
use wcmf\lib\model\NodeSerializer;
use wcmf\lib\presentation\format\impl\HierarchicalFormat;

/**
 * JsonFormat realizes the JSON request/response format. All data will
 * be serialized using the json_encode method except for Nodes.
 * Nodes are serialized into an array before encoding (see JsonFormat::serializeValue)
 * using the NodeSerializer class.
 * On serialization the data will be outputted directly using the print command.
 *
 * JsonFormat collects the response data from all executed controllers
 * into one response array and returns it all at once at the end of
 * script execution. This prevents from having multiple junks of json
 * from each controller response that can't be decoded by clients.
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class JsonFormat extends HierarchicalFormat {

  private static $_jsonData = array();
  private static $_jsonUsed = false;
  private static $_logger = null;

  protected $_serializer = null;

  /**
   * Constructor
   * @param $serializer NodeSerializer instance
   */
  public function __construct(NodeSerializer $serializer) {
    $this->_serializer = $serializer;
    if (self::$_logger == null) {
      self::$_logger = LogManager::getLogger(__CLASS__);
    }
  }

  public static function printJSONResult() {
    if (self::$_jsonUsed) {
      $data = self::$_jsonData;
      if ($data !== null) {
        $encoded = json_encode($data);
        if (self::$_logger->isDebugEnabled('JsonFormat')) {
          self::$_logger->debug($data, 'JsonFormat');
          self::$_logger->debug($encoded, 'JsonFormat');
        }
        print($encoded);
      }
    }
  }

  /**
   * @see Format::getMimeType()
   */
  public function getMimeType() {
    return 'application/json';
  }

  /**
   * @see HierarchicalFormat::afterSerialize()
   */
  protected function afterSerialize($values) {
    // TODO: check if merging is required for multiple actions
    /*
    // merge data into global data array
    // new values override old
    self::$_jsonData = array_merge(self::$_jsonData, $data);
     */
    self::$_jsonData = $values;
    self::$_jsonUsed = true;
    return $values;
  }

  /**
   * @see HierarchicalFormat::isSerializedNode()
   */
  protected function isSerializedNode($value) {
    return $this->_serializer->isSerializedNode($value);
  }

  /**
   * @see HierarchicalFormat::serializeNode()
   */
  protected function serializeNode($value) {
    $node = $this->_serializer->serializeNode($value);
    return $node;
  }

  /**
   * @see HierarchicalFormat::deserializeNode()
   */
  protected function deserializeNode($value) {
    $result = $this->_serializer->deserializeNode($value);
    return $result;
  }
}

// register the output method
register_shutdown_function(array(__NAMESPACE__.'\JsonFormat', 'printJSONResult'));
?>