man Bric::App::Event () - Exports simple functions for managing events.

NAME

Bric::App::Event - Exports simple functions for managing events.

VERSION

$LastChangedRevision$

DATE

$LastChangedDate: 2004-10-15 14:05:42 -0700 (Fri, 15 Oct 2004) $

SYNOPSIS

  use Bric::App::Event qw(:all);
  log_event($name, $obj, $init);
  commit_events();

DESCRIPTION

INTERFACE

Constructors

NONE.

Destructors

$p->DESTROY
Dummy method to prevent wasting time trying to AUTOLOAD DESTROY. Throws: NONE. Side Effects: NONE. Notes: NONE.

Public Class Methods

NONE.

Public Functions

Queues an event for logging. Pass in the following arguments:

$key_name
The key name of the event to log. Required.
$obj
The object for which the event is being logged. Required.
$init
The attribute values for this event. Required for those event types that require them. See Bric::Util::EventType and Bric::Util::Event for more information. Throws: NONE. Side Effects: NONE. Notes: NONE. Goes through the queue of events created by calls to log_event() and actually logs them to the database. Throws: See Bric::Util::Event::new(). Side Effects: NONE. Notes: NONE. Deletes queue of events so that they won't be logged. Used to prevent event logging when an error has occurred and all changes have been rolled back. Throws: NONE. Side Effects: NONE. Notes: NONE.

PRIVATE

Private Class Methods

NONE.

Private Instance Methods

NONE.

Private Functions

NONE.

NOTES

NONE.

AUTHOR

David Wheeler <david@wheeler.net>

SEE ALSO

Bric, Bric::Util::Event