Init

devidw · devidw · commit 33905b0292f0 · 2022-02-04T21:14:23.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+.DS_STORE
+
+/vendor/
diff --git a/README.adoc b/README.adoc
@@ -0,0 +1,29 @@
+= Debug
+
+A PHP libary for debugging.
+
+
+== Installation
+You can install the libary with `composer`:
+
+[source,zsh]
+----
+composer require devidw/debug
+----
+
+
+== Usage
+[source,php]
+----
+require_once __DIR__ . '/vendor/autoload.php';
+
+use DevidW\Debug\Debug;
+
+Debug::dump($var);
+----
+
+
+***
+
+
+Syntax highlighting is done using https://highlightjs.org/[highlight.js] and the _Atom One Dark_ Theme.
diff --git a/composer.json b/composer.json
@@ -0,0 +1,18 @@
+{
+    "name": "devidw/debug",
+    "description": "A PHP libary for debugging.",
+    "type": "library",
+    "license": "MIT",
+    "autoload": {
+        "psr-4": {
+            "Devidw\\Debug\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "David Wolf",
+            "email": "david@wolf.gdn"
+        }
+    ],
+    "require": {}
+}
diff --git a/src/Debug.php b/src/Debug.php
@@ -0,0 +1,38 @@
+<?php
+
+namespace Devidw\Debug;
+
+/**
+ * Class Debug
+ * 
+ * @package Devidw\Debug
+ * @version 1.0.0
+ */
+class Debug
+{
+    /**
+     * Dump the given variable
+     * 
+     * @since 1.0.0
+     * 
+     * @param mixed $var The variable to dump
+     * @param bool $die Whether to die after dumping
+     * 
+     * @return void
+     */
+    public static function dump(mixed $var, $die = true): void
+    {
+        $dump = var_export($var, true);
+
+        echo <<<HTML
+        <pre><code class="language-php">{$dump}</code></pre>
+        <link rel="stylesheet" href="https://highlightjs.org/static/demo/styles/atom-one-dark.css">
+        <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.4.0/highlight.min.js"></script>
+        <script>hljs.highlightAll()</script>
+        HTML;
+
+        if ($die) {
+            die;
+        }
+    }
+}
diff --git a/tests/test.php b/tests/test.php
@@ -0,0 +1,12 @@
+<?php
+
+require_once dirname(__DIR__) . '/vendor/autoload.php';
+
+
+use Devidw\Debug\Debug;
+
+Debug::dump([
+    'foo' => 'bar',
+    'object' => new stdClass(),
+    'init' => ini_get_all(),
+]);
