Persistent, installation-wide key-value storage. More...

Public Member Functions
	__construct (BaseCache $cache, Database $db, SessionManagerService $session_manager, EventsService $events, Translator $translator, ViewsService $views, Config $config, SystemMessagesService $system_messages, Request $request)
	Constructor. More...

	getPath ()
	Get the plugin path for this installation, ending with slash. More...

	setBootPlugins (array $plugins=null, bool $order_plugins=true)
	Set the list of active plugins according to the boot data cache. More...

	clear ()
	Clear plugin caches. More...

	invalidate ()
	Invalidate plugin cache. More...

	getDirsInDir (string $dir=null)
	Returns a list of plugin directory names from a base directory. More...

	generateEntities ()
	Discovers plugins in the plugins_path setting and creates entities for them if they don't exist. More...

	cache (\ElggPlugin $plugin)
	Cache a reference to this plugin by its ID. More...

	invalidateCache ($plugin_id)
	Remove plugin from cache. More...

	get (string $plugin_id)
	Returns an object with the path $path. More...

	exists (string $id)
	Returns if a plugin exists in the system. More...

	getMaxPriority ()
	Returns the highest priority of the plugins. More...

	isActive (string $plugin_id)
	Returns if a plugin is active for a current site. More...

	build ()
	Registers lifecycle events for all active plugins sorted by their priority. More...

	register ()
	Autoload plugin classes and files Register views, translations and custom entity types. More...

	boot ()
	Boot the plugins. More...

	init ()
	Initialize plugins. More...

	ready ()
	Run plugin ready handlers. More...

	upgrade ()
	Run plugin upgrade handlers. More...

	shutdown ()
	Run plugin shutdown handlers. More...

	find (string $status= 'active')
	Returns an ordered list of plugins. More...

	setPriorities (array $order)
	Reorder plugins to an order specified by the array. More...

	reindexPriorities ()
	Reindexes all plugin priorities starting at 1. More...

	setPriority (\ElggPlugin $plugin, int $priority)
	Set plugin priority and adjust the priorities of other plugins. More...

Public Attributes
const	BUNDLED_PLUGINS

Protected Member Functions
	disable (\ElggPlugin $plugin,\Exception $previous)
	Disable a plugin upon exception. More...

	orderPluginsByPriority (array $plugins=[], string $volatile_data_name=null)
	Sorts plugins by priority. More...

Protected Attributes
array	$boot_plugins

Database	$db

SessionManagerService	$session_manager

EventsService	$events

Translator	$translator

ViewsService	$views

Config	$config

SystemMessagesService	$system_messages

Context	$context

Detailed Description

Persistent, installation-wide key-value storage.

Definition at line 29 of file Plugins.php.

Constructor & Destructor Documentation

Elgg\Database\Plugins::__construct	(	BaseCache	$cache,
		Database	$db,
		SessionManagerService	$session_manager,
		EventsService	$events,
		Translator	$translator,
		ViewsService	$views,
		Config	$config,
		SystemMessagesService	$system_messages,
		Request	$request
	)

Constructor.

Parameters

BaseCache	$cache	Cache for referencing plugins by ID
Database	$db	Database
SessionManagerService	$session_manager	Session
EventsService	$events	Events
Translator	$translator	Translator
ViewsService	$views	Views service
Config	$config	Config
SystemMessagesService	$system_messages	System messages
Request	$request	Context

Definition at line 103 of file Plugins.php.

Member Function Documentation

Elgg\Database\Plugins::boot ( )

Boot the plugins.

Returns: void

Definition at line 540 of file Plugins.php.

Elgg\Database\Plugins::build ( )

Registers lifecycle events for all active plugins sorted by their priority.

Note: This is called on every page load. If a plugin is active and problematic, it will be disabled and a visible error emitted. This does not check the deps system because that was too slow.

Returns: bool

Definition at line 488 of file Plugins.php.

Elgg\Database\Plugins::cache ( \ElggPlugin $plugin )

Cache a reference to this plugin by its ID.

Parameters

\ElggPlugin $plugin the plugin to cache

Returns: void

Definition at line 361 of file Plugins.php.

Elgg\Database\Plugins::clear ( )

Clear plugin caches.

Returns: void

Definition at line 183 of file Plugins.php.

Elgg\Database\Plugins::disable	(	\ElggPlugin	$plugin,
		\Exception	$previous
	)

protected

Disable a plugin upon exception.

Parameters

\ElggPlugin	$plugin	Plugin entity to disable
\Exception	$previous	Exception thrown

Returns: void

Definition at line 663 of file Plugins.php.

Elgg\Database\Plugins::exists ( string $id )

Returns if a plugin exists in the system.

Warning: This checks only plugins that are registered in the system! If the plugin cache is outdated, be sure to regenerate it with _elgg_generate_plugin_objects() first.

Parameters

string $id The plugin ID.

Returns: bool

Definition at line 434 of file Plugins.php.

Elgg\Database\Plugins::find ( string $status = 'active' )

Returns an ordered list of plugins.

Parameters

string $status The status of the plugins. active, inactive, or all.

Returns: []

Definition at line 700 of file Plugins.php.

Elgg\Database\Plugins::generateEntities ( )

Discovers plugins in the plugins_path setting and creates entities for them if they don't exist.

If there are plugins with entities but not actual files, will disable the entities and mark as inactive. The object holds config data, so don't delete.

Returns: bool

Definition at line 239 of file Plugins.php.

Elgg\Database\Plugins::get ( string $plugin_id )

Returns an object with the path $path.

Parameters

string $plugin_id The id (dir name) of the plugin. NOT the guid.

Returns: |null

Definition at line 393 of file Plugins.php.

Elgg\Database\Plugins::getDirsInDir ( string $dir = null )

Returns a list of plugin directory names from a base directory.

Parameters

string $dir A dir to scan for plugins. Defaults to config's plugins_path. Must have a trailing slash.

Returns: array Array of directory names (not full paths)

Definition at line 204 of file Plugins.php.

Elgg\Database\Plugins::getMaxPriority ( )

Returns the highest priority of the plugins.

Returns: int

Definition at line 443 of file Plugins.php.

Elgg\Database\Plugins::getPath ( )

Get the plugin path for this installation, ending with slash.

Returns: string

Definition at line 131 of file Plugins.php.

Elgg\Database\Plugins::init ( )

Initialize plugins.

Returns: void

Definition at line 564 of file Plugins.php.

Elgg\Database\Plugins::invalidate ( )

Invalidate plugin cache.

Returns: void

Definition at line 192 of file Plugins.php.

Elgg\Database\Plugins::invalidateCache ( $plugin_id )

Remove plugin from cache.

Parameters

string $plugin_id Plugin ID

Returns: void

Definition at line 376 of file Plugins.php.

Elgg\Database\Plugins::isActive ( string $plugin_id )

Returns if a plugin is active for a current site.

Parameters

string $plugin_id The plugin ID

Returns: bool

Definition at line 466 of file Plugins.php.

Elgg\Database\Plugins::orderPluginsByPriority	(	array	$plugins = `[]`,
		string	$volatile_data_name = `null`
	)

protected

Sorts plugins by priority.

Parameters

Definition at line 773 of file Plugins.php.

Elgg\Database\Plugins::ready ( )

Run plugin ready handlers.

Returns: void

Definition at line 588 of file Plugins.php.

Elgg\Database\Plugins::register ( )

Autoload plugin classes and files Register views, translations and custom entity types.

Returns: void

Definition at line 516 of file Plugins.php.

Elgg\Database\Plugins::reindexPriorities ( )

Reindexes all plugin priorities starting at 1.

Returns: bool

Definition at line 869 of file Plugins.php.

Elgg\Database\Plugins::setBootPlugins	(	array	$plugins = `null`,
		bool	$order_plugins = `true`
	)

Set the list of active plugins according to the boot data cache.

Parameters

Definition at line 148 of file Plugins.php.

Elgg\Database\Plugins::setPriorities ( array $order )

Reorder plugins to an order specified by the array.

Plugins not included in this array will be appended to the end.

Note: This doesn't use the ->setPriority() method because all plugins are being changed and we don't want it to automatically reorder plugins.

Parameters

array $order An array of plugin ids in the order to set them

Returns: bool

Definition at line 808 of file Plugins.php.

Elgg\Database\Plugins::setPriority	(	\ElggPlugin	$plugin,
		int	$priority
	)

Set plugin priority and adjust the priorities of other plugins.

Parameters

\ElggPlugin	$plugin	Plugin
int	$priority	New priority

Returns: int|false

Definition at line 881 of file Plugins.php.

Elgg\Database\Plugins::shutdown ( )

Run plugin shutdown handlers.

Returns: void

Definition at line 636 of file Plugins.php.

Elgg\Database\Plugins::upgrade ( )

Run plugin upgrade handlers.

Returns: void

Definition at line 612 of file Plugins.php.

Member Data Documentation

array Elgg\Database\Plugins::$boot_plugins

protected

Definition at line 72 of file Plugins.php.

Config Elgg\Database\Plugins::$config

protected

Definition at line 84 of file Plugins.php.

Context Elgg\Database\Plugins::$context

protected

Definition at line 88 of file Plugins.php.

Database Elgg\Database\Plugins::$db

protected

Definition at line 74 of file Plugins.php.

EventsService Elgg\Database\Plugins::$events

protected

Definition at line 78 of file Plugins.php.

SessionManagerService Elgg\Database\Plugins::$session_manager

protected

Definition at line 76 of file Plugins.php.

SystemMessagesService Elgg\Database\Plugins::$system_messages

protected

Definition at line 86 of file Plugins.php.

Translator Elgg\Database\Plugins::$translator

protected

Definition at line 80 of file Plugins.php.

ViewsService Elgg\Database\Plugins::$views

protected

Definition at line 82 of file Plugins.php.

const Elgg\Database\Plugins::BUNDLED_PLUGINS

Definition at line 35 of file Plugins.php.

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

engine/classes/Elgg/Database/Plugins.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation