Interface Loggable
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.
Direct known implementers
ElggDataIndirect known implementers
ElggAnnotation, ElggEntity, ElggUser, ElggWidget, ElggExtender, ElggFile, ElggGroup, ElggMetadata, ElggObject, ElggPlugin, ElggRelationship, ElggSite
public
integer
|
#
getSystemLogID( )
Return an identification for the object for storage in the system log. This id must be an integer. |
public
string
|
#
getClassName( )
Return the class name of the object. Added as a function because get_class causes errors for some reason. |
public
string
|
|
public
string
|
#
getSubtype( )
Return a subtype. For metadata & annotations this is the 'name' and for relationship this is the relationship type. |
public
|
#
getObjectFromID( integer $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. |