Docs For Class ConfigCache

Class: ConfigCache

Class Overview

MojaviObject
   |
   --ConfigCache

ConfigCache allows you to customize the format of a configuration file to make it easy-to-use, yet still provide a PHP formatted result for direct inclusion into your modules.

Author(s):

Sean Kerr (skerr@mojavi.org)

Version:

$Id: ConfigCache.class.php 741 2005-01-03 19:38:23Z seank $

Copyright:

Methods

Inherited Methods

Class: MojaviObject

MojaviObject::toString(): Retrieve a string representation of this object.

Class Details

[line 25]
ConfigCache allows you to customize the format of a configuration file to make it easy-to-use, yet still provide a PHP formatted result for direct inclusion into your modules.

Tags:

version:	$Id: ConfigCache.class.php 741 2005-01-03 19:38:23Z seank $
since:	3.0.0
copyright:	(c) Sean Kerr, http://www.mojavi.org
author:	Sean Kerr (skerr@mojavi.org)

Class Methods

method checkConfig [line 156]

string checkConfig(
string
$config)

Check to see if a configuration file has been modified and if so recompile the cache file associated with it.

If the configuration file path is relative, the path itself is relative to the Mojavi MO_WEBAPP_DIR application setting.

Tags:

return:	An absolute filesystem path to the cache filename associated with this specified configuration file.
static:
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)
throws:	ConfigurationException If a requested configuration file does not exist.

Parameters:

string

$config

A filesystem path to a configuration file.

[ Top ]

method clear [line 205]

void clear(
)

Clear all configuration cache files.

Tags:

static:
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

[ Top ]

method getCacheName [line 280]

string getCacheName(
string
$config)

Convert a normal filename into a cache filename.

Tags:

return:	An absolute filesystem path to a cache filename.
static:
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string

$config

A normal filename.

[ Top ]

method import [line 317]

void import(
string
$config, [bool
$once = true])

Import a configuration file.

If the configuration file path is relative, the path itself is relative to the Mojavi MO_WEBAPP_DIR application setting.

Tags:

static:
access:	public
since:	3.0.0
author:	Sean Kerr (skerr@mojavi.org)

Parameters:

string	$config	A filesystem path to a configuration file.
bool	$once	Only allow this configuration file to be included once per request?

[ Top ]

Documentation generated on Tue, 21 Feb 2006 01:45:11 +0900 by phpDocumentor 1.3.0RC5