https://github.com/ghostff/dump5
A pretty version of php(5+) var_dump
https://github.com/ghostff/dump5
cgi debug dump php php-cli php53 pretty-data-dump
Last synced: 10 months ago
JSON representation
A pretty version of php(5+) var_dump
- Host: GitHub
- URL: https://github.com/ghostff/dump5
- Owner: Ghostff
- License: other
- Created: 2016-05-31T22:23:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T17:39:16.000Z (over 1 year ago)
- Last Synced: 2025-04-09T20:02:30.335Z (10 months ago)
- Topics: cgi, debug, dump, php, php-cli, php53, pretty-data-dump
- Language: PHP
- Homepage:
- Size: 1.33 MB
- Stars: 20
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pretty Data Dump
A pretty version of php [var_dump](http://php.net/manual/en/function.var-dump.php). This class displays structured information about one or more expressions that includes its type and value.
_Check out [Dump7](https://github.com/Ghostff/Dump7) for PHP 7+_
# Installation
You can download the Latest [release version ](https://github.com/Ghostff/pretty_data_dump/releases/) as a standalone, alternatively you can use [Composer](https://getcomposer.org/)
```json
composer require ghostff/dump5
```
```json
"require": {
"ghostff/dump5": "^1.0"
}
```
# Display Flags
You can simple hide or show some object attribute using a Doc block flag:
| | |
|-------------------------------|---------------------------------------------------|
| `@dumpignore-inheritance` | Hides inherited class properties. |
| `@dumpignore-inherited-class` | Hides the class name from inherited properties. |
| `@dumpignore-private` | Show all properties except the **private** ones. |
| `@dumpignore-protected` | Show all properties except the **protected** ones.|
| `@dumpignore-public` | Show all properties except the **public** ones. |
| `@dumpignore` | Hide the property the Doc comment belongs to. |
```php
/**
* @dumpignore-inheritance
* @dumpignore-inherited-class
* @dumpignore-private
* @dumpignore-public
* @dumpignore-public
*/
Class Foo extends Bar {
/** @dumpignore */
public $big_object = null;
}
```
# Usage
```php
class FooBar
{
private $inherited_int = 123;
private $inherited_array = array('string');
}
class Bar extends FooBar
{
private $inherited_float = 0.22;
private $inherited_bool = true;
}
class Foo extends Bar
{
private $string = 'string';
protected $int = 10;
public $array = array(
'foo' => 'bar'
);
protected static $bool = false;
}
$string = 'Foobar';
$array = array('foo', 'bar');
$int = 327626;
$double = 22.223;
$null = null;
$bool = true;
$resource = fopen('LICENSE', 'r');
$m = microtime(true);
new Dump(new Foo, $string, $array, $int, $double, $null, $bool, array(
'foo' => 'bar',
'bar' => 'foo',
array(
'foo' => 'foobar',
'bar_foo',
2 => 'foo',
'foo' => array(
'barbar' => 55,
'foofoo' => false,
'foobar' => null,
)
)
), $resource);
new Dump(1 == '1', 1 === '1');
```
Replacing predefined colors:
```php
# set($name, [$cgi_color, $cli_color]);
Dump::set('boolean', array('bb02ff', 'purple'));
```
CGI output:
CLI Posix output:
Windows user who are using command line tools like `cmder` can use the `Dump::d` method:
```php
Dump::d(new Foo, $string, $array, $int, $double, $null, $bool, array(
'foo' => 'bar',
'bar' => 'foo',
array(
'foo' => 'foobar',
'bar_foo',
2 => 'foo',
'foo' => array(
'barbar' => 55,
'foofoo' => false,
'foobar' => null,
)
)
));
```
CLI Windows output:
