class.LoggingController.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$
 */
require_once(BASE."wcmf/lib/presentation/class.Controller.php");
require_once(BASE."wcmf/lib/util/class.Log.php");

/**
 * @class LoggingController
 * @ingroup Controller
 * @brief LoggingController is a controller that logs a message.
 * 
 * <b>Input actions:</b>
 * - unspecified: Log the message
 *
 * <b>Output actions:</b>
 * - @em ok In any case
 * 
 * @param[in] type The type of message. Must be one of: DEBUG, INFO, WARNING, ERROR, FATAL
 * @param[in] message The message
 *
 * @author ingo herwig <ingo@wemove.com>
 */
class LoggingController extends Controller
{
  /**
   * @see Controller::hasView()
   */
  function hasView()
  {
    return false;
  }
  /**
   * Log the message.
   * @return Array of given context and action 'ok' in every case.
   * @see Controller::executeKernel()
   */
  function executeKernel()
  {
    $logType = $this->_request->getValue('type');
    $message = $this->_request->getValue('message');
    
    switch($logType)
    {
      case 'DEBUG':
        Log::debug($message, __CLASS__);
        break;
        
      case 'INFO':
        Log::info($message, __CLASS__);
        break;
        
      case 'WARNING':
        Log::warn($message, __CLASS__);
        break;
        
      case 'ERROR':
        Log::error($message, __CLASS__);
        break;
        
      case 'FATAL':
        Log::fatal($message, __CLASS__);
        break;
        
      default:
        Log::error("Unknown log message type: ".$logType, __CLASS__);
    }

    $this->_response->setAction('ok');
    return true;
  }
}
?>