class_FrameworkException.php

Go to the documentation of this file.

<?php
abstract class FrameworkException extends ReflectionException {
        private $backTrace = array();

        private $extraData = "";

        public function __construct($message, $code = 0) {
                // Extract backtrace
                $this->saveBackTrace();

                // Cast all data
                $message = (string) $message;
                $code    = (int)    $code;

                // In emergency exit?
                if (defined('EMERGENCY_EXIT_CALLED')) {
                        // Output message
                        printf("[%s:] Message: %s, Backtrace: <pre>%s</pre>",
                                $this->__toString(),
                                $message,
                                $this->getPrintableBackTrace()
                        );

                        // End here
                        exit();
                } // END - if
                // Make sure everything is assigned properly
                parent::__construct($message, $code);

                // Log it away if DEBUG_ALL is set
                if (defined('DEBUG_ALL')) {
                        // Log the error
                        error_log(sprintf("[%s:] %s (%s)",
                                $this->__toString(),
                                $message,
                                $this->getHexCode()
                        ));
                } // END - if
        }

        private final function saveBackTrace () {
                // Get full backtrace
                $this->backTrace = debug_backtrace();

                // Remove this call
                $dummy = array_shift($this->backTrace);

                // resort the array
                ksort($this->backTrace);
        }

        public final function getBackTrace () {
                return $this->backTrace;
        }

        public final function getPrintableBackTrace () {
                // Get the backtrace
                $dbgTrace = $this->getBackTrace();

                // Taken from de.php.net user comments
                $dbgMsg = "<br />\nDebug backtrace begin:<br />\n";
                foreach ($dbgTrace as $dbgIndex => $dbgInfo) {
                        // No info by default
                        $info = "NULL";

                        // Are there arguments?
                        if ((isset($dbgInfo['args'])) && (is_array($dbgInfo['args'])) && (isset($dbgInfo['args'][0]))) {
                                //* DEBUG: */ echo $dbgIndex.": <pre>".htmlentities(print_r($dbgInfo['args'], true))."</pre>";
                                $info = "";
                                foreach ($dbgInfo['args'] as $debug) {
                                        // Add only non-array elements
                                        if (!is_array($debug)) {
                                                $info .= $debug.", ";
                                        } // END - if
                                } // END - if

                                $info = substr($info, 0, -2);
                        } // END - if

                        // Prepare argument infos
                        $info = "<em id=\"debug_args_".$dbgIndex."\">{$info}</em>";

                        // File detection
                        $file = "Unknown file";
                        if (isset($dbgInfo['file'])) {
                                $file = basename($dbgInfo['file']);
                        } // END - if

                        // Line detection
                        $line = "Unknown line";
                        if (isset($dbgInfo['line'])) {
                                $line = "line {$dbgInfo['line']}";
                        } // END - if

                        // The message
                        $dbgMsg .= "\t at <em id=\"debug_id_".$dbgIndex."\">".$dbgIndex."</em> <em id=\"debug_file_".$dbgIndex."\">".$file."</em> (<em id=\"debug_line_".$dbgIndex."\">".$line."</em>) -&gt; ".$dbgInfo['function']."(".$info.")<br />\n";
                } // END - if
                $dbgMsg .= "Debug backtrace end<br />\n";

                return $dbgMsg;
        }

        public function __toString() {
                return get_class($this);
        }

        public final function getHexCode ($code = null) {
                // Get the decimal code
                if (is_null($code)) $code = $this->getCode();

                // Format it to hex-decimal, 0x as prefix and 3 chars
                $hexCode = sprintf("0x%03s", dechex($code));

                // Return it
                return $hexCode;
        }

        protected final function setExtraData ($extraData) {
                $this->extraData = $extraData;
        }

        public final function getExtraData () {
                return $this->extraData;
        }
}

// [EOF]
?>