Download the PHP
package inanepain/dumper without Composer
On this page you can find all versions of the php package
inanepain/dumper. It is possible to download/install
these versions without Composer. Possible dependencies are resolved
automatically.
Vendor inanepain Package dumper Short Description A little tool to help with debugging by writing a `var_dump` like message unobtrusively into a collapsible panel at the bottom of a page. License
UNLICENSE Homepage https://vaieen.local:3000/inane/dumper
After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.
Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories.
In this case some credentials are needed to access such packages.
Please use the auth.json textarea to insert credentials, if a package is coming from a private repository.
You can look here for more information.
Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?
Informations about the package dumper
= Dumper
:author: Philip Michael Raab
:email: [email protected]
:revnumber: 1.13.1
:revdate: 2023-05-26
:experimental:
:icons: font
:source-highlighter: highlight.js
:sectnums: |,all|
:toc: auto
== Overview
A little tool to help with debugging by writing a var_dump like message unobtrusively to a collapsible panel at the bottom of a page.
== Install
[source,shell]
$ composer require inanepain/dumper
:leveloffset: +1
= Basic Usage
:author: Philip Michael Raab
:email: [email protected]
:revnumber: 1.13.1
:revdate: 2023-05-26
:experimental:
:icons: font
:source-highlighter: highlight.js
:toc: auto
Dumper works right out the box. Once installed via composer you can use it straight away to dump your objects using either method; dump or assert on the \Inane\Dumper\Dumper object.
The dump method is the default method and logs what it is given. Where as the assert has a test for its first parameter and only logs if the test fails (falsy).
<1> Logs if error is *true*
== Ease of use
Dumper registers the shortcut functions `dd` and `da` that work just like calling `\Inane\Dumper\Dumper::dump()` or `\Inane\Dumper\Dumper::assert()`.
WARNING: Dumper does not overwrite existing functions. So if either `dd` or `da` are already taken, Dumper will skip them. See *Dumper: Aliases* <> on creating your own custom alias functions.
.basic shortcut usage
[source,php]
----
dd($data, 'After marge process');
da(!$data->error, $data, 'After marge process'); // <1>
----
<1> Logs if error is *true*
:leveloffset!:
== Getting more out of Dumper
:sectnums:
:view-mode: project
Some more or less helpful hints and tips regarding to usage of `Dumper`.
***
* link:doc/aliases.adoc[custom aliases]
* link:doc/configuration.adoc[configuration]
* link:doc/ui.adoc[ui]
* link:doc/silence.adoc[silence]
***
:leveloffset: +2
= Dumper: Aliases
:author: Philip Michael Raab
:email:
:revnumber: 1.13.1
:revdate: 2023-05-26
:experimental:
:icons: font
:source-highlighter: highlight.js
:toc: auto
Creating a custom global function as an alias to `\Inane\Dumper\Dumper::dump` method.
TIP: *ext-runkit7* required to register global functions. Without it the function is stored in a variable instead.
.Creating a custom alias for Dumper
[source,php]
----
\Inane\Dumper\Dumper::dumper('kickIt', 'shErr');
// you can now use your `kickIt` function the same as the `dump` method.
kickIt($data, 'Data after...'); // <1>
// what about `shErr`?
shErr(!$data->error, $data, 'Data after...'); // <2>
// without *ext-runkit7*. Note the $kickIt is a variable.
$kickIt($data, 'Data after...');
$shErr(!$data->error, $data, 'Data after...'); // <2>
----
<1> The first parameter of the dumper method creates `dump` aliases akin to the `dd` function.
<2> The second parameter sets the alias for `assert` akin to `da`.
That's how easy it is to create a custom global shortcut function for Dumper.
:leveloffset!:
***
:leveloffset: +2
= Dumper: Configuration
:author: Philip Michael Raab
:email:
:revnumber: 1.13.1
:revdate: 2023-05-26
:experimental:
:icons: font
:source-highlighter: highlight.js
:toc: auto
Dumper has a few static public properties you can use to change some of the default behaviours.
== enabled
Dumper starts enabled but should you wish all Dumpers related content gone. Disable it here.
default: `true`
.config: turn off Dumper's output
[source,php]
----
\Inane\Dumper\Dumper::$enabled = false;
----
== bufferOutput
Write dumps last. Just before php terminates. Set to `false` to have dumps inserted as the occur at runtime.
TIP: This is mostly useful when running console code.
default: `true`
.config: turn off buffered output to print dumps inline
[source,php]
----
// Somewhere before using Dumper, or even after for a section of code and then turn buffer on again.
\Inane\Dumper\Dumper::$bufferOutput = false;
// some code loop probably
\Inane\Dumper\Dumper::$bufferOutput = true;
----
== useVarExport
By default Dumper uses its own variable parser to generate the output. Here you can tell Dumper to use `var_export` instead.
default: `false`
.config: set dumper to use var_export
[source,php]
----
// set value to true
\Inane\Dumper\Dumper::$useVarExport = true;
----
// tag::configHighlight[]
== highlight
Set the colour theme dumper uses. The default is to use the colours already set in your php.ini file.
default: `\Inane\Stdlib\Highlight::CURRENT`
. Available colours in `\Inane\Stdlib\Highlight`
* CURRENT
* DEFAULT
* PHP2
* HTML
.config: set dumper colours
[source,php]
----
// set colour theme
\Inane\Dumper\Dumper::$highlight = \Inane\Stdlib\Highlight::PHP2;
----
// end::configHighlight[]
// tag::configExpanded[]
== expanded
NOTE: *Since*: 1.8.0
Controls the initial expanded state of the Dumper panel.
default: `false`
.config: dumper log panel initial state
[source,php]
----
// Create the Dumper panel expanded
\Inane\Dumper\Dumper::$expanded = true;
----
// end::configExpanded[]
// tag::configSetColours[]
== setColours
NOTE: *Since*: 1.14.0
Allows setting custom cli colours or disabling cli colours completely.
.default:
[source,php]
----
[
'reset' => "\033[0m", # console default
'dumper' => "\033[35m", # magenta
'label' => "\033[34m", # blue
'file' => "\033[97m", # while
'line' => "\033[31m", # red
'divider' => "\033[33m", # yellow
];
----
.config: setting cli colours
[source,php]
----
// Remove cli colouring
\Inane\Dumper\Dumper::setConsoleColours(false);
// Setting default colours
\Inane\Dumper\Dumper::setConsoleColours([]);
// Remove cli colouring
\Inane\Dumper\Dumper::setConsoleColours(false);
// creating a colour using Pencil from `inanepain/cli`
$label = new \Inane\Cli\Pencil(colour: \Inane\Cli\Pencil\Colour::Green, background: \Inane\Cli\Pencil\Colour::Red, style: \Inane\Cli\Pencil\Style::SlowBlink);
// Then set colours for **file**, **label** and **reset**
\Inane\Dumper\Dumper::setConsoleColours([
'file' => "\033[36m",
'label' => "$label",
'reset' => "\033[0m",
]);
----
// end::configSetColours[]
:leveloffset!:
***
:leveloffset: +2
= Dumper: UI
:author: Philip Michael Raab
:email:
:revnumber: 1.13.1
:revdate: 2023-05-26
:experimental:
:icons: font
:source-highlighter: highlight.js
:toc: auto
Customising Dumpers look and feel.
== Panel
This is done by setting the values of the following *css variables* and a few php *class properties*.
=== font size
Adjust the font size used by the Dumper panel.
* variable: `--dumper-font-size`
* default: `smaller`
=== max height
Adjust the maximum height allowed of the Dumper panel when opened.
* variable: `--dumper-max-height`
* default: `80vh`
:leveloffset: +1
== expanded
NOTE: *Since*: 1.8.0
Controls the initial expanded state of the Dumper panel.
default: `false`
.config: dumper log panel initial state
[source,php]
----
// Create the Dumper panel expanded
\Inane\Dumper\Dumper::$expanded = true;
----
:leveloffset: 2
== Theme
Switching Dumpers theme is done in the php by changing a static property on the Dumper object.
:leveloffset: +1
== highlight
Set the colour theme dumper uses. The default is to use the colours already set in your php.ini file.
default: `\Inane\Stdlib\Highlight::CURRENT`
. Available colours in `\Inane\Stdlib\Highlight`
* CURRENT
* DEFAULT
* PHP2
* HTML
.config: set dumper colours
[source,php]
----
// set colour theme
\Inane\Dumper\Dumper::$highlight = \Inane\Stdlib\Highlight::PHP2;
----
:leveloffset: 2
:leveloffset!:
***
:leveloffset: +2
= Dumper: Silence
:author: Philip Michael Raab
:email:
:revnumber: 1.13.1
:revdate: 2023-05-26
:experimental:
:icons: font
:source-highlighter: highlight.js
:toc: auto
You can use the `\Inane\Dumper\Silence` attribute to silence dumps, silence a specified number of dumps, only show a specified number of dumps then go silent, per *class*, *method* or *function*. The Silence attribute also allows you to set Silence's initial state and then set a counter after which the state will toggle.
NOTE: If a class is silenced all functions are silenced regardless of their individual settings.
.Basic Silence Usage
[source,php]
----
use Inane\Dumper\Silence as DumperSilence;
#[DumperSilence()]
function doFirst(): void {
echo 'hello', PHP_EOL;
dd(__FUNCTION__, 'one');
dd(__FUNCTION__, 'two');
}
#[DumperSilence(false)]
function doSecond(): void {
echo 'hello', PHP_EOL;
dd(__FUNCTION__, 'one');
dd(__FUNCTION__, 'two');
}
doFirst(); // <1>
// hello
doSecond(); // <2>
// hello
// doSecond, one
// doSecond, two
----
<1> This only outputs the `echo`. The `dd`'s are ignored.
<2> Here the `echo` and `dd` output is displayed.
== Toggling State
This feature of Silence lets you either enable or disable dumping after a specified number of dump requests have been made. This lets you log only a few items when iterating over a large collection.
If you specify a limit, Silence's second parameter, the Silence instance will toggle its value after it has received that many check requests. i.e. Silent becomes verbose and vice versa.
NOTE: The toggle only happens once. *NOT* every time the limit is reached.
TIP: The is an issue logged to pass an array in place of an limit that sets when to toggle and how long the toggle should remain active.
.Toggle Silence Usage
[source,php]
----
use Inane\Dumper\Silence as DumperSilence;
#[DumperSilence(false, 1)]
function doFirst(): void {
echo 'hello', PHP_EOL;
dd(__FUNCTION__, 'one');
dd(__FUNCTION__, 'two');
}
#[DumperSilence(true, 1)]
function doSecond(): void {
echo 'hello', PHP_EOL;
dd(__FUNCTION__, 'one');
dd(__FUNCTION__, 'two');
}
doFirst(); // <1>
// hello
// doFirst, two
doSecond(); // <2>
// hello
// doSecond, one
----
<1> Now we have the `echo` and the value from the first `dd` request. Silence toggled *false* to *true* after *1* request so the second `dd` request was ignored.
<2> This is the reverse of the first. Here only the first `dd` request is shown.
== Advanced: Logging Silence checks
Actually geeky stuff would be a better way to describe this section. By default Silence checks are not shown in the Dumper panel but this can be enabled if you want to figure out why your toggles are not doing what you expect them to do.
To enable this this is one simple step, add `Type::Silence` to the `Dumper::$additionalTypes` array.
.Logging Silence Requests
[source,php]
----
Dumper::$additionalTypes[] = Type::Silence; // <1>
// code
Dumper::$additionalTypes = []; // <2>
----
<1> future Silence checks will be shown in the Dumper panel.
<2> and Silence checks after this will no longer show in the Dumper panel.
=== Customising Silence checks
You can customise the Silence check logs per Silence instance to make them stand out from the rest by giving it a custom *label* and *colour*.
.Customising Silence Logs
[source,php]
----
#[Silence(on: true, config: [
'label' => 'Do Test This', // <1>
'colour' => 'purple', // <2>
])]
function doThis(): void {
dd(null, 'Dump nothing important'); // <3>
}
doThis(); // <4>
doThis(); // <4>
doThis(); // <4>
----
<1> set custom label to appear in Dumper panel.
<2> set custom colour for log entry in Dumper panel.
<3> this will not be show due to Silence
<4> a purple entry labelled *Do Test This* will be added every time this function is called
:leveloffset!:
Requiresphp Version
>=8.1 inanepain/stdlib Version
>=0.3.1 || dev-master || dev-develop
Composer command for our command line client (download client)This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free.Standard composer command
The package inanepain/dumper contains the following files
Loading the files please wait ....
Loading please wait ...
Before you can download the PHP files, the dependencies should be resolved. This can take some minutes. Please be patient.
