Chirpy! 0.3 API Documentation
Chirpy::Event
NAME
Chirpy::Event - Represents a log event
SYNOPSIS
$event = new Chirpy::Event($id, $date, $code, $user, $data); $id = $event->get_id(); $event->set_id($id); $date = $event->get_date(); $event->set_date($date); $code = $event->get_code(); $event->set_code($code); $user = $event->get_user(); $event->set_user($user); $data = $event->get_data(); $event->set_data($data); $event_code = Chirpy::Event::translate_code($code);
CONSTRAINTS
- ID
-
The event ID must be a positive non-zero integer.
- Date
-
The event date must be a UNIX timestamp.
- Code
-
The event code must be one of the event code constants described below.
- User
-
The user who was logged in at the time of the event must be an instance of Chirpy::Account, if any.
- Data
-
The event data must be a reference to a hash containing information about the event.
EVENT CODE CONSTANTS
Chirpy::Event::LOGIN_SUCCESS Chirpy::Event::LOGIN_FAILURE Chirpy::Event::CHANGE_PASSWORD Chirpy::Event::ADD_QUOTE Chirpy::Event::EDIT_QUOTE Chirpy::Event::REMOVE_QUOTE Chirpy::Event::QUOTE_RATING_UP Chirpy::Event::QUOTE_RATING_DOWN Chirpy::Event::REPORT_QUOTE Chirpy::Event::APPROVE_QUOTE Chirpy::Event::UNFLAG_QUOTE Chirpy::Event::ADD_NEWS Chirpy::Event::EDIT_NEWS Chirpy::Event::REMOVE_NEWS Chirpy::Event::ADD_ACCOUNT Chirpy::Event::EDIT_ACCOUNT Chirpy::Event::REMOVE_ACCOUNT
AUTHOR
Tim De Pauw <ceetee@users.sourceforge.net>
SEE ALSO
Chirpy, http://chirpy.sourceforge.net/
COPYRIGHT
Copyright 2005-2007 Tim De Pauw. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.