https://github.com/finanalyst/grav-plugin-var-dumper

Grav plugin for logging events in another plugin
https://github.com/finanalyst/grav-plugin-var-dumper

Last synced: 17 days ago
JSON representation

Grav plugin for logging events in another plugin

• Host: GitHub
• URL: https://github.com/finanalyst/grav-plugin-var-dumper
• Owner: finanalyst
• License: mit
• Created: 2018-06-25T08:53:16.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-27T06:55:58.000Z (over 6 years ago)
• Last Synced: 2024-10-08T14:01:25.450Z (about 1 month ago)
• Language: PHP
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Var Dumper Plugin

Provides a mechanism for logging data inside another GRAV plugin. Want to see the value of a variable at some line in another plugin. Uses the same routines as `dump`, but records the output to a time-stamped html file, rather than in the debug window, or at the top of the screen. Thus the data is not overwritten by a redirect. For development.

The **Var-Dumper** Plugin is for [Grav CMS](http://github.com/getgrav/grav).

## Installation

Installing the Logger plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

### GPM Installation (Preferred)

The simplest way to install this plugin is via the [Grav Package Manager (GPM)](http://learn.getgrav.org/advanced/grav-gpm) through your system's terminal (also called the command line).  From the root of your Grav install type:

    bin/gpm install var-dumper

This will install the Logger plugin into your `/user/plugins` directory within Grav. Its files can be found under `/your/site/grav/user/plugins/var-dumper`.

### Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under `/your/site/grav/user/plugins`. Then, rename the folder to `var-dumper`. You can find these files on [GitHub](https://github.com/finanalyst/grav-plugin-var-dumper) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).

You should now have all the plugin files under

    /your/site/grav/user/plugins/lvar-dumper

> NOTE: This plugin is a modular component for Grav which requires [Grav](http://github.com/getgrav/grav) and the [Error](https://github.com/getgrav/grav-plugin-error) and [Problems](https://github.com/getgrav/grav-plugin-problems) to operate.

Also best with DataManager to visualise the logged data. So DataManager is included as a dependency.

### Admin Plugin

If you use the admin plugin, you can install directly through the admin plugin by browsing the `Plugins` tab and clicking on the `Add` button.

## Configuration

Before configuring this plugin, you should copy the `user/plugins/var-dumper/var-dumper.yaml` to `user/config/plugins/var-dumper.yaml` and only edit that copy.

Here is the default configuration and an explanation of available options:

```yaml

enabled: false

dumping: true

```

>WARNING: This plugin should not be used for production, so the default is *false*.

There are occasions when a developer needs to leave a dump code line in the program, but wishes to turn off dumping. If the plugin is simply disabled, by setting `enabled: false`, the remaining dump code will generate an error. Setting `dumping: false` has the same effect as `enabled: false` but does not generate a GRAV error.

`dumping` has no effect if `enabled: false`.

Note that if you use the admin plugin, a file with your configuration, and named var-dumper.yaml will be saved in the `user/config/plugins/` folder once the configuration is saved in the admin.

## Usage

Add the following where you want to dump a message or variable in a file in the data directory:

```php

    $this->grav['dd']->dump('some message');

    $this->grav['dd']->dump($some-variable, 'a comment');

```

`dump` parameters:

1. any php string or object

A timestamp is appended to the file basename. The file extension is `.yaml`.

## Viewing dump files

Using the DataManger plugin, the files can be view by clicking on the type 'var-dumps'. A dump file is generated for each day.

A button is provided to delete each item in the data directory.

Clicking on a dump file opens the data.

Each record contains the line & file where the dump was requested.

Clicking on the checkbox opens the content of the variable dump.