Added VarDumper functions.

Functions:  vdump(), vd(), vdd(), vddd()

Includes styling option for the HTML Dumper.

Author: hellofromtonya

composer.json

@@ -23,6 +23,18 @@
 	"config": {
 		"sort-order": true
 	},
+	"autoload": {
+		"files": [
+			"src/functions.php",
+			"src/class-admin-bar.php"
+		],
+		"psr-4": {
+			"KnowTheCode\\DebugToolkit\\": "src"
+		},
+		"exclude-from-classmap": [
+			"/tests/"
+		]
+	},
 	"autoload-dev": {
 		"psr-4": {
 			"KnowTheCode\\DebugToolkit\\Tests\\": "tests/"

composer.lock

@@ -0,0 +1,25 @@
+<?php
+/**
+ * VarDumper Runtime Configuration Parameters.
+ *
+ * @package     KnowTheCode\DebugToolkit
+ * @since       1.0.0
+ * @author      hellofromTonya
+ * @link        https://github.com/KnowTheCode/debug-toolkit
+ * @license     GNU-2.0+
+ */
+
+return [
+	'styles' => [
+		'default'   => 'background-color:#1c202c; color:#f2f2f2; font-size:18px;  word-wrap: break-word; white-space: pre-wrap; position:relative; z-index:99999; word-break: break-all;',
+		'num'       => 'font-weight:bold; color:#a8def7',
+		'note'      => 'color:#a8def7',
+		'index'     => 'color:#a8def7',
+		'str'       => 'font-weight:bold; color:#6FDD16',
+		'key'       => 'color:#6FDD16',
+		'meta'      => 'color:#E4EC42',
+		'public'    => 'color:#E4EC42',
+		'protected' => 'color:#E4EC42',
+		'private'   => 'color:#E4EC42',
+	],
+];

config/var-dumper.php

@@ -44,21 +44,23 @@ function render_php_version_admin_notice() {
  * Gets the plugin's root directory.
  *
  * @since 1.0.0
+ * @access private
  *
  * @return string
  */
 function _get_plugin_root_dir() {
 	return __DIR__;
 }
 
+// Load the files and Composer.
+require_once __DIR__ . '/vendor/autoload.php';
+
 /**
  * Load the Admin Bar.
  *
  * @since 1.0.0
  */
 function load_admin_bar() {
-	require_once __DIR__ . '/src/class-admin-bar.php';
-
 	/**
 	 * Filter the admin bar configuration parameters.
 	 *
@@ -71,5 +73,4 @@ function load_admin_bar() {
 	( new Admin_Bar( $config ) )->init();
 }
 
-require_once __DIR__ . '/vendor/autoload.php';
 load_admin_bar();

debug-toolkit.php

@@ -0,0 +1,177 @@
+<?php
+/**
+ * VarDumper Functions - used in your code:
+ *      vdump()
+ *      vd()
+ *      vdd()
+ *      vddd()
+ *
+ * Note: The `v` prefix separates it from the Kint version.
+ *
+ * @package     KnowTheCode\DebugToolkit
+ * @since       1.0.0
+ * @author      hellofromTonya
+ * @link        https://github.com/KnowTheCode/debug-toolkit
+ * @license     GNU-2.0+
+ */
+
+use Symfony\Component\VarDumper\Cloner\VarCloner;
+use Symfony\Component\VarDumper\Dumper\HtmlDumper;
+use Symfony\Component\VarDumper\VarDumper;
+use function KnowTheCode\DebugToolkit\_get_plugin_root_dir;
+
+if ( ! function_exists( 'vdump' ) ) {
+	/**
+	 * Dumps the given variable(s).
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $var Variable to dump.
+	 *
+	 * @throws InvalidArgumentException If no arguments are passed, throws an error.
+	 */
+	function vdump( $var ) {
+		_dump_var( $var, __FUNCTION__ );
+	}
+}
+
+if ( ! function_exists( 'vd' ) ) {
+	/**
+	 * Dumps the given variable(s).
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $var Variable to dump.
+	 *
+	 * @throws InvalidArgumentException If no arguments are passed, throws an error.
+	 */
+	function vd( $var ) {
+		_dump_var( $var, __FUNCTION__ );
+	}
+}
+
+if ( ! function_exists( 'vdd' ) ) {
+	/**
+	 * Dumps the given variable(s) and then ends the execution of the program.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $var Variable to dump.
+	 *
+	 * @throws InvalidArgumentException If no arguments are passed, throws an error.
+	 */
+	function vdd( $var ) {
+		_dump_var( $var, __FUNCTION__ );
+		die();
+	}
+}
+
+if ( ! function_exists( 'vddd' ) ) {
+	/**
+	 * Dumps the given variable(s) and then ends the execution of the program.
+	 *
+	 * @since 1.0.0
+	 *
+	 * @param mixed $var Variable to dump.
+	 *
+	 * @throws InvalidArgumentException If no arguments are passed, throws an error.
+	 */
+	function vddd( $var ) {
+		_dump_var( $var, __FUNCTION__ );
+		die();
+	}
+}
+
+/**
+ * Run the var dumper.
+ *
+ * @since  1.0.0
+ * @access private
+ *
+ * @param mixed  $var       Variable to dump.
+ * @param string $func_name Name of the calling function.
+ *
+ * @throws InvalidArgumentException If no arguments are passed, throws an error.
+ */
+function _dump_var( $var, $func_name ) {
+
+	if ( empty( $var ) ) {
+		$message = __( 'No variable passed to the VarDumper function', 'devtoolkit' );
+		throw new InvalidArgumentException( esc_html( "{$message} {$func_name}" ) );
+		die();
+	}
+
+	_set_html_dumper_styles();
+	VarDumper::dump( $var );
+}
+
+/**
+ * Sets the VarDumper HTML Dumper's styles.
+ *
+ * @since  1.0.0
+ * @access private
+ *
+ * @return null bails out when cli or handler is already set.
+ */
+function _set_html_dumper_styles() {
+	static $handler = null;
+
+	// Bail out.
+	if ( in_array( PHP_SAPI, [ 'cli', 'phpdbg' ], true ) ) {
+		return;
+	}
+
+	if ( null !== $handler ) {
+		return;
+	}
+
+	$cloner = new VarCloner();
+	$dumper = new HtmlDumper();
+
+	$dumper->setStyles( _get_vardumper_config( 'styles' ) );
+	$handler = function( $var ) use ( $cloner, $dumper ) {
+		$dumper->dump( $cloner->cloneVar( $var ) );
+	};
+
+	VarDumper::setHandler( $handler );
+}
+
+/**
+ * Gets the VarDumper's configuration or a specific configuration parameter.
+ *
+ * @since  1.0.0
+ * @access private
+ *
+ * @param string $key Optional. Parameter's key to return.
+ *
+ * @return mixed
+ * @throw  InvalidArgumentException If the key does not exist, an error is thrown.
+ */
+function _get_vardumper_config( $key = '' ) {
+	static $config = null;
+
+	if ( empty( $config ) ) {
+		/**
+		 * Filter the VarDumper configuration parameters.
+		 *
+		 * @since 1.0.0
+		 *
+		 * @param array Array of configuration parameters for the VarDump component.
+		 */
+		$config = apply_filters( 'set_html_dumper_config', (array) require _get_plugin_root_dir() . '/config/var-dumper.php' );
+	}
+
+	if ( empty( $key ) ) {
+		return $config;
+	}
+
+	if ( ! array_key_exists( $key, $config ) ) {
+		$message = __( 'The key [$s] does not exist in the config:', 'devtoolkit' );
+		$message = sprintf( $message, $key );
+		throw new InvalidArgumentException(
+			esc_html( $message . ': ' ) . print_r( $config, true )
+		);
+	}
+
+	return $config[ $key ];
+}