Docs for page class.atkconfig.inc
Procedural File: class.atkconfig.inc
Source Location: /class.atkconfig.incPage Details
This file is part of the Achievo ATK distribution.
Detailed copyright and licensing information can be found in the doc/COPYRIGHT and doc/LICENSE files which should be included in the distribution.
| Version: | $Revision: 6406 $ $Id: class.atkconfig.inc 6406 2009-06-17 15:55:15Z jvansluijs $ |
| Copyright: | (c)2000-2004 Ivo Jansch |
| License: | ATK Open Source License |
Classes
| Class | Description |
|---|---|
| atkConfig | Config class for loading config files and retrieving config options. |
Constants
MF_REFERENCE [line 322]
|
Use this module only as a reference
[ Top ]
Functions
atkconfig [line 293]
|
Retrieve a configuration value.
In all of your code, you can use this method to retrieve a certain configuration setting. Any setting defined as $config_something can be retrieved as atkconfig("something").
Parameters:| String | $tag: | The name of the configuration variable (without the '$config_' prefix! |
| mixed | $default: | The default variable you want to use when the configuration variable is missing from the config file. |
API Tags:
| Return: | The value of the configuration variable. |
| Deprecated: | Use atkConfig::get() instead. |
[ Top ]
module [line 347]
|
Load a module.
This method is used in the config.inc.php or config.modules.inc file to load the modules.
Parameters:| String | $name: | The name of the module to load. |
| String | $path: | path The path where the module is located (relative or absolute). If omitted, ATK assumes that the module is installed in the default module dir (identified by $config_module_path). |
| int | $flags: | flags The module (MF_*) flags that influence how the module is loaded. |
[ Top ]