You are here

README.txt in Object Log 7

Same filename and directory in other branches
  1. 8 README.txt
-- SUMMARY --

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.

-- REQUIREMENTS --

The Object log module depends on Devel module:
  http://drupal.org/project/devel

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

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.

File

README.txt
View source
  1. -- SUMMARY --
  2. The Object log module allows developers to store objects, arrays and other
  3. variables to a log table so that they may be inspected later. Multiple stored
  4. variables may be displayed side-by-side in the Object log under admin/reports.
  5. The usage is similar to Devel module's dpm() or kprint_r() functions, but is
  6. particularly suited for debugging server-to-server requests, such as cron runs
  7. and web services, or for requests from anonymous and other unprivileged users.
  8. -- REQUIREMENTS --
  9. The Object log module depends on Devel module:
  10. http://drupal.org/project/devel
  11. -- USAGE --
  12. When you reach a point in a code at which you would like to store a variable,
  13. call the object_log() function...
  14. object_log($label, $data);
  15. ...where $label is a string representing a name to give the object in the log,
  16. and $data is the variable you wish to store. If there is already a stored object
  17. with the same $label, that entry will be overwritten in the log.
  18. Stored objects may be inspected by any user with the "access devel information"
  19. permission by going to admin/reports/object_log. While inspecting an object,
  20. a second object may be selected to display both objects side-by-side.