https://github.com/fiedsch/pathdumper

Dump array contents in a compact readable way
https://github.com/fiedsch/pathdumper

Last synced: about 2 months ago
JSON representation

Dump array contents in a compact readable way

• Host: GitHub
• URL: https://github.com/fiedsch/pathdumper
• Owner: fiedsch
• Created: 2023-10-13T14:31:26.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-02T11:40:30.000Z (5 months ago)
• Last Synced: 2024-09-02T12:40:29.037Z (4 months ago)
• Language: PHP
• Size: 9.77 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Readme

## What is it

A very small library that helps displaying the data of complex array data structures.

The output is "flattened", i.e. it contains one "path" per leaf of the array's data

(see example below).

## How to use it

```

 [

      'has' => [

          'only', 'one', 'level', 'of', 'nesting',

      ]

  ],

  'top_level_b' => [

    'contains' => [

        'another' => [

            'array', 'with', 'some', 'elements'

        ]

    ]

 ],

 'top_level_c' => 'contains only a scalar value'

];

Dumper::displayData($nested_data);

```

would output 

```

top_level_a.has.0 => only

top_level_a.has.1 => one

top_level_a.has.2 => level

top_level_a.has.3 => of

top_level_a.has.4 => nesting

top_level_b.contains.another.0 => array

top_level_b.contains.another.1 => with

top_level_b.contains.another.2 => some

top_level_b.contains.another.3 => elements

top_level_c => contains only a scalar value

```

If you need the output as string, use `Dumper::getDisplayDataAsString()`.

### Optional parameters

Use the optional parameters 

* `string $lineCommentCharacter = ''` and/or 

* `bool $showCodePosition = true` 

of `Dumper::displayData` or `Dumper::getDisplayDataAsString` to 

* prefix the output with a line comment string or 

* do not output the code position where the respective method was called