Elgg  Version 1.11
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
Elgg\EntityPreloader Class Reference

Public Member Functions

 preload ($objects, array $guid_properties)
 Preload entities based on the given objects. More...
 

Public Attributes

 $_callable_cache_checker = '_elgg_retrieve_cached_entity'
 DO NOT USE. More...
 
 $_callable_entity_loader = 'elgg_get_entities'
 DO NOT USE. More...
 

Protected Member Functions

 getGuidsToLoad ($objects, array $guid_properties)
 Get GUIDs that need to be loaded. More...
 

Detailed Description

Definition at line 12 of file EntityPreloader.php.

Member Function Documentation

Elgg\EntityPreloader::getGuidsToLoad (   $objects,
array  $guid_properties 
)
protected

Get GUIDs that need to be loaded.

To simplify the user API, this function accepts non-arrays and arrays containing non-objects

Parameters
object[]$objects Objects from which to pluck GUIDs
string[]$guid_properties e.g. array("owner_guid")
Returns
int[]

Definition at line 43 of file EntityPreloader.php.

Elgg\EntityPreloader::preload (   $objects,
array  $guid_properties 
)

Preload entities based on the given objects.

Parameters
object[]$objects Objects–e.g. loaded from an Elgg query–from which we can pluck GUIDs to preload
string[]$guid_properties e.g. array("owner_guid")
Returns
void

Definition at line 23 of file EntityPreloader.php.

Member Data Documentation

Elgg\EntityPreloader::$_callable_cache_checker = '_elgg_retrieve_cached_entity'

DO NOT USE.

For unit test mocking private

Definition at line 68 of file EntityPreloader.php.

Elgg\EntityPreloader::$_callable_entity_loader = 'elgg_get_entities'

DO NOT USE.

For unit test mocking private

Definition at line 74 of file EntityPreloader.php.


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