Diogenes_Barrel Class Reference

List of all members.

Public Member Functions
	Diogenes_Barrel ($alias)
	create ($alias, &$caller)
	destroy ($alias, &$caller)
	getLocation ($PID)
	getPages ()
	getPID ($dir)
	getPlugins ($page=0)
	hasFlag ($flag)
	makePath ($path, &$caller)
	rmPath ($path, &$caller)
	compileTree ()
	compilePageTree (&$tpages, $PID, $ploc)
	loadPlugins (&$bpage)
	readPlugins ()
	readTree ()
Public Attributes
	$alias
	$table_menu
	$table_page
	$flags
	$options
	$homepage
	$spool
	$vhost
	$treeCache
	$treeCacheFile
	$pluginsCache
	$pluginsCacheFile

---

Detailed Description

This class describes a Diogenes Barrel.

Definition at line 28 of file Barrel.php.

---

Member Function Documentation

Diogenes_Barrel::Diogenes_Barrel

(

$

alias

)

Construct a Diogenes Barrel.

Parameters:

$alias

Definition at line 71 of file Barrel.php.

References $flags, and readTree().

Here is the call graph for this function:

Diogenes_Barrel::create	(	$	alias,
		&$	caller
	)

Create a new Diogenes barrel. This creates the database, RCS and spool entries for the new barrel.

Parameters:

	$alias
	$caller

Definition at line 102 of file Barrel.php.

References $alias, and $homepage.

Referenced by Diogenes_Barrel_Editor::run().

Diogenes_Barrel::destroy	(	$	alias,
		&$	caller
	)

Destroy a Diogenes barrel. This removes the related database, RCS and spool entries.

Parameters:

	$alias
	$caller

Sanity check

Definition at line 184 of file Barrel.php.

References $alias.

Referenced by Diogenes_Barrel_Editor::run().

Diogenes_Barrel::getLocation

(

$

PID

)

Return the location corresponding to a given page ID

Parameters:

$PID

Definition at line 213 of file Barrel.php.

Referenced by rmPath().

Diogenes_Barrel::getPages

(

)

Return all the barrel's pages.

Definition at line 222 of file Barrel.php.

Diogenes_Barrel::getPID

(

$

dir

)

Return the page ID matching a given directory location

Parameters:

$dir

Definition at line 240 of file Barrel.php.

Referenced by makePath(), and rmPath().

Diogenes_Barrel::getPlugins

(

$

page = 0

)

List the plugins that are active in a given context

Parameters:

$page

Definition at line 253 of file Barrel.php.

Referenced by loadPlugins().

Diogenes_Barrel::hasFlag

(

$

flag

)

Check whether the barrel has a given flag

Parameters:

$flag

Definition at line 271 of file Barrel.php.

Diogenes_Barrel::makePath	(	$	path,
		&$	caller
	)

Create a page with the given path, and return its PID.

Parameters:

	$path
	$caller

Definition at line 282 of file Barrel.php.

References getPID().

Here is the call graph for this function:

Diogenes_Barrel::rmPath	(	$	path,
		&$	caller
	)

Recursively delete a given path.

Parameters:

	$path
	$caller

Definition at line 309 of file Barrel.php.

References Diogenes_Barrel_Page::delete(), getLocation(), and getPID().

Here is the call graph for this function:

Diogenes_Barrel::compileTree

(

)

Compile the directory tree

Definition at line 346 of file Barrel.php.

References $homepage, and compilePageTree().

Referenced by readTree().

Here is the call graph for this function:

Diogenes_Barrel::compilePageTree	(	&$	tpages,
		$	PID,
		$	ploc
	)

Compile a single page

Definition at line 377 of file Barrel.php.

Referenced by compileTree().

Diogenes_Barrel::loadPlugins

(

&$

bpage

)

Load all plugins for the specified page.

Parameters:

$bpage

Definition at line 402 of file Barrel.php.

References getPlugins().

Here is the call graph for this function:

Diogenes_Barrel::readPlugins

(

)

Read the compiled plugin cache

Definition at line 419 of file Barrel.php.

Diogenes_Barrel::readTree

(

)

Read the compiled directory tree

Definition at line 429 of file Barrel.php.

References compileTree().

Referenced by Diogenes_Barrel().

Here is the call graph for this function:

---

Member Data Documentation

Diogenes_Barrel::$alias

The barrel's alias.

Definition at line 31 of file Barrel.php.

Referenced by create(), and destroy().

Diogenes_Barrel::$table_menu

The database table holding the menus

Definition at line 34 of file Barrel.php.

Diogenes_Barrel::$table_page

The database table holding the pages

Definition at line 37 of file Barrel.php.

Diogenes_Barrel::$flags

The site's flags.

Definition at line 40 of file Barrel.php.

Referenced by Diogenes_Barrel().

Diogenes_Barrel::$options

The site's options.

Definition at line 43 of file Barrel.php.

Diogenes_Barrel::$homepage

Cache of the homepage ID

Definition at line 46 of file Barrel.php.

Referenced by compileTree(), and create().

Diogenes_Barrel::$spool

Handle to the spool

Definition at line 49 of file Barrel.php.

Diogenes_Barrel::$vhost

If the barrel is running on a virtualhost.

Definition at line 52 of file Barrel.php.

Diogenes_Barrel::$treeCache

Cache of tree

Definition at line 55 of file Barrel.php.

Diogenes_Barrel::$treeCacheFile

File containing the tree cache.

Definition at line 58 of file Barrel.php.

Diogenes_Barrel::$pluginsCache

Cache of the plugins

Definition at line 61 of file Barrel.php.

Diogenes_Barrel::$pluginsCacheFile

File containing the plugin cache.

Definition at line 64 of file Barrel.php.

---

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

• Barrel.php

---