DiogenesBarrel Class Reference

Inheritance diagram for DiogenesBarrel:

[legend]Collaboration diagram for DiogenesBarrel:

[legend]List of all members.

Public Member Functions
	DiogenesBarrel ($override_pathinfo=null)
	checkPerms ($level)
	doContent ()
	doPage ($path, $bpage)
	getRcs ()
	getTemplate ($template= '')
	getTemplates ()
	isAdmin ()
	makeHead ()
	makeMenu ()
	parsePathInfo ($path)
	script_uri ()
	templatePath ($template)
	urlSite ($dir, $file= '')
	urlSiteByPid ($PID, $file= '')
Public Attributes
	$table_menu
	$alias
	$barrel
	$curpage
	$pathinfo
	$canedit = false

---

Detailed Description

This class is used to display a page of a Diogenes barrel, that is an RCS-managed website with a virtual directory structure.

Definition at line 30 of file diogenes.barrel.inc.php.

---

Member Function Documentation

DiogenesBarrel::DiogenesBarrel

(

$

override_pathinfo = null

)

Constructs a Smarty-derived object to display contents within a barrel.

Parameters:

$override_pathinfo

Definition at line 58 of file diogenes.barrel.inc.php.

References DiogenesPage::DiogenesPage(), DiogenesPage::kill404(), makeHead(), and parsePathInfo().

Referenced by DiogenesAdmin::DiogenesAdmin().

Here is the call graph for this function:

DiogenesBarrel::checkPerms

(

$

level

)

Check the user has the right permissions. Read the user's permissions for the current site from database.

Parameters:

level

the required permissions level

Definition at line 99 of file diogenes.barrel.inc.php.

References DiogenesPage::kill().

Referenced by DiogenesAdmin::DiogenesAdmin(), and doContent().

Here is the call graph for this function:

DiogenesBarrel::doContent

(

)

Read the contents for the current location.

Definition at line 114 of file diogenes.barrel.inc.php.

References checkPerms(), DiogenesPage::display(), DiogenesPage::doLogout(), doPage(), Diogenes_Barrel_Page::fromDb(), getRcs(), DiogenesPage::kill404(), and DiogenesPage::startSession().

Here is the call graph for this function:

DiogenesBarrel::doPage	(	$	path,
		$	bpage
	)

Display a page within the header/footer framework.

Parameters:

	path	the path of the file
	bpage	a Diogenes_Barrel_Page representing the current page

Definition at line 200 of file diogenes.barrel.inc.php.

References DiogenesPage::getTemplate().

Referenced by doContent().

Here is the call graph for this function:

DiogenesBarrel::getRcs

(

)

Return an RCS handle.

Definition at line 238 of file diogenes.barrel.inc.php.

Referenced by doContent().

DiogenesBarrel::getTemplate

(

$

template = ''

)

Returns the master template for the current context.

Parameters:

template

Definition at line 249 of file diogenes.barrel.inc.php.

References templatePath().

Here is the call graph for this function:

DiogenesBarrel::getTemplates

(

)

Returns the available master templates.

Reimplemented from DiogenesPage.

Definition at line 267 of file diogenes.barrel.inc.php.

DiogenesBarrel::isAdmin

(

)

Is the user an administrator for the current barrel ?

Definition at line 285 of file diogenes.barrel.inc.php.

Referenced by makeMenu().

DiogenesBarrel::makeHead

(

)

Build the page's "head" tag.

Definition at line 292 of file diogenes.barrel.inc.php.

References DiogenesCorePage::url(), and urlSite().

Referenced by DiogenesBarrel().

Here is the call graph for this function:

DiogenesBarrel::makeMenu

(

)

Build the barrel's menu.

Reimplemented from DiogenesPage.

Reimplemented in DiogenesAdmin.

Definition at line 326 of file diogenes.barrel.inc.php.

References isAdmin(), DiogenesPage::isLogged(), urlSite(), and urlSiteByPid().

Here is the call graph for this function:

DiogenesBarrel::parsePathInfo

(

$

path

)

Break down a PATH_INFO into site, page id and file Directories *must* be accessed with a final slash.

Parameters:

path

the path to parse

Definition at line 373 of file diogenes.barrel.inc.php.

Referenced by DiogenesBarrel().

DiogenesBarrel::script_uri

(

)

Return the current URI.

Reimplemented from DiogenesCorePage.

Definition at line 386 of file diogenes.barrel.inc.php.

DiogenesBarrel::templatePath

(

$

template

)

Returns the path to a given template.

Reimplemented from DiogenesPage.

Definition at line 396 of file diogenes.barrel.inc.php.

Referenced by getTemplate().

DiogenesBarrel::urlSite	(	$	dir,
		$	file = ''
	)

Returns the URL to one of the barrel's pages relative to the current location.

Parameters:

	dir
	file

Definition at line 421 of file diogenes.barrel.inc.php.

Referenced by makeHead(), makeMenu(), DiogenesAdmin::makeMenu(), and urlSiteByPid().

DiogenesBarrel::urlSiteByPid	(	$	PID,
		$	file = ''
	)

Returns the URL to one of the barrel's pages relative to the current location.

Parameters:

	dir
	file

Definition at line 435 of file diogenes.barrel.inc.php.

References urlSite().

Referenced by makeMenu().

Here is the call graph for this function:

---

Member Data Documentation

DiogenesBarrel::$table_menu

The database table holding the menus

Definition at line 35 of file diogenes.barrel.inc.php.

DiogenesBarrel::$alias

The barrel's alias.

Definition at line 38 of file diogenes.barrel.inc.php.

DiogenesBarrel::$barrel

The Diogenes_Barrel representing the barrel

Definition at line 41 of file diogenes.barrel.inc.php.

DiogenesBarrel::$curpage

A Diogenes_Barrel_Page representing the current page

Definition at line 45 of file diogenes.barrel.inc.php.

DiogenesBarrel::$pathinfo

Information about the current location

Definition at line 48 of file diogenes.barrel.inc.php.

DiogenesBarrel::$canedit = false

Can the current user edit this page?

Definition at line 51 of file diogenes.barrel.inc.php.

---

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

• diogenes.barrel.inc.php

---