<?php
/**
* @version $Id: exception.php 20196 2011-01-09 02:40:25Z ian $
* @package Joomla.Framework
* @subpackage Error
* @copyright Copyright (C) 2005 - 2011 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License, see LICENSE.php
*/
// No direct access
defined('JPATH_BASE') or die();
/**
* Joomla! Exception object.
*
* @package Joomla.Framework
* @subpackage Error
* @since 1.5
*/
class JException extends Exception
{
/**
* Error level
* @var string
*/
protected $level = null;
/**
* Error code
* @var string
*/
protected $code = null;
/**
* Error message
* @var string
*/
protected $message = null;
/**
* Additional info about the error relevant to the developer
* - e.g. if a database connect fails, the dsn used
* @var string
*/
protected $info = '';
/**
* Name of the file the error occurred in [Available if backtrace is enabled]
* @var string
*/
protected $file = null;
/**
* Line number the error occurred in [Available if backtrace is enabled]
* @var int
*/
protected $line = 0;
/**
* Name of the method the error occurred in [Available if backtrace is enabled]
* @var string
*/
protected $function = null;
/**
* Name of the class the error occurred in [Available if backtrace is enabled]
* @var string
*/
protected $class = null;
/**
* Error type
* @var string
*/
protected $type = null;
/**
* Arguments recieved by the method the error occurred in [Available if backtrace is enabled]
* @var array
*/
protected $args = array();
/**
* Backtrace information
* @var mixed
*/
protected $backtrace = null;
/**
* Constructor
* - used to set up the error with all needed error details.
*
* @access protected
* @param string $msg The error message
* @param string $code The error code from the application
* @param int $level The error level (use the PHP constants E_ALL, E_NOTICE etc.).
* @param string $info Optional: The additional error information.
* @param boolean $backtrace True if backtrace information is to be collected
*/
public function __construct($msg, $code = 0, $level = null, $info = null, $backtrace = false)
{
$this->level = $level;
$this->code = $code;
$this->message = $msg;
if ($info != null) {
$this->info = $info;
}
if ($backtrace && function_exists('debug_backtrace'))
{
$this->backtrace = debug_backtrace();
for($i = count($this->backtrace) - 1; $i >= 0; --$i)
{
++$i;
if (isset($this->backtrace[$i]['file'])) {
$this->file = $this->backtrace[$i]['file'];
}
if (isset($this->backtrace[$i]['line'])) {
$this->line = $this->backtrace[$i]['line'];
}
if (isset($this->backtrace[$i]['class'])) {
$this->class = $this->backtrace[$i]['class'];
}
if (isset($this->backtrace[$i]['function'])) {
$this->function = $this->backtrace[$i]['function'];
}
if (isset($this->backtrace[$i]['type'])) {
$this->type = $this->backtrace[$i]['type'];
}
$this->args = false;
if (isset($this->backtrace[$i]['args'])) {
$this->args = $this->backtrace[$i]['args'];
}
break;
}
}
// Store exception for debugging purposes!
JError::addToStack($this);
parent::__construct($msg, (int) $code);
}
/**
* Returns to error message
*
* @access public
* @return string Error message
* @since 1.6
*/
public function __toString()
{
return $this->message;
}
/**
* Returns to error message
*
* @access public
* @deprecated
* @return string Error message
* @since 1.5
*/
public function toString()
{
return (string)$this;
}
/**
* Returns a property of the object or the default value if the property is not set.
*
* @access public
* @param string $property The name of the property
* @param mixed $default The default value
* @return mixed The value of the property
* @see getProperties()
* @since 1.5
*/
public function get($property, $default=null)
{
if (isset($this->$property)) {
return $this->$property;
}
return $default;
}
/**
* Returns an associative array of object properties
*
* @access public
* @param boolean $public If true, returns only the public properties
* @return array
* @see get()
* @since 1.5
*/
public function getProperties($public = true)
{
$vars = get_object_vars($this);
if ($public)
{
foreach ($vars as $key => $value)
{
if ('_' == substr($key, 0, 1)) {
unset($vars[$key]);
}
}
}
return $vars;
}
/**
* Get the most recent error message
*
* @param integer $i Option error index
* @param boolean $toString Indicates if JError objects should return their error message
* @return string Error message
* @access public
* @since 1.5
*/
public function getError($i = null, $toString = true)
{
// Find the error
if ($i === null) {
// Default, return the last message
$error = end($this->_errors);
}
else
if (! array_key_exists($i, $this->_errors)) {
// If $i has been specified but does not exist, return false
return false;
}
else {
$error = $this->_errors[$i];
}
// Check if only the string is requested
if (JError::isError($error) && $toString) {
return (string)$error;
}
return $error;
}
/**
* Return all errors, if any
*
* @access public
* @return array Array of error messages or JErrors
* @since 1.5
*/
public function getErrors()
{
return $this->_errors;
}
/**
* Modifies a property of the object, creating it if it does not already exist.
*
* @access public
* @param string $property The name of the property
* @param mixed $value The value of the property to set
* @return mixed Previous value of the property
* @see setProperties()
* @since 1.5
*/
public function set($property, $value = null)
{
$previous = isset($this->$property) ? $this->$property : null;
$this->$property = $value;
return $previous;
}
/**
* Set the object properties based on a named array/hash
*
* @access protected
* @param $array mixed Either and associative array or another object
* @return boolean
* @see set()
* @since 1.5
*/
public function setProperties($properties)
{
$properties = (array) $properties; //cast to an array
if (is_array($properties))
{
foreach ($properties as $k => $v) {
$this->$k = $v;
}
return true;
}
return false;
}
/**
* Add an error message
*
* @param string $error Error message
* @access public
* @since 1.0
*/
public function setError($error)
{
array_push($this->_errors, $error);
}
}