Skip to content

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

Notifications You must be signed in to change notification settings

backdrop-contrib/object_log

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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...

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:

$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

Issues

Bugs and Feature Requests should be reported in the Issue Queue: https://github.com/backdrop-contrib/object_log/issues.

Current Maintainers

Credits

License

This project is GPL v2 software. See the LICENSE.txt file in this directory for complete text.