Elgg  Version 2.2
 All Classes Namespaces Files Functions Variables Pages
Public Member Functions | List of all members
Loggable Interface Reference
Inheritance diagram for Loggable:
ElggData ElggEntity ElggExtender ElggRelationship ElggGroup ElggObject ElggSite ElggUser ElggAnnotation ElggMetadata ElggComment ElggFile ElggPlugin ElggUpgrade ElggWidget ElggIcon

Public Member Functions

 getSystemLogID ()
 Return an identification for the object for storage in the system log. More...
 
 getClassName ()
 Return the class name of the object. 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...
 

Detailed Description

Definition at line 15 of file Loggable.php.

Member Function Documentation

Loggable::getClassName ( )

Return the class name of the object.

Added as a function because get_class causes errors for some reason.

Returns
string

Implemented in ElggData.

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.

Parameters
int$idGUID of an entity
Returns

Implemented in ElggEntity, ElggRelationship, ElggMetadata, and ElggAnnotation.

Loggable::getSubtype ( )

Return a subtype.

For metadata & annotations this is the 'name' and for relationship this is the relationship type.

Returns
string

Implemented in ElggEntity, ElggRelationship, and ElggExtender.

Loggable::getSystemLogID ( )

Return an identification for the object for storage in the system log.

This id must be an integer.

Returns
int

Implemented in ElggEntity, ElggRelationship, and ElggExtender.

Loggable::getType ( )

Return the type of the object - eg.

object, group, user, relationship, metadata, annotation etc

Returns
string

Implemented in ElggEntity, ElggRelationship, and ElggExtender.


The documentation for this interface was generated from the following file: