https://github.com/digitalnature/php-ref

A better alternative to print_r / var_dump
https://github.com/digitalnature/php-ref

Last synced: about 2 months ago
JSON representation

A better alternative to print_r / var_dump

• Host: GitHub
• URL: https://github.com/digitalnature/php-ref
• Owner: digitalnature
• Created: 2012-12-28T04:28:40.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-02-03T14:04:39.000Z (over 1 year ago)
• Last Synced: 2024-06-18T11:10:53.689Z (3 months ago)
• Language: PHP
• Size: 253 KB
• Stars: 347
• Watchers: 22
• Forks: 59
• Open Issues: 24
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
REF, or `r()` is a nicer alternative to PHP's [`print_r`](http://php.net/manual/en/function.print-r.php) / [`var_dump`](http://php.net/manual/en/function.var-dump.php) functions.

## [DEMO](http://dev.digitalnature.eu/php-ref/) ##

## Requirements ##

- (server) PHP 5.3+ (5.4+  displays additional info)

- (client) Any browser, except IE 8 and lower of course

## Installation using Composer

Add REF to your `composer.json`:

```js

{

    "require": {

        "digitalnature/php-ref": "dev-master"

    }

}

```

Now tell composer to download the bundle by running:

``` bash

$ php composer.phar update digitalnature/php-ref

```

Composer will install the bundle to the directory `vendor/digitalnature`.

## Usage ##

Basic example:

       

    // include the class (not needed if project runs with Composer because it's auto-loaded)

    require '/full/path/to/ref.php';

    // display info about defined classes

    r(get_declared_classes());

    // display info about global variables

    r($GLOBALS);

To print in text mode you can use the `rt()` function instead:

    rt($var);

To terminate the script after the info is dumped, prepend the bitwise NOT operator:

    ~r($var);   // html

    ~rt($var);  // text

Prepending the error control operator (@) will return the information:

    $output = @r($var);   // html

    $output = @rt($var);  // text

Keyboard shortcuts (javascript must be enabled):

- `X` - collapses / expands all levels

- `Ctrl` + `X` - toggles display state

To modify the global configuration call `ref::config()`:

    // example: initially expand first 3 levels

    ref::config('expLvl', 3);

You can also add configuration options in your `php.ini` file like this:

    [ref]

    ref.expLvl = 3

    ref.maxDepth = 4

Currently available options and their default values:

| Option                    | Default             | Description

|:------------------------- |:------------------- |:-----------------------------------------------

| `'expLvl'`                | `1`                 | Initially expanded levels (for HTML mode only). A negative value will expand all levels

| `'maxDepth'`              | `6`                 | Maximum depth (`0` to disable); note that disabling it or setting a high value can produce a 100+ MB page when input involves large data

| `'showIteratorContents'`  | `FALSE`             | Display iterator data (keys and values)

| `'showResourceInfo'`      | `TRUE`              | Display additional information about resources

| `'showMethods'`           | `TRUE`              | Display methods and parameter information on objects

| `'showPrivateMembers'`    | `FALSE`             | Include private properties and methods

| `'showStringMatches'`     | `TRUE`              | Perform and display string matches for dates, files, json strings, serialized data, regex patterns etc. (SLOW)

| `'formatters'`            | `array()`           | Custom/external formatters (as associative array: format => className)

| `'shortcutFunc'`          | `array('r', 'rt')`  | Shortcut functions used to detect the input expression. If they are namespaced, the namespace must be present as well (methods are not  supported) 

| `'stylePath'`             | `'{:dir}/ref.css'`  | Local path to a custom stylesheet (HTML only); `FALSE` means that no CSS is included.

| `'scriptPath'`            | `'{:dir}/ref.js'`   | Local path to a custom javascript (HTML only); `FALSE` means no javascript (tooltips / toggle / kbd shortcuts require JS)

| `'showUrls'`              | `FALSE`             | Gets information about URLs. Setting to false can improve performance (requires showStringMatches to be TRUE)

| `'timeout'`               | `10`                | Stop execution after this amount of seconds, forcing an incomplete listing. Applies to all calls

| `'validHtml'`             | `FALSE`             | For HTML mode only. Whether to produce W3C-valid HTML (larger code output) or unintelligible, potentially browser-incompatible but much smaller code output

## Similar projects

- [Kint](http://raveren.github.io/kint/)

- [dump_r](https://github.com/leeoniya/dump_r.php)

- [Krumo](http://sourceforge.net/projects/krumo/)

- [dBug](http://dbug.ospinto.com/)

- [symfony-vardumper](http://www.sitepoint.com/var_dump-introducing-symfony-vardumper/)

## TODOs

- Inherit DocBlock comments from parent or prototype, if missing

- Refactor "bubbles" (for text-mode)

- Correctly indent multi-line strings (text-mode)

- Move separator tokens to ::before and ::after pseudo-elements (html-mode)

## License

http://opensource.org/licenses/mit-license.html