https://github.com/backdrop-contrib/object_log

Allows Backdrop CMS developers to store objects, arrays and other variables to a log table for later inspection.
https://github.com/backdrop-contrib/object_log

array backdrop backdropcms cms developer developer-tools development krumo log object tools variable

Last synced: 3 days ago
JSON representation

Allows Backdrop CMS developers to store objects, arrays and other variables to a log table for later inspection.

• Host: GitHub
• URL: https://github.com/backdrop-contrib/object_log
• Owner: backdrop-contrib
• Created: 2024-01-12T10:59:09.000Z (about 1 year ago)
• Default Branch: 1.x-1.x
• Last Pushed: 2024-07-27T18:41:27.000Z (7 months ago)
• Last Synced: 2024-07-30T17:16:23.599Z (7 months ago)
• Topics: array, backdrop, backdropcms, cms, developer, developer-tools, development, krumo, log, object, tools, variable
• Language: PHP
• Homepage: https://backdropcms.org/project/object_log
• Size: 9.77 KB
• Stars: 1
• Watchers: 9
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Object Log

========

The Object Log module allows developers to store objects, arrays and other

variables to a log table so that they may be inspected later. Multiple stored

variables may be displayed side-by-side in the Object Log under admin/reports.

The usage is similar to Devel module's `dpm()` or `kprint_r()` functions, but

is particularly suited for debugging server-to-server requests, such as cron

runs and web services, or for requests from anonymous and other unprivileged

users.

Other uses include where the use of `dpm()` slows down the rendering of a page

to the extent where it is unusable or where Krumo is not able to render an

object.

Usage

---------------------

When you reach a point in a code at which you would like to store a variable,

call the object_log() function...

  ```php

  object_log($label, $data);

  ```

...where $label is a string representing a name to give the object in the log,

and $data is the variable you wish to store. If there is already a stored object

with the same $label, that entry will be overwritten in the log.

If you want to inspect the same object over time, you could append a date

string or other identifier to the label to give distinct entries:

```php

$label = 'object_label' . date('ymd_His')

object_log($label, $data);

```

Stored objects may be inspected by any user with the "access devel information"

permission by going to admin/reports/object_log.  While inspecting an object,

a second object may be selected to display both objects side-by-side.

Requirements

------------

This module requires that the following modules are also enabled:

- Devel

Installation

------------

- Install this module using the official Backdrop CMS instructions at

  https://docs.backdropcms.org/documentation/extend-with-modules.

Issues

------

Bugs and Feature Requests should be reported in the Issue Queue:

https://github.com/backdrop-contrib/object_log/issues.

Current Maintainers

-------------------

- [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons Ltd](https://www.systemhorizons.co.uk)

- Collaboration and co-maintainers welcome!

Credits

-------

- Ported to Backdrop CMS by - [Martin Price](https://github.com/yorkshire-pudding) - [System Horizons Ltd](https://www.systemhorizons.co.uk).

- Port sponsored by [System Horizons Ltd](https://www.systemhorizons.co.uk).

- Originally written for Drupal by [Les Lim](https://www.drupal.org/u/les-lim).

License

-------

This project is GPL v2 software.

See the LICENSE.txt file in this directory for complete text.