Common
[ class tree: Common ] [ index: Common ] [ all elements ]

Class: PluginConfig

Source Location: /common/Config.php

Class Overview

Config
   |
   --PluginConfig

Configuration for plugins


Author(s):

Variables

Methods


Child classes:

ClientPluginConfig
Configuration for client plugins
ServerPluginConfig
Server plugin configuration

Inherited Variables

Inherited Methods

Class: Config

Config::__construct()
Constructor
Config::getBasePath()
Returns the client or server root path
Config::getIniArray()
Returns protected var $ini_array.
Config::getKind()
Returns type of config ('client' or 'server')
Config::getProfileParameters()
Return the name of the parameters which will be automatically set from the current profile (overriding the one from configuration).
Config::setMapId()
Sets mapId
Config::updateProfileParameters()
Set parameters values according to the current profile
Config::__get()
Property access method

Class Details

[line 191]
Configuration for plugins



Tags:

abstract:  


[ Top ]


Class Variables

$plugin =

[line 196]



Tags:

access:  protected

Type:   BasePlugin


[ Top ]



Class Methods


constructor __construct [line 213]

PluginConfig __construct( BasePlugin $plugin, ProjectHandler $projectHandler)

Constructor

Reads project's and default plugin .ini file, if they exist.




Tags:

access:  public


Overridden in child classes as:

ClientPluginConfig::__construct()
Constructor
ServerPluginConfig::__construct()
Constructor

Overrides Config::__construct() (Constructor)

Parameters:

BasePlugin   $plugin  
ProjectHandler   $projectHandler  

[ Top ]

method getPath [line 204]

string getPath( )

Returns directory where .ini are located

Directory returned is relative to client_conf/server_conf.




Tags:

return:  path
access:  public
abstract:  


Overridden in child classes as:

ClientPluginConfig::getPath()
Returns directory where .ini are located
ServerPluginConfig::getPath()

[ Top ]


Documentation generated on Thu, 04 Sep 2008 11:39:28 +0200 by phpDocumentor 1.3.0RC3