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

/**
 * Some constants describing the different message formats
 */
define("MSG_FORMAT_HTML", "HTML");
define("MSG_FORMAT_JSON", "JSON");
define("MSG_FORMAT_SOAP", "SOAP");

/**
 * @class ControllerMessage
 * @ingroup Presentation
 * @brief ControllerMessages are sent between Controllers and are used to transfer data
 * between them. ControllerMessages are dispatched by ActionMapper, which decides upon the
 * message's controller, context and action parameter to which Controller it will
 * be send.
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class ControllerMessage
{
  var $_sender = null;
  var $_context = null;
  var $_action = null;
  var $_format = null;
  var $_data = array();

  /**
   * Constructor
   * @param sender The name of the controller that sent the message
   * @param context The name of the context of the message
   * @param action The name of the action that the message initiates
   * @param data An associative array containing the message variables
   * together with their values.
   */
  function ControllerMessage($sender, $context, $action, $data)
  {
    if (func_num_args() != 4) {
      WCMFException::throwEx("Message constructor called with wrong argument number: ", __FILE__, __LINE__);
    }
    $this->_sender = $sender;
    $this->_context = $context;
    $this->_action = $action;
    $this->_data = $data;
  }

  /**
   * Set the name of the sending Controller
   * @param sender The name of the Controller
   */
  function setSender($sender)
  {
    $this->_sender = $sender;
  }

  /**
   * Get the name of the sending Controller
   * @return The name of the Controller
   */
  function getSender()
  {
    return $this->_sender;
  }

  /**
   * Set the name of the context
   * @param context The name of the context
   */
  function setContext($context)
  {
    $this->_context = $context;
  }

  /**
   * Get the name of the context
   * @return The name of the context
   */
  function getContext()
  {
    return $this->_context;
  }

  /**
   * Set the name of the action
   * @param action The name of the action
   */
  function setAction($action)
  {
    $this->_action = $action;
  }

  /**
   * Get the name of the action
   * @return The name of the action
   */
  function getAction()
  {
    return $this->_action;
  }

  /**
   * Set the message format
   * @param format One of the MSG_FORMAT constants
   */
  function setFormat($format)
  {
    $this->_format = $format;
  }

  /**
   * Get the message format
   * @return format One of the MSG_FORMAT constants
   */
  function getFormat()
  {
    return $this->_format;
  }

  /**
   * Set a value
   * @param name The name of the variable
   * @param value The value of the variable
   */
  function setValue($name, $value)
  {
    $this->_data[$name] = $value;
  }

  /**
   * Append a value
   * @param name The name of the variable
   * @param value The value to append to the variable
   */
  function appendValue($name, $value)
  {
    $this->_data[$name] .= $value;
  }

  /**
   * Check for existance of a value
   * @param name The name of the variable
   * @return True/False wether the value exists or not exist
   */
  function hasValue($name)
  {
    return array_key_exists($name, $this->_data);
  }

  /**
   * Get a value
   * @param name The name of the variable
   * @param default The default value if the value is not defined [default: null]
   * @return The value or default, if it does not exist
   */
  function getValue($name, $default=null)
  {
    if (!$this->hasValue($name)) {
      return $default;
    }
    else {
      return $this->_data[$name];
    }
  }

  /**
   * Get a value as boolean
   * @param name The name of the variable
   * @param default The default value if the value is not defined [default: false]
   * @return The value or null if it does not exist
   */
  function getBooleanValue($name, $default=false)
  {
    if (!$this->hasValue($name)) {
      return $default;
    }
    else {
      return ($this->_data[$name] === true || strtolower($this->_data[$name]) === "true"
        || intval($this->_data[$name]) === 1);
    }
  }

  /**
   * Get all values as an associative array
   * @return A reference to an data array
   */
  function &getData()
  {
    return $this->_data;
  }

  /**
   * Set all values at once
   * @param data A reference to the data
   */
  function setData(&$data)
  {
    $this->_data = &$data;
  }

  /**
   * Remove a value
   * @param name The name of the variable
   */
  function clearValue($name)
  {
    unset($this->_data[$name]);
  }

  /**
   * Remove all values
   */
  function clearValues()
  {
    $this->_data = array();
  }

  /**
   * Get a string repr�sentation of the message
   * @return The string
   */
  function toString()
  {
    $str = 'sender='.$this->_sender.', ';
    $str .= 'context='.$this->_context.', ';
    $str .= 'action='.$this->_action.', ';
    $str .= 'format='.$this->_format.', ';
    $str .= 'data='.StringUtil::getDump($this->_data);
    return $str;
  }
}
?>