Preload entities based on properties of fetched objects. More...

Public Member Functions
	__construct (protected EntityCache $entity_cache)
	Constructor. More...

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

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

Detailed Description

Preload entities based on properties of fetched objects.

Definition at line 13 of file EntityPreloader.php.

Constructor & Destructor Documentation

Elgg\EntityPreloader::__construct ( protected EntityCache $entity_cache )

Constructor.

Parameters

EntityCache $entity_cache Entity cache

Definition at line 22 of file EntityPreloader.php.

Elgg\EntityPreloader::getGuidsToLoad	(	array	$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")

Definition at line 58 of file EntityPreloader.php.

Elgg\EntityPreloader::preload	(	array	$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")

Definition at line 34 of file EntityPreloader.php.

const Elgg\EntityPreloader::MAX_PRELOAD = 256

Definition at line 15 of file EntityPreloader.php.

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