initial commit

php-sage · May 16, 2012 · 3c49968 · 3c49968
1 parent 1306d2b
commit 3c49968
Show file tree

Hide file tree

Showing 24 changed files with 2,561 additions and 0 deletions.
diff --git a/config.default.php b/config.default.php
@@ -0,0 +1,140 @@
+<?php
+isset( $GLOBALS['_kint_settings'] ) or $GLOBALS['_kint_settings'] = array();
+$_kintSettings = &$GLOBALS['_kint_settings'];
+
+
+/** @var bool if set to false, kint will become silent, same as Kint::enabled(false) */
+$_kintSettings['enabled'] = true;
+
+
+/**
+ * @var array custom added data dumpers
+ *
+ * format:
+ *  array(
+ *    "datatypes class name" => < mixed options >
+ *  )
+ */
+$_kintSettings['customDataTypes'] = array(
+	/**
+	 * @var string one of three values: 'off', 'non-scalar', 'on'. When a passed array is detected to contain tabular data,
+	 * it can be displayed as a table instead of vertically. Note, the detection algorithms are quite naive as they check
+	 * only the first couple of rows for the tabular data pattern. However it will never stop any piece of data from showing
+	 * up even if the array is not tabular after all. In the worst case scenario, it will look a little weird.
+	 *
+	 * - off: will never use the tabular display
+	 * - non-scalar: will display in tabular view only if the table contains strings and numeric values (no arrays, objects)
+	 * - on: will display all detected tabular data in a table
+	 */
+	'tabularArray' => 'non-scalar',
+	'splFileInfo'  => null,
+	'json'  => null,
+);
+
+
+/**
+ * @var bool whether to display where kint was called from
+ */
+$_kintSettings['displayCalledFrom'] = true;
+
+/**
+ * @var callback filter/skip display of trace entries
+ *
+ * @param string   $file filename where the function was called
+ * @param int      $line [OPTIONAL] the line number in the file (not applicable when used in resource dumps)
+ *
+ * @return string html - escaped string
+ *
+ * [!] EXAMPLE:
+ *
+ * $_kintSettings['pathDisplayCallback'] = function( $file, $line = NULL ) {
+ *     $shortenedName = strpos( $file, $_SERVER['DOCUMENT_ROOT'] ) === 0
+ *         ? 'DOCUMENT_ROOT' . DIRECTORY_SEPARATOR . substr( $file, strlen( $_SERVER['DOCUMENT_ROOT'] ) )
+ *         : $file;
+ *
+ *     if ( !$line ) { // means this is called from resource type dump
+ *         return $shortenedName;
+ *     }
+ *
+ *     return "<u><a class=\"kint-ide-link\" href=\"http://localhost:8091/?message={$file}:{$line}\">"
+ *         . $shortenedName
+ *         . "</a></u> line <i>{$line}</i>";
+ * };
+ */
+$_kintSettings['pathDisplayCallback'] = null;
+
+
+/**
+ * @var callback|null
+ *
+ * @param array $step each step of the backtrace is passed to this callback to clean it up or skip it entirely
+ *
+ * @return array|null you can return null if you want to bypass outputting this step
+ *
+ * [!] EXAMPLE:
+ *
+ * $_kintSettings['traceCleanupCallback'] = function( $traceStep ) {
+ *      if ( isset( $traceStep['class'] ) && strtolower( $traceStep['class'] ) === 'errorHandler' ) {
+ *           return null;
+ *      }
+ *
+ *      if ( isset( $traceStep['function'] ) && strtolower( $traceStep['function'] ) === '__tostring' ) {
+ *          $traceStep['function'] = "[object converted to string]";
+ *      }
+ *
+ *       return $traceStep;
+ * };
+ */
+$_kintSettings['traceCleanupCallback'] = null;
+
+
+/** @var int max length of string before it is truncated and displayed separately in full */
+$_kintSettings['maxStrLength'] = 60;
+
+
+/** @var bool whether to add a right colored gutter based on the location of the call to the dump */
+$_kintSettings['colorCodeLoops'] = true;
+
+
+/** @var int max array/object levels to go deep, if zero no limits are applied */
+$_kintSettings['maxLevels'] = 5;
+
+
+/** @var bool whether dumped indexed arrays that are in ideal sequence are displayed */
+$_kintSettings['hideSequentialKeys'] = true;
+
+
+/** @var string|null if set, prepends a <head> tag with appropriate meta charset value */
+$_kintSettings['charset'] = null;
+
+
+/**
+ * @var callback filters array/object keys before outputting; return false if you do not wish to see it in the output
+ *
+ * @param string $key the key being output
+ * @param mixed  $val the contents of the dumped element in case you need it
+ *
+ * @return bool return false to skip displaying
+ *
+ * [!] EXAMPLE:
+ *
+ * $_kintSettings['keyFilterCallback'] = function( $key, $val ) {
+ *     if ( preg_match( '#_mt$#', $key ) ) {
+ *         return false;
+ *     }
+ *
+ *     if ( $val === '--testing--' ) {
+ *         return false;
+ *     }
+ *
+ *     // no need to return true to continue output
+ * };
+ *
+ */
+$_kintSettings['keyFilterCallback'] = null;
+
+
+/** @var bool only set to true if you want to develop kint and know what you're doing */
+$_kintSettings['devel'] = true;
+
+unset( $_kintSettings );
diff --git a/config.php b/config.php
@@ -0,0 +1,143 @@
+<?php
+isset( $GLOBALS['_kint_settings'] ) or $GLOBALS['_kint_settings'] = array();
+$_kintSettings = &$GLOBALS['_kint_settings'];
+
+
+/** @var bool if set to false, kint will become silent, same as Kint::enabled(false) */
+$_kintSettings['enabled'] = true;
+
+
+/**
+ * @var bool whether to display where kint was called from
+ */
+$_kintSettings['displayCalledFrom'] = true;
+
+
+
+/**
+ * @var callback filter/skip display of trace entries
+ *
+ * @param string   $file filename where the function was called
+ * @param int      $line [OPTIONAL] the line number in the file (not applicable when used in resource dumps)
+ *
+ * @return string html - escaped string
+ *
+ * [!] EXAMPLE:
+ *
+ * $_kintSettings['pathDisplayCallback'] = function( $file, $line = NULL ) {
+ *     $shortenedName = strpos( $file, $_SERVER['DOCUMENT_ROOT'] ) === 0
+ *         ? 'DOCUMENT_ROOT' . DIRECTORY_SEPARATOR . substr( $file, strlen( $_SERVER['DOCUMENT_ROOT'] ) )
+ *         : $file;
+ *
+ *     if ( !$line ) { // means this is called from resource type dump
+ *         return $shortenedName;
+ *     }
+ *
+ *     return "<u><a class=\"kint-ide-link\" href=\"http://localhost:8091/?message={$file}:{$line}\">"
+ *         . $shortenedName
+ *         . "</a></u> line <i>{$line}</i>";
+ * };
+ */
+$_kintSettings['pathDisplayCallback'] = "_kintLine";
+
+
+/**
+ * @var callback|null
+ *
+ * @param array $step each step of the backtrace is passed to this callback to clean it up or skip it entirely
+ *
+ * @return array|null you can return null if you want to bypass outputting this step
+ *
+ * [!] EXAMPLE:
+ *
+ * $_kintSettings['traceCleanupCallback'] = function( $traceStep ) {
+ *      if ( isset( $traceStep['class'] ) && strtolower( $traceStep['class'] ) === 'errorHandler' ) {
+ *           return null;
+ *      }
+ *
+ *      if ( isset( $traceStep['function'] ) && strtolower( $traceStep['function'] ) === '__tostring' ) {
+ *          $traceStep['function'] = "[object converted to string]";
+ *      }
+ *
+ *       return $traceStep;
+ * };
+ */
+$_kintSettings['traceCleanupCallback'] = null;
+
+
+/** @var int max length of string before it is truncated and displayed separately in full */
+$_kintSettings['maxStrLength'] = 60;
+
+
+/** @var bool whether to add a right colored gutter based on the location of the call to the dump */
+$_kintSettings['colorCodeLoops'] = true;
+
+
+/** @var int max array/object levels to go deep, if zero no limits are applied */
+$_kintSettings['maxLevels'] = 5;
+
+
+/** @var bool whether dumped indexed arrays that are in ideal sequence are displayed */
+$_kintSettings['hideSequentialKeys'] = true;
+
+
+/** @var string|null if set, prepends a <head> tag with appropriate meta charset value */
+$_kintSettings['charset'] = null;
+
+
+/**
+ * @var callback filters array/object keys before outputting; return false if you do not wish to see it in the output.
+ * NOTE, object member keys will be passed here too. The object is first cast to array so read this:
+ * http://www.php.net/manual/en/language.types.array.php#language.types.array.casting
+ *
+ * @param string $key the key being output
+ * @param mixed  $val the contents of the dumped element in case you need it
+ *
+ * @return bool return false to skip displaying
+ *
+ * [!] EXAMPLE:
+ *
+ * $_kintSettings['keyFilterCallback'] = function( $key, $val ) {
+ *     if ( preg_match( '#_mt$#', $key ) ) {
+ *         return false;
+ *     }
+ *
+ *     if ( $val === '--testing--' ) {
+ *         return false;
+ *     }
+ *
+ *     // no need to return true to continue output
+ * };
+ *
+ */
+$_kintSettings['keyFilterCallback'] = null;
+
+
+/** @var bool only set to true if you want to develop kint and know what you're doing */
+$_kintSettings['devel'] = true;
+
+unset( $_kintSettings );
+
+
+/**
+ * This is used with PHPstorm and its remotecall plugin to click file links in browser that will open the IDE in the
+ * appropriate place in code.
+ *
+ * @param string $file
+ * @param int    $line
+ *
+ * @return string
+ */
+function _kintLine( $file, $line = NULL )
+{
+	$shortenedName = error::debug_path( $file );
+
+	if ( !$line ) { // means this is called from resource type dump
+		return $shortenedName;
+	}
+
+
+	return "<u><a class=\"kint-ide-link\" href=\"http://localhost:8091/?message={$file}:{$line}\">"
+		. $shortenedName
+		. "</a></u> line <i>{$line}</i>";
+}
diff --git a/decorators/concise.php b/decorators/concise.php
@@ -0,0 +1,54 @@
+<?php
+class kintConciseDecorator extends Kint
+{
+	/**
+	 * output:
+	 *
+	 * [value]
+	 *
+	 * value [title="[access] [name] [operator *] [subtype] [size] "]
+	 * OR
+	 * type [title="[access] [name] type [operator *] [subtype] [size] "]
+	 * <ul>extendedValue
+	 *
+	 * @param kintParser $kintVar
+	 *
+	 * @return string
+	 */
+	public static function decorate( kintParser $kintVar )
+	{
+		if ( is_array( $kintVar->value ) || $kintVar->extendedValue !== null ) {
+			return self::$_richDecorator->decorate( $kintVar );
+		}
+
+		$output = '<span title="';
+
+		if ( $kintVar->access !== null ) {
+			$output .= $kintVar->access . " ";
+		}
+
+		if ( $kintVar->name !== null ) {
+			$output .= $kintVar->name . " ";
+		}
+
+		if ( $kintVar->type !== null ) {
+			$output .= $kintVar->type;
+			if ( $kintVar->subtype !== null ) {
+				$output .= " " . $kintVar->subtype;
+			}
+			$output .= " ";
+		}
+
+		if ( $kintVar->operator !== null ) {
+			$output .= $kintVar->operator . "";
+		}
+
+		if ( $kintVar->size !== null ) {
+			$output .= "(" . $kintVar->size . ") ";
+		}
+
+		$output .= '">' . $kintVar->value . '</span>';
+
+		return $output;
+	}
+}
diff --git a/decorators/plain.php b/decorators/plain.php
@@ -0,0 +1,54 @@
+<?php
+class kintPlainDecorator extends Kint
+{
+	/**
+	 * output:
+	 *
+	 * [access *] [name] type [operator *] [subtype] [size] [value]
+	 *
+	 * @param kintParser $kintVar
+	 *
+	 * @return string
+	 */
+	protected static function decorate( $kintVar )
+	{
+	}
+
+
+	/**
+	 * produces css and js required for display. May be called multiple times, will only produce output once per
+	 * pageload or until `-` or `@` modifier is used
+	 *
+	 * @return string
+	 */
+	protected static function _css()
+	{
+	}
+
+
+
+	/**
+	 * called for each dump, opens the html tag
+	 *
+	 * @param array $callee caller information taken from debug backtrace
+	 *
+	 * @return string
+	 */
+	protected static function _wrapStart( $callee )
+	{
+	}
+
+
+	/**
+	 * closes Kint::_wrapStart() started html tags and displays callee information
+	 *
+	 * @param array $callee caller information taken from debug backtrace
+	 * @param array $prevCaller previous caller information taken from debug backtrace
+	 *
+	 * @return string
+	 */
+	private static function _wrapEnd( $callee, $prevCaller )
+	{
+	}
+
+}