Class LogEntry

Description
Description | Vars | Methods (details)

Habari LogEntry class Represents a log entry

  • todo: Apply system error handling

Located in /system/classes/logentry.php (line 10) 

QueryRecord
   |
   --LogEntry
Method Summary
Description | Vars | Methods (details)
static array default_fields ()
static object LogEntry get ([array $paramarray = array()])
static array list_logentry_types ([bool $force = false])
static array list_modules ([bool $refresh = false])
static array list_severities ()
static array list_types ([bool $refresh = false])
static mixed severity (string $severity)
static string severity_name (integer $severity)
static mixed type (string $module, string $type)
LogEntry __construct ([array $paramarray = array()])
void delete ()
string get_event_module ()
string get_event_severity ()
string get_event_type ()
void insert ()
mixed __get (string $name)
mixed __set (string $name,  $value)
Variables
Description | Vars (details) | Methods (details)

Inherited Variables

Inherited from QueryRecord

QueryRecord::$fields
 QueryRecord::$newfields
 QueryRecord::$unsetfields
Methods
Description | Vars Methods (details)
static method default_fields (line 34)

Return the defined database columns for an Event

  • return: Array of columns in the LogEntry table
  • access: public
static array default_fields ()
static method get (line 212)

Return a single requested log entry.

  1.  $log= LogEntry::get( array( 'id' => 5 ) );

  • return: The first log entry that matched the given criteria
  • access: public
static object LogEntry get ([array $paramarray = array()])
  • array $paramarray: An associated array of parameters, or a querystring
static method list_logentry_types (line 82)

Returns an associative array of LogEntry types

  • return: An array of log entry type names => integer values
  • access: public
static array list_logentry_types ([bool $force = false])
  • bool $force: whether to force a refresh of the cached values
static method list_modules (line 114)

Returns an array of LogEntry modules

  • return: An array of LogEntry module id => name pairs
  • access: public
static array list_modules ([bool $refresh = false])
  • bool $refresh: Whether to refresh the cached values
static method list_severities (line 98)

Return an array of Severities

  • return: An array of severity ID => name pairs
  • access: public
static array list_severities ()
static method list_types (line 127)

Returns an array of LogEntry types

  • return: An array of LogEntry id => name pairs
  • access: public
static array list_types ([bool $refresh = false])
  • bool $refresh: Whether to refresh the cached values
static method severity (line 143)

Get the integer value for the given severity, or

  1. false
.

  • return: numeric value for the given severity, or
    1. false
  • access: public
static mixed severity (string $severity)
  • string $severity: The severity name
static method severity_name (line 157)

Get the string representation of the severity numeric value.

  • return: The string name of the severity, or 'Unknown'.
  • access: public
static string severity_name (integer $severity)
  • integer $severity: The severity index.
static method type (line 169)

Get the integer value for the given module/type, or

  1. false
.

  • return: numeric value for the given module/type, or
    1. false
  • access: public
static mixed type (string $module, string $type)
  • string $module: the module
  • string $type: the type
Constructor __construct (line 53)

Constructor for the LogEntry class

  • access: public
LogEntry __construct ([array $paramarray = array()])
  • array $paramarray: an associative array of initial LogEntry field values
Redefinition of:
QueryRecord::__construct()
constructor __construct Constructor for the QueryRecord class.
delete (line 271)

function delete

Deletes this logentry

  • access: public
void delete ()
Redefinition of:
QueryRecord::delete()
This is the public interface that deletes a record
get_event_module (line 251)

Return the log entry's event module.

  1. $log->module

  • return: Human-readable event module
  • access: public
string get_event_module ()
get_event_severity (line 263)

Return the log entry's event severity.

  1. $log->severity

  • return: Human-readable event severity
  • access: public
string get_event_severity ()
get_event_type (line 239)

Return the log entry's event type.

  1. $log->type

  • return: Human-readable event type
  • access: public
string get_event_type ()
insert (line 186)

Insert this LogEntry data into the database

  • access: public
void insert ()
Redefinition of:
QueryRecord::insert()
This is the public interface that inserts a record
__get (line 289)

Overrides QueryRecord __get to implement custom object properties

  • return: The requested field value
  • access: public
mixed __get (string $name)
  • string $name: Name of property to return
Redefinition of:
QueryRecord::__get()
function __get
__set (line 327)

Overrides QueryRecord __set to implement custom object properties

  • return: The requested field value
  • access: public
mixed __set (string $name,  $value)
  • string $name: Name of property to return
  • $value
Redefinition of:
QueryRecord::__set()
function __set

Inherited Methods

Inherited From QueryRecord

QueryRecord::__construct()
QueryRecord::delete()
QueryRecord::deleteRecord()
QueryRecord::exclude_fields()
QueryRecord::get_url_args()
QueryRecord::insert()
QueryRecord::insertRecord()
QueryRecord::list_excluded_fields()
QueryRecord::to_array()
QueryRecord::update()
QueryRecord::updateRecord()
QueryRecord::__get()
QueryRecord::__isset()
QueryRecord::__set()

Documentation generated on Thu, 30 Oct 2008 20:31:20 +0100 by phpDocumentor 1.3.2