engine/lib/system_log.php File Reference

Go to the source code of this file.

Namespaces

namespace  Elgg::Core
 

Activate a plugin or plugins.


Functions

 get_system_log ($by_user="", $event="", $class="", $type="", $subtype="", $limit=10, $offset=0, $count=false, $timebefore=0, $timeafter=0, $object_id=0, $ip_address=false)
 Retrieve the system log based on a number of parameters.
 get_log_entry ($entry_id)
 Return a specific log entry.
 get_object_from_log_entry ($entry_id)
 Return the object referred to by a given log entry.
 system_log ($object, $event)
 Log a system event related to a specific object.
 archive_log ($offset=0)
 This function creates an archive copy of the system log.
 system_log_default_logger ($event, $object_type, $object)
 Default system log handler, allows plugins to override, extend or disable logging.
 system_log_listener ($event, $object_type, $object)
 System log listener.

Function Documentation

archive_log ( offset = 0  ) 

This function creates an archive copy of the system log.

Parameters:
int $offset An offset in seconds from now to archive (useful for log rotation)
Returns:
bool

Definition at line 228 of file system_log.php.

get_log_entry ( entry_id  ) 

Return a specific log entry.

Parameters:
int $entry_id The log entry
Returns:
mixed

Definition at line 119 of file system_log.php.

get_object_from_log_entry ( entry_id  ) 

Return the object referred to by a given log entry.

Parameters:
int $entry_id The log entry
Returns:
mixed

Definition at line 134 of file system_log.php.

get_system_log ( by_user = "",
event = "",
class = "",
type = "",
subtype = "",
limit = 10,
offset = 0,
count = false,
timebefore = 0,
timeafter = 0,
object_id = 0,
ip_address = false 
)

Retrieve the system log based on a number of parameters.

Parameters:
int|array $by_user The guid(s) of the user(s) who initiated the event. Use 0 for unowned entries. Anything else falsey means anyone.
string $event The event you are searching on.
string $class The class of object it effects.
string $type The type
string $subtype The subtype.
int $limit Maximum number of responses to return.
int $offset Offset of where to start.
bool $count Return count or not
int $timebefore Lower time limit
int $timeafter Upper time limit
int $object_id GUID of an object
str $ip_address The IP address.
Returns:
mixed

Definition at line 28 of file system_log.php.

system_log ( object,
event 
)

Log a system event related to a specific object.

This is called by the event system and should not be called directly.

Parameters:
object $object The object you're talking about.
string $event String The event being logged
Returns:
mixed

Definition at line 163 of file system_log.php.

system_log_default_logger ( event,
object_type,
object 
)

Default system log handler, allows plugins to override, extend or disable logging.

Parameters:
string $event Event name
string $object_type Object type
Loggable $object Object to log
Returns:
true

Definition at line 267 of file system_log.php.

system_log_listener ( event,
object_type,
object 
)

System log listener.

This function listens to all events in the system and logs anything appropriate.

Parameters:
String $event Event name
String $object_type Type of object
Loggable $object Object to log
Returns:
true private

Definition at line 284 of file system_log.php.

 All Classes Namespaces Files Functions Variables Enumerations
Generated on Wed May 16 00:00:25 2012 for Elgg by  doxygen 1.6.3