|
Elgg
Version 4.3
|
Interface that provides an interface which must be implemented by all objects wishing to be recorded in the system log (and by extension the river). More...
Public Member Functions | |
| getSystemLogID () | |
| Return an identification for the object for storage in the system log. More... | |
| getType () | |
| Return the type of the object - eg. More... | |
| getSubtype () | |
| Return a subtype. More... | |
| getObjectFromID ($id) | |
| For a given ID, return the object associated with it. More... | |
Interface that provides an interface which must be implemented by all objects wishing to be recorded in the system log (and by extension the river).
This interface defines a set of methods that permit the system log functions to hook in and retrieve the necessary information and to identify what events can actually be logged.
To have events involving your object to be logged simply implement this interface.
Definition at line 12 of file Loggable.php.
| Loggable::getObjectFromID | ( | $id | ) |
For a given ID, return the object associated with it.
This is used by the river functionality primarily. This is useful for checking access permissions etc on objects.
| int | $id | GUID of an entity |
| Loggable::getSubtype | ( | ) |
Return a subtype.
For metadata & annotations this is the 'name' and for relationship this is the relationship type.
| Loggable::getSystemLogID | ( | ) |
Return an identification for the object for storage in the system log.
This id must be an integer.
| Loggable::getType | ( | ) |
Return the type of the object - eg.
object, group, user, relationship, metadata, annotation etc
1.8.11
