Elgg
Version 1.11
|
Public Member Functions | |
__construct () | |
Constructor. More... | |
getId ($type, $subtype) | |
Return the id for a given subtype. More... | |
getSubtype ($subtype_id) | |
Gets the denormalized string for a given subtype ID. More... | |
retrieveFromCache ($type, $subtype) | |
Retrieve subtype from the cache. More... | |
populateCache () | |
Fetch all suptypes from DB to local cache. More... | |
getClass ($type, $subtype) | |
Return the class name for a registered type and subtype. More... | |
getClassFromId ($subtype_id) | |
Returns the class name for a subtype id. More... | |
add ($type, $subtype, $class="") | |
Register \ElggEntities with a certain type and subtype to be loaded as a specific class. More... | |
remove ($type, $subtype) | |
Removes a registered \ElggEntity type, subtype, and classname. More... | |
update ($type, $subtype, $class='') | |
Update a registered \ElggEntity type, subtype, and class name. More... | |
Definition at line 23 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::__construct | ( | ) |
Constructor.
Definition at line 34 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::add | ( | $type, | |
$subtype, | |||
$class = "" |
|||
) |
Register \ElggEntities with a certain type and subtype to be loaded as a specific class.
By default entities are loaded as one of the 4 parent objects: site, user, object, or group. If you subclass any of these you can register the classname with add_subtype() so it will be loaded as that class automatically when retrieved from the database with get_entity().
string | $type | The type you're subtyping (site, user, object, or group) |
string | $subtype | The subtype |
string | $class | Optional class name for the object |
Definition at line 224 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::getClass | ( | $type, | |
$subtype | |||
) |
Return the class name for a registered type and subtype.
Entities can be registered to always be loaded as a certain class with add_subtype() or update_subtype(). This function returns the class name if found and null if not.
string | $type | The type |
string | $subtype | The subtype |
Definition at line 160 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::getClassFromId | ( | $subtype_id | ) |
Returns the class name for a subtype id.
int | $subtype_id | The subtype id |
Definition at line 186 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::getId | ( | $type, | |
$subtype | |||
) |
Return the id for a given subtype.
\ElggEntity objects have a type and a subtype. Subtypes are defined upon creation and cannot be changed.
Plugin authors generally don't need to use this function unless writing their own SQL queries. Use () to return the string subtype.
Definition at line 59 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::getSubtype | ( | $subtype_id | ) |
Gets the denormalized string for a given subtype ID.
int | $subtype_id | Subtype ID from database |
Definition at line 87 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::populateCache | ( | ) |
Fetch all suptypes from DB to local cache.
@access private
Definition at line 134 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::remove | ( | $type, | |
$subtype | |||
) |
Removes a registered \ElggEntity type, subtype, and classname.
string | $type | Type |
string | $subtype | Subtype |
Definition at line 270 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::retrieveFromCache | ( | $type, | |
$subtype | |||
) |
Retrieve subtype from the cache.
string | $type | |
string | $subtype |
@access private
Definition at line 114 of file SubtypeTable.php.
Elgg\Database\SubtypeTable::update | ( | $type, | |
$subtype, | |||
$class = '' |
|||
) |
Update a registered \ElggEntity type, subtype, and class name.
string | $type | Type |
string | $subtype | Subtype |
string | $class | Class name to use when loading this entity |
Definition at line 296 of file SubtypeTable.php.