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
◆ getClassName()
| 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.
◆ getObjectFromID()
| 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 $id GUID of an entity
- Returns
- \ElggEntity
Implemented in ElggRelationship, ElggMetadata, ElggEntity, and ElggAnnotation.
◆ getSubtype()
| Loggable::getSubtype | ( | ) |
Return a subtype.
For metadata & annotations this is the 'name' and for relationship this is the relationship type.
- Returns
- string
Implemented in ElggRelationship, ElggExtender, and ElggEntity.
◆ getSystemLogID()
| Loggable::getSystemLogID | ( | ) |
Return an identification for the object for storage in the system log.
This id must be an integer.
- Returns
- int
Implemented in ElggRelationship, ElggExtender, and ElggEntity.
◆ getType()
| Loggable::getType | ( | ) |
Return the type of the object - eg.
object, group, user, relationship, metadata, annotation etc
- Returns
- string
Implemented in ElggRelationship, ElggExtender, and ElggEntity.
The documentation for this interface was generated from the following file:
- engine/classes/Loggable.php
