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

/**
 * Global error function. 
 * Use this if you want to define a callback function and can not use WCMFWCMFException::throwEx().
 */
function gError($message, $file='', $line='')
{
  WCMFWCMFException::throwEx1($message, $file, $line);
}
/**
 * @class WCMFException
 * @ingroup core
 * @brief Use the WCMFException class to handle errors.
 * You need not instantiate a WCMFException object
 * because the methods may be called like static
 * class methods e.g.
 * $translated = WCMFWCMFException::throwEx('error message', __FILE__, __LINE__)
 *
 * @author      ingo herwig <ingo@wemove.com>
 */
class WCMFException
{
  /**
   * The throw() method may be used to output throw and terminate the programm.
   * @note A global exception handling function with the same parameters may be defined in the global variable $EXCEPTION_HANDLER.
   * @param message The exception message.
   * @param file The current file (use __FILE__), recommended.
   * @param line The current line (use __LINE__), recommended.
   */
  function throwEx($message, $file='', $line='')
  {
    global $EXCEPTION_HANDLER;
    if (isset($EXCEPTION_HANDLER))
      $EXCEPTION_HANDLER($message, $file, $line);
    else
    {
      $str = '';
      if ($file != '') $str = ' [ '.$file;
      if ($line != '') $str .= ' '.$line;
      if ($str != '') $str .= ' ]';
      Log::fatal($str." ".$message."\n".WCMFException::getStackTrace(), __FILE__);
      die('ERROR'.$str.': '.$message);
    }
  }
  /**
   * Get a stack trace.
   * @return A string containing the stack trace.
   */
  function getStackTrace()
  {
    $vDebug = debug_backtrace();
    $vFiles = array();
    for ($i=0; $i<count($vDebug); $i++)
    {
      // skip the first one, since it's always this func
      if ($i==0)
        continue;
      $aFile = $vDebug[$i];
      $vFiles[] = '  -> '.$aFile['class'].$aFile['type'].$aFile['function'].' (called at '.basename($aFile['file']).':'.$aFile['line'].')';
    }
    return implode("\n", $vFiles);
  }
}
?>