• Name
• Synopsis
• Description
• Interface
  • Constructors
  • Destructors
  • Public Class Methods
  • Public Functions
• Private
  • Private Class Methods
  • Private Instance Methods
  • Private Functions
• Notes
• Author
• See Also

Name

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

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

• my $bool = log_event($key_name, $obj, $init)

  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.

• my $bool = commit_events()

  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.

• my $bool = clear_events()

  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

See Also

Bric, Bric::Util::Event