Diogenes_Plugins Class Reference

List of all members.

Public Member Functions
	Diogenes_Plugins (&$dbh, $plugdir, $cachedir)
	cacheFile ($barrel)
	cacheGet ($cache, $barrel, $page, $plugin)
	cacheGetAtPos ($cache, $barrel, $page, $pos)
	cachedActive ($cache, $barrel, $page)
	cachedAvailable ($cache, $barrel, $page)
	clean_database (&$page)
	compileCache ($cachefile, $barrel)
	load ($plugentry)
	readCache ($cachefile, $barrel)
	trace_format ()
Public Attributes
	$loaded = array()
	$cachedir
	$plugdir

---

Detailed Description

This class describes Diogenes' plugins.

Definition at line 26 of file Plugins.php.

---

Member Function Documentation

Diogenes_Plugins::Diogenes_Plugins	(	&$	dbh,
		$	plugdir,
		$	cachedir
	)

Constructs a new holder for Diogenes plugins.

Parameters:

	$dbh
	$plugdir
	$cachedir

Definition at line 44 of file Plugins.php.

References $cachedir, and $plugdir.

Diogenes_Plugins::cacheFile

(

$

barrel

)

Return the path of the cache file

Parameters:

$barrel

Definition at line 56 of file Plugins.php.

Diogenes_Plugins::cacheGet	(	$	cache,
		$	barrel,
		$	page,
		$	plugin
	)

Return the cache entry for specified plugin

Parameters:

	$cache
	$barrel
	$page
	$plugin

Definition at line 70 of file Plugins.php.

Diogenes_Plugins::cacheGetAtPos	(	$	cache,
		$	barrel,
		$	page,
		$	pos
	)

Return the cache entry for a plugin at a specified position

Parameters:

	$cache
	$barrel
	$page
	$pos

Definition at line 90 of file Plugins.php.

Diogenes_Plugins::cachedActive	(	$	cache,
		$	barrel,
		$	page
	)

List the plugins that are active in a given context

Parameters:

	$cache
	$barrel
	$page

Definition at line 108 of file Plugins.php.

Diogenes_Plugins::cachedAvailable	(	$	cache,
		$	barrel,
		$	page
	)

Returns an array of cache entries representing the available plugins in a given context

Parameters:

	$cache
	$barrel
	$page

Definition at line 129 of file Plugins.php.

Diogenes_Plugins::clean_database

(

&$

page

)

Remove database references to plugins that are not available.

Definition at line 146 of file Plugins.php.

Diogenes_Plugins::compileCache	(	$	cachefile,
		$	barrel
	)

Compile plugin cache.

Parameters:

	$cachefile
	$barrel

Definition at line 169 of file Plugins.php.

Diogenes_Plugins::load

(

$

plugentry

)

Load the specified plugin

Parameters:

$plugentry

Definition at line 242 of file Plugins.php.

Diogenes_Plugins::readCache	(	$	cachefile,
		$	barrel
	)

Read the compiled plugin cache

Parameters:

	$cachefile
	$barrel

Definition at line 274 of file Plugins.php.

Diogenes_Plugins::trace_format

(

)

Prepare plugins trace for output

Definition at line 309 of file Plugins.php.

---

Member Data Documentation

Diogenes_Plugins::$loaded = array()

Array of currently loaded plugins

Definition at line 29 of file Plugins.php.

Diogenes_Plugins::$cachedir

Directory that holds the plugins cache files

Definition at line 32 of file Plugins.php.

Referenced by Diogenes_Plugins().

Diogenes_Plugins::$plugdir

Directory that holds the plugins

Definition at line 35 of file Plugins.php.

Referenced by Diogenes_Plugins().

---

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

• Plugins.php

---