├── Debug.php
├── GPL-LICENSE.txt
├── MIT-LICENSE.txt
└── README.md


/Debug.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | defined('E_DEPRECATED') || define('E_DEPRECATED', 8192);
  3 | defined('E_USER_DEPRECATED') || define('E_USER_DEPRECATED', 16384);
  4 | class Debug {
  5 | 	static protected $reporting = E_ALL;
  6 | 	static public    function reporting ( $reporting = null ) {
  7 | 		if ( ! func_num_args() )
  8 | 			return self::$reporting;
  9 | 		self::$reporting = $reporting;
 10 | 	}
 11 | 	static public    function log () {
 12 |     $args = func_get_args();
 13 | 		self::$reporting && 
 14 | 			print( 
 15 | 				self::style() . PHP_EOL . '<pre class="debug log">'
 16 | 				. implode( 
 17 | 					'</pre>' . PHP_EOL . '<pre class="log">' 
 18 | 					, array_map( 'Debug::var_export', $args )
 19 | 				)
 20 | 				. '</pre>'
 21 | 			);
 22 | 	}
 23 | 	static public    function dump () {
 24 |     $args = func_get_args();
 25 | 		self::$reporting && 
 26 | 			die( call_user_func_array( 'Debug::log', $args ) );
 27 | 	}
 28 | 	static private   $time;
 29 | 	static private   $chrono;
 30 | 	static public    function chrono ( $print = null, $scope = '' ) {
 31 | 		if ( ! self::$reporting )
 32 | 			return;
 33 | 		if ( ! isset( self::$time[ $scope ] ) )
 34 | 			$chrono [] = '<b class="init">' . $scope . ' chrono init</b>';
 35 | 		elseif ( is_string( $print ) ) {
 36 | 			$chrono[] = sprintf('<span class="time">%s -> %s: %fs</span>'
 37 | 				, $scope
 38 | 				, $print
 39 | 				, round( self::$chrono[ $scope ][ $print ] = microtime( true ) - self::$time[ $scope ], 6 )
 40 | 			);
 41 | 		} elseif ( $print && isset( self::$chrono[ $scope ] ) ) {
 42 | 			asort( self::$chrono[ $scope ] );
 43 | 			$base = reset ( self::$chrono[ $scope ] ); // shortest duration
 44 | 			foreach( self::$chrono[ $scope ] as $event => $duration )
 45 | 				$table[] = sprintf( '%5u - %-38.38s <i>%7fs</i>'
 46 | 					, round( $duration / $base, 2 )
 47 | 					, $event
 48 | 					, round( $duration, 3 )
 49 | 				);
 50 | 			$chrono[] = '<div class="table"><b>' . $scope . ' chrono table</b>' . PHP_EOL .
 51 | 				sprintf( '%\'-61s %-46s<i>duration</i>%1$s%1$\'-61s'
 52 | 					, PHP_EOL
 53 | 					, 'unit - action'
 54 | 				) . 
 55 | 				implode( PHP_EOL, $table ) . PHP_EOL . 
 56 | 				'</div>';
 57 | 		}
 58 | 		echo self::style(), PHP_EOL, '<pre class="debug chrono">', implode( PHP_EOL, $chrono ), '</pre>';
 59 | 		return self::$time[ $scope ] = microtime( true );
 60 | 	}
 61 | 	static private   $registered;
 62 | 	static public    function register ( $init = true ) {
 63 | 		if ( $init) {
 64 | 			if ( ! self::$registered )
 65 | 				self::$registered = array(
 66 | 					'display_errors'    => ini_get( 'display_errors' )
 67 |           , 'error_reporting' => error_reporting()
 68 | 					, 'shutdown'        => register_shutdown_function( 'Debug::shutdown' )
 69 | 				);
 70 | 			self::$registered[ 'shutdown' ] = true;
 71 | 			error_reporting( E_ALL );
 72 | 			set_error_handler( 'Debug::handler', E_ALL );
 73 | 			set_exception_handler( 'Debug::exception' );
 74 | 			ini_set( 'display_errors', 0 );
 75 | 		} elseif ( self::$registered ) {
 76 | 			self::$registered[ 'shutdown' ] = false;
 77 | 			error_reporting( self::$registered[ 'error_reporting' ] );
 78 | 			restore_error_handler();
 79 | 			restore_exception_handler();
 80 | 			ini_set( 'display_errors', self::$registered[ 'display_errors' ] );
 81 | 		}
 82 | 	}
 83 | 	static protected $error     = array(
 84 | 		-1                    => 'Exception'
 85 | 		, E_ERROR             => 'Fatal'
 86 | 		, E_RECOVERABLE_ERROR => 'Recoverable'
 87 | 		, E_WARNING           => 'Warning'
 88 | 		, E_PARSE             => 'Parse'
 89 | 		, E_NOTICE            => 'Notice'
 90 | 		, E_STRICT            => 'Strict'
 91 | 		, E_DEPRECATED        => 'Deprecated'
 92 | 		, E_CORE_ERROR        => 'Fatal'
 93 | 		, E_CORE_WARNING      => 'Warning'
 94 | 		, E_COMPILE_ERROR     => 'Compile Fatal'
 95 | 		, E_COMPILE_WARNING   => 'Compile Warning'
 96 | 		, E_USER_ERROR        => 'Fatal'
 97 | 		, E_USER_WARNING      => 'Warning'
 98 | 		, E_USER_NOTICE       => 'Notice'
 99 | 		, E_USER_DEPRECATED   => 'Deprecated'
100 | 	);
101 | 	static public    function handler ( $type, $message, $file, $line, $scope, $stack = null ) {
102 | 		global $php_errormsg; // set global error message regardless track errors settings
103 | 		$php_errormsg = preg_replace( '~^.*</a>\]: +(?:\([^\)]+\): +)?~', null, $message ); // clean useless infos
104 | 		if ( ! self::$reporting ) // de-activate
105 | 			return false;
106 | 		$stack = $stack ? $stack : array_slice( debug_backtrace( false ),  $type & E_USER_ERROR | E_USER_WARNING | E_USER_NOTICE ?  2 : 1 ); // clean stack depending if error is user triggered or not
107 | 		self::overload( $stack, $file, $line  ); // switch line & file if overloaded method triggered the error
108 | 		echo self::style(), PHP_EOL, '<pre class="debug error ', strtolower( self::$error[ $type ] ), '">', PHP_EOL, 
109 | 			sprintf( '<b>%s</b>: %s in <b>%s</b> on line <b>%s</b>'  // print error
110 | 				, self::$error[ $type ] ? self::$error[ $type ] : 'Error'
111 | 				, $php_errormsg
112 | 				, $file
113 | 				, $line
114 | 			);
115 | 		if ( $type & self::$reporting ) // print context
116 | 			echo self::context( $stack, $scope );
117 | 		echo '</pre>';
118 | 		if ( $type & E_USER_ERROR ) // fatal
119 | 			exit;
120 | 	}
121 | 	static public    function shutdown () {
122 | 		if ( self::$registered[ 'shutdown' ] && ( $error = error_get_last() ) && ( $error[ 'type' ] & ( E_ERROR |  E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR ) ) )
123 | 			self::handler( $error[ 'type' ], $error[ 'message' ], $error[ 'file' ], $error[ 'line' ], null );
124 | 	}
125 | 	static public    function exception ( Exception $exception ) {
126 | 		$msg = sprintf( '"%s" with message "%s"', get_class( $exception ), $exception->getMessage() );
127 | 		self::handler( -1, $msg, $exception->getFile(), $exception->getLine(), null, $exception->getTrace() );
128 | 	}
129 | 	static public    $style     = array(
130 | 		'debug'         => 'font-size:1em;padding:.5em;border-radius:5px'
131 | 		, 'error'       => 'background:#eee'
132 | 		, 'exception'   => 'color:#825'
133 | 		, 'parse'       => 'color:#F07'
134 | 		, 'compile'     => 'color:#F70'
135 | 		, 'fatal'       => 'color:#F00'
136 | 		, 'recoverable' => 'color:#F22'
137 | 		, 'warning'     => 'color:#E44'
138 | 		, 'notice'      => 'color:#E66'
139 | 		, 'deprecated'  => 'color:#F88'
140 | 		, 'strict'      => 'color:#FAA'
141 | 		, 'stack'       => 'padding:.2em .8em;color:#444'
142 | 		, 'trace'       => 'border-left:1px solid #ccc;padding-left:1em'
143 | 		, 'scope'       => 'padding:.2em .8em;color:#666'
144 | 		, 'var'         => 'border-bottom:1px dashed #aaa;margin-top:-.5em;padding-bottom:.9em'
145 |     , 'log'         => 'background:#f7f7f7;color:#33e'
146 | 		, 'chrono'      => 'border-left:2px solid #ccc'
147 | 		, 'init'        => 'color:#4A6'
148 | 		, 'time'        => 'color:#284'
149 | 		, 'table'       => 'color:#042'
150 | 	);
151 | 	static protected function style () {
152 | 		static $style;
153 | 		if ( $style )
154 | 			return;
155 | 		foreach ( self::$style as $class => $css )
156 | 			$style .= sprintf( '.%s{%s}', $class, $css );
157 | 		return PHP_EOL . '<style type="text/css">' . $style . '</style>';
158 | 	}
159 | 	static protected $overload  = array(
160 | 		'__callStatic'   => 2
161 | 		, '__call'       => 2
162 | 		, '__get'        => 1
163 | 		, '__set'        => 1
164 | 		, '__clone'      => 1
165 | 		, 'offsetGet'    => 1
166 | 		, 'offsetSet'    => 1
167 | 		, 'offsetUnset'  => 1
168 | 		, 'offsetExists' => 1
169 | 	);
170 | 	static protected function overload ( &$stack, &$file, &$line ) {
171 | 		if ( isset( $stack[ 0 ][ 'class' ], self::$overload[ $stack[ 0 ][ 'function' ] ] ) && $offset = self::$overload[ $stack[ 0 ][ 'function' ] ] )
172 | 			for ( $i = 0; $i < $offset; $i++ )
173 | 				extract( array_shift( $stack ) ); // clean stack and overwrite file & line
174 | 	}
175 | 	static protected function context ( $stack, $scope ) {
176 | 		if ( ! $stack )
177 | 				return;
178 | 		$context[] = PHP_EOL . '<div class="stack"><i>Stack trace</i> :';
179 | 		foreach ( $stack as $index => $call )
180 | 			$context[] = sprintf( '  <span class="trace">#%s %s: <b>%s%s%s</b>(%s)</span>'
181 | 				, $index
182 | 				, isset( $call[ 'file' ] )  ? $call[ 'file' ] . ' (' . $call[ 'line' ] . ')' : '[internal function]'
183 | 				, isset( $call[ 'class' ] ) ? $call[ 'class' ]                              : ''
184 | 				, isset( $call[ 'type' ] )  ? $call[ 'type' ]                               : ''
185 | 				, $call[ 'function' ]
186 | 				, isset( $call[ 'args' ] )  ? self::args_export( $call[ 'args' ] )          : ''
187 | 			);
188 | 		$context[] = '  <span class="trace">#' . ( $index + 1 ) . ' {main}</span>'; 
189 | 		$context[] = '</div><div class="scope"><i>Scope</i> :';
190 |     $vars = '';
191 | 		if ( isset( $scope['GLOBALS'] ) )
192 | 			$vars = '  GLOBAL';
193 | 		elseif ( ! $scope )
194 | 			$vars = '  NONE';
195 | 		else
196 | 			foreach ( (array) $scope as $name => $value )
197 | 				$vars .= '  <div class="var">$' . $name .' = ' . self::var_export( $value ) . ';' . PHP_EOL . '</div>';
198 | 		$context[] = $vars . '</div>';
199 | 		return implode( PHP_EOL, $context );
200 | 	}
201 | 	static protected function var_export ( $var ) {
202 |     ob_start();
203 |     var_dump( $var );
204 |     $export = ob_get_clean();
205 |     $export = preg_replace( '/\s*\bNULL\b/m', ' null', $export ); // Cleanup NULL
206 |     $export = preg_replace( '/\s*\bbool\((true|false)\)/m', ' $1', $export ); // Cleanup booleans
207 |     $export = preg_replace( '/\s*\bint\((\d+)\)/m', ' $1', $export ); // Cleanup integers
208 |     $export = preg_replace( '/\s*\bfloat\(([\d.e-]+)\)/mi', ' $1', $export ); // Cleanup floats
209 |     $export = preg_replace( '/\s*\bstring\(\d+\) /m', '', $export ); // Cleanup strings
210 |     $export = preg_replace( '/object\((\w+)\)(#\d+) \(\d+\)/m', '$1$2', $export ); // Cleanup objects definition
211 |     //@todo array cleaning
212 |     $export = preg_replace( '/=>\s*/m', '=> ', $export ); // No new line between array/object keys and properties
213 |     $export = preg_replace( '/\[([\w": ]+)\]/', ', $1 ', $export ); // remove square brackets in array/object keys
214 |     $export = preg_replace( '/([{(]\s+), /', '$1  ', $export ); // remove first coma in array/object properties listing
215 |     $export = preg_replace( '/\{\s+\}/m', '{}', $export );
216 |     $export = preg_replace( '/\s+$/m', '', $export ); // Trim end spaces/new line
217 |     return $export;
218 | 	}
219 | 	static protected function simple_export ( $var ) {
220 |     $export = self::var_export( $var );
221 | 		if ( is_array( $var ) ) {
222 |       $export  = preg_replace( '/\s+\d+ => /m', ', ', $export );
223 |       $export  = preg_replace( '/\s+(["\w]+ => )/m', ', $1', $export );
224 |       $pattern = '#array\(\d+\) \{[\s,]*([^{}]+|(?R))*?\s+\}#m';
225 |       while ( preg_match( $pattern, $export ) )
226 |         $export  = preg_replace( $pattern, 'array($1)', $export );
227 |       return $export;
228 |     }
229 | 		if ( is_object( $var ) )
230 | 			return substr( $export, 0, strpos( $export, '#' ) ); // strstr( $export, '#', true );
231 | 		return $export;
232 | 	}
233 | 	static protected function args_export ( $args ) {
234 | 		return implode(', ', array_map( 
235 | 			'Debug::simple_export', 
236 | 			(array) $args
237 | 		) );
238 | 	}
239 | }
240 | Debug::register();
241 | if ( ! function_exists( 'l' ) ) {
242 |   function l () {
243 |     $args = func_get_args();
244 |     call_user_func_array( 'Debug::log', $args );
245 |   }
246 | }
247 | if ( ! function_exists( 'd' ) ) {
248 |   function d () {
249 |     $args = func_get_args();
250 |   	call_user_func_array( 'Debug::dump', $args );
251 |   }
252 | }
253 | if ( ! function_exists( 'c' ) ) {
254 |   function c () {
255 |     $args = func_get_args();
256 |   	call_user_func_array( 'Debug::chrono', $args );
257 |   }
258 | }


--------------------------------------------------------------------------------
/GPL-LICENSE.txt:
--------------------------------------------------------------------------------
  1 |         GNU GENERAL PUBLIC LICENSE
  2 |            Version 2, June 1991
  3 | 
  4 |  Copyright (C) 1989, 1991 Free Software Foundation, Inc.
  5 |  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  6 |  Everyone is permitted to copy and distribute verbatim copies
  7 |  of this license document, but changing it is not allowed.
  8 | 
  9 |           Preamble
 10 | 
 11 |   The licenses for most software are designed to take away your
 12 | freedom to share and change it.  By contrast, the GNU General Public
 13 | License is intended to guarantee your freedom to share and change free
 14 | software--to make sure the software is free for all its users.  This
 15 | General Public License applies to most of the Free Software
 16 | Foundation's software and to any other program whose authors commit to
 17 | using it.  (Some other Free Software Foundation software is covered by
 18 | the GNU Lesser General Public License instead.)  You can apply it to
 19 | your programs, too.
 20 | 
 21 |   When we speak of free software, we are referring to freedom, not
 22 | price.  Our General Public Licenses are designed to make sure that you
 23 | have the freedom to distribute copies of free software (and charge for
 24 | this service if you wish), that you receive source code or can get it
 25 | if you want it, that you can change the software or use pieces of it
 26 | in new free programs; and that you know you can do these things.
 27 | 
 28 |   To protect your rights, we need to make restrictions that forbid
 29 | anyone to deny you these rights or to ask you to surrender the rights.
 30 | These restrictions translate to certain responsibilities for you if you
 31 | distribute copies of the software, or if you modify it.
 32 | 
 33 |   For example, if you distribute copies of such a program, whether
 34 | gratis or for a fee, you must give the recipients all the rights that
 35 | you have.  You must make sure that they, too, receive or can get the
 36 | source code.  And you must show them these terms so they know their
 37 | rights.
 38 | 
 39 |   We protect your rights with two steps: (1) copyright the software, and
 40 | (2) offer you this license which gives you legal permission to copy,
 41 | distribute and/or modify the software.
 42 | 
 43 |   Also, for each author's protection and ours, we want to make certain
 44 | that everyone understands that there is no warranty for this free
 45 | software.  If the software is modified by someone else and passed on, we
 46 | want its recipients to know that what they have is not the original, so
 47 | that any problems introduced by others will not reflect on the original
 48 | authors' reputations.
 49 | 
 50 |   Finally, any free program is threatened constantly by software
 51 | patents.  We wish to avoid the danger that redistributors of a free
 52 | program will individually obtain patent licenses, in effect making the
 53 | program proprietary.  To prevent this, we have made it clear that any
 54 | patent must be licensed for everyone's free use or not licensed at all.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |         GNU GENERAL PUBLIC LICENSE
 60 |    TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
 61 | 
 62 |   0. This License applies to any program or other work which contains
 63 | a notice placed by the copyright holder saying it may be distributed
 64 | under the terms of this General Public License.  The "Program", below,
 65 | refers to any such program or work, and a "work based on the Program"
 66 | means either the Program or any derivative work under copyright law:
 67 | that is to say, a work containing the Program or a portion of it,
 68 | either verbatim or with modifications and/or translated into another
 69 | language.  (Hereinafter, translation is included without limitation in
 70 | the term "modification".)  Each licensee is addressed as "you".
 71 | 
 72 | Activities other than copying, distribution and modification are not
 73 | covered by this License; they are outside its scope.  The act of
 74 | running the Program is not restricted, and the output from the Program
 75 | is covered only if its contents constitute a work based on the
 76 | Program (independent of having been made by running the Program).
 77 | Whether that is true depends on what the Program does.
 78 | 
 79 |   1. You may copy and distribute verbatim copies of the Program's
 80 | source code as you receive it, in any medium, provided that you
 81 | conspicuously and appropriately publish on each copy an appropriate
 82 | copyright notice and disclaimer of warranty; keep intact all the
 83 | notices that refer to this License and to the absence of any warranty;
 84 | and give any other recipients of the Program a copy of this License
 85 | along with the Program.
 86 | 
 87 | You may charge a fee for the physical act of transferring a copy, and
 88 | you may at your option offer warranty protection in exchange for a fee.
 89 | 
 90 |   2. You may modify your copy or copies of the Program or any portion
 91 | of it, thus forming a work based on the Program, and copy and
 92 | distribute such modifications or work under the terms of Section 1
 93 | above, provided that you also meet all of these conditions:
 94 | 
 95 |     a) You must cause the modified files to carry prominent notices
 96 |     stating that you changed the files and the date of any change.
 97 | 
 98 |     b) You must cause any work that you distribute or publish, that in
 99 |     whole or in part contains or is derived from the Program or any
100 |     part thereof, to be licensed as a whole at no charge to all third
101 |     parties under the terms of this License.
102 | 
103 |     c) If the modified program normally reads commands interactively
104 |     when run, you must cause it, when started running for such
105 |     interactive use in the most ordinary way, to print or display an
106 |     announcement including an appropriate copyright notice and a
107 |     notice that there is no warranty (or else, saying that you provide
108 |     a warranty) and that users may redistribute the program under
109 |     these conditions, and telling the user how to view a copy of this
110 |     License.  (Exception: if the Program itself is interactive but
111 |     does not normally print such an announcement, your work based on
112 |     the Program is not required to print an announcement.)
113 | 
114 | These requirements apply to the modified work as a whole.  If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works.  But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 | 
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 | 
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 | 
134 |   3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 | 
138 |     a) Accompany it with the complete corresponding machine-readable
139 |     source code, which must be distributed under the terms of Sections
140 |     1 and 2 above on a medium customarily used for software interchange; or,
141 | 
142 |     b) Accompany it with a written offer, valid for at least three
143 |     years, to give any third party, for a charge no more than your
144 |     cost of physically performing source distribution, a complete
145 |     machine-readable copy of the corresponding source code, to be
146 |     distributed under the terms of Sections 1 and 2 above on a medium
147 |     customarily used for software interchange; or,
148 | 
149 |     c) Accompany it with the information you received as to the offer
150 |     to distribute corresponding source code.  (This alternative is
151 |     allowed only for noncommercial distribution and only if you
152 |     received the program in object code or executable form with such
153 |     an offer, in accord with Subsection b above.)
154 | 
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it.  For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable.  However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 | 
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 | 
172 |   4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License.  Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 | 
180 |   5. You are not required to accept this License, since you have not
181 | signed it.  However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works.  These actions are
183 | prohibited by law if you do not accept this License.  Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 | 
189 |   6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions.  You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 | 
197 |   7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License.  If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all.  For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 | 
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 | 
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices.  Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 | 
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 | 
229 |   8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded.  In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 | 
237 |   9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time.  Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 | 
242 | Each version is given a distinguishing version number.  If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation.  If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 | 
250 |   10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission.  For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this.  Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 | 
258 |           NO WARRANTY
259 | 
260 |   11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 | 
270 |   12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 | 


--------------------------------------------------------------------------------
/MIT-LICENSE.txt:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2011 Adrien Gibrat, https://github.com/adriengibrat/
 2 | 
 3 | Permission is hereby granted, free of charge, to any person obtaining
 4 | a copy of this software and associated documentation files (the
 5 | "Software"), to deal in the Software without restriction, including
 6 | without limitation the rights to use, copy, modify, merge, publish,
 7 | distribute, sublicense, and/or sell copies of the Software, and to
 8 | permit persons to whom the Software is furnished to do so, subject to
 9 | the following conditions:
10 | 
11 | The above copyright notice and this permission notice shall be
12 | included in all copies or substantial portions of the Software.
13 | 
14 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 | MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18 | LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19 | OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20 | WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | ## How to use it
 2 | Easy, just include the class file and it automatically replace the default error & exception handlers!
 3 | 
 4 | Log any message / variable / data.
 5 | ```php
 6 | <?php
 7 | Debug::log( 'message', $var1, $var2, ... ); // log as much data as you want
 8 | Debug::dump( 'message', $var1, $var2, ... ); // log and exit
 9 | ```
10 | 
11 | Use and display chrono.
12 | ```php
13 | <?php
14 | Debug::chrono(); // set the timer
15 | Debug::chrono('your message'); // display your message & time elapsed since last chrono call
16 | Debug::chrono(true); // display a table with all messages & times
17 | ```
18 | 
19 | Use several chrono at the same time by passing chrono name as second argument.
20 | ```php
21 | <?php
22 | Debug::chrono( null, 'chrono1' ); // set the timer of chrono 1
23 | Debug::chrono( null, 'chrono2' ); // set the timer of chrono 2
24 | usleep( 5000 );
25 | Debug::chrono( 'your message 1', 'chrono1' ); // display message & time since last chrono 1 call
26 | usleep( 5000 );
27 | Debug::chrono( 'your message 2', 'chrono2' ); // display message & time since last chrono 2 call
28 | 
29 | Debug::chrono( true, 'chrono1' ); // display a table with all messages & times of chrono 1
30 | Debug::chrono( true, 'chrono2' ); // display a table with all messages & times of chrono 2
31 | ```
32 | 
33 | There is also (very) short alias functions.
34 | <pre>
35 | l() === Debug::log();
36 | d() === Debug::dump();
37 | c() === Debug::chrono();
38 | </pre>
39 | 
40 | Turn the display of error, logs and chrono on & off at runtine.
41 | ```php
42 | <?php
43 | Debug::reporting( false ); // turn off
44 | // Activate debug and show all error informations (stack trace and context) on given error level
45 | Debug::reporting( E_ALL ); 
46 | ```
47 | 
48 | Customize error / log and chrono style by modifying Debug::$style
49 | ```php
50 | <?php
51 | Debug::$style[ 'debug' ]  = 'font-size:2em'; // Applied on all displayed items
52 | Debug::$style[ 'error' ]  = 'border:1px solid red'; // Custom style on error
53 | Debug::$style[ 'log' ]    = 'border:1px solid #blue'; // Custom style on log
54 | Debug::$style[ 'chrono' ] = 'border:1px solid #green'; // Custom style on chrono
55 | // See source for complete list of styles
56 | ```
57 | 
58 | Debug registers custom error & exception handlers (on file inclusion), to unregister custom handlers.
59 | ```php
60 | <?php
61 | Debug::register( false );
62 | // and of course register it again
63 | Debug::register(); 
64 | ```
65 | 
66 | ### Error display template
67 | <pre>
68 | [Error Type]: [Full Error message] in [path and filename] on line xxx
69 | Stack trace:
70 | #0 [path and filename](xxx): [code where error occured]
71 | #1 [path and filename](xxx): [Function call backtrace]
72 | #2 [path and filename](xxx): [Function call backtrace]
73 | #3 {main}
74 | Context:
75 | $var1 = [value];
76 | $var2 = [value];
77 | ...
78 | </pre>
79 | 
80 | ### Chrono display template
81 | <pre>
82 |  chrono init [name]
83 |  -> message 1: x.xxxs
84 |  -> message 2: x.xxxs
85 |  -> message n: x.xxxs
86 | </pre>
87 | <pre>
88 | chrono table [name]
89 | -------------------------------------------------------
90 |  unit - action                                 duration
91 | -------------------------------------------------------
92 |     1 - message 1                                x.xxxs
93 |  x.xx - message 2                                x.xxxs
94 |  x.xx - message n                                x.xxxs
95 | </pre>


--------------------------------------------------------------------------------