https://github.com/yiisoft/var-dumper
Helper for dumping variable for debug purposes
https://github.com/yiisoft/var-dumper
debug debugging dump hacktoberfest vardump vardumper yii3
Last synced: 4 months ago
JSON representation
Helper for dumping variable for debug purposes
- Host: GitHub
- URL: https://github.com/yiisoft/var-dumper
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-05-02T12:37:09.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-04T12:22:27.000Z (about 1 year ago)
- Last Synced: 2024-04-15T03:04:18.765Z (about 1 year ago)
- Topics: debug, debugging, dump, hacktoberfest, vardump, vardumper, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 280 KB
- Stars: 20
- Watchers: 19
- Forks: 13
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii VarDumper
[](https://packagist.org/packages/yiisoft/var-dumper)
[](https://packagist.org/packages/yiisoft/var-dumper)
[](https://github.com/yiisoft/var-dumper/actions/workflows/build.yml)
[](https://codecov.io/gh/yiisoft/var-dumper)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/var-dumper/master)
[](https://github.com/yiisoft/var-dumper/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/var-dumper)
`VarDumper` enhances functionality of `var_dump()` and `var_export()`. It is dealing with recursive references,
may highlight syntax and export closures.
## Requirements
- PHP 8.0 or higher.
## Installation
The package could be installed with [Composer](https://getcomposer.org):
```shell
composer require yiisoft/var-dumper
```
## General usage
### Quick debugging
In case you want to echo a string representing variable contents use the following code:
```php
\Yiisoft\VarDumper\VarDumper::dump($variable);
```
That is useful for quick debugging. By default, it goes deep `10` levels into variable and highlights syntax. You may
adjust these settings via second and third argument of the method respectively.
For convenience, you can use the functions:
```php
// Prints variables:
d($variable, /* Further variables to dump. */);
// The same as above
dump($variable, /* Further variables to dump. */);
// Prints variables and terminate the current script:
dd($variable, /* Further variables to dump. */);
```
### Formatting debug string
To get a string representing variable contents, same as above but without `echo`:
```php
$string = \Yiisoft\VarDumper\VarDumper::create($variable)->asString(10, true);
```
`10` is maximum recursion depth and `true` is telling dumper to
highlight syntax.
### Exporting as PHP code
In order to get a valid PHP expression string that can be evaluated by PHP parser,
and the evaluation result will give back the variable value, use the following code:
```php
$string = \Yiisoft\VarDumper\VarDumper::create($variable)->export();
```
It is similar to `var_export()` but uses short array syntax, handles closures, and serializes objects.
In the above `export()` will give you nicely formatted code. You can remove formatting by passing `false` as the first
`$format` argument.
`$useVariables` argument allows specifying array of variables that will be in `use` statement for closures.
That is especially useful if an object contains callbacks that should get info from upper scope.
`$serializeObjects` argument when given `false` allows to force turn off using of serialization for objects so instead
closures and reflection API are used the same was as for exporting closures. De-serialization performance is better.
Closures are way more readable.
### Exporting as JSON string
```php
$string = \Yiisoft\VarDumper\VarDumper::create($variable)->asJson();
```
It is similar to `json_encode()` but uses short array syntax, handles closures, and serializes objects.
In the above `asJson()` will give you nicely formatted code. You can remove formatting by passing `false` as the first
`$format` argument.
`$depth` argument allows you to set maximum recursion depth.
## Output destination
Choose one of existing classes or create a new one to control the destination where "dumps" will be sent to:
- [EchoHandler](./src/Handler/EchoHandler.php)
- Uses `echo` to write to stdout stream.
- Used by default.
- [StreamHandler](./src/Handler/StreamHandler.php)
- Uses `ext-sockets` to sent dumps encoded with `json_encode` to a UDP socket.
- [CompositeHandler](./src/Handler/CompositeHandler.php)
- Helpful class to sent dumps to multiple handlers in a row, for example `EchoHandler` and `StreamHandler`.
Output handlers are set via `VarDumper::setDefaultHandler()` method.
## Limitations
Current limitations are:
- Variables or properties that are anonymous classes or contain anonymous classes are not supported.
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for that.
You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii VarDumper is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
### Support the project
[](https://opencollective.com/yiisoft)
### Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3ru)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)