Public Member Functions

BeConfigure Class Reference

BeConfigure class handle BEdita configuration. More...

List of all members.

Public Member Functions

 initConfig ()
 initialize BEdita static configuration setting cache and add plugged model and component path
 cacheConfig ()
 cache object types array and module plugged configuration
 addModulesPaths (array $cachedConfig)
 add models and components module plugin paths to BEdita core paths
 setExtAuthTypes ()
 write in configuration the external authorization types supported
 tableExists ($tableName, $datasource="default")
 check if table/s exist in certain database connection
 loadPluginLocalConfig ($pluginName, $configName= 'config_local')
 load local configuration of module plugged file has to be named config_local.php and has to be in config folder of plugin
 mergeAllRelations ($forceReading=false)
 Returns array with all relations, merging defaultObjRelationType, objRelationType, plugged.objRelationType Set also self::relations and use it when it's not empty and no forced reading is request.
 getObjectTypeId ($modelName)
 Tries to read ObjectType ID for given model from config, or from database as a fallback.

Detailed Description

BeConfigure class handle BEdita configuration.

Definition at line 27 of file be_configure.php.


Member Function Documentation

BeConfigure::addModulesPaths ( array $  cachedConfig  ) 

add models and components module plugin paths to BEdita core paths

Parameters:
array $cachedConfig configuration cached

Definition at line 167 of file be_configure.php.

Referenced by cacheConfig(), and initConfig().

BeConfigure::cacheConfig (  ) 

cache object types array and module plugged configuration

Returns:
array configuration cached

Definition at line 56 of file be_configure.php.

References addModulesPaths(), mergeAllRelations(), and tableExists().

Referenced by initConfig().

BeConfigure::getObjectTypeId ( modelName  ) 

Tries to read ObjectType ID for given model from config, or from database as a fallback.

Parameters:
string $modelName Model name.
Returns:
int ObjectType ID, or `null` if none found.

Definition at line 290 of file be_configure.php.

BeConfigure::loadPluginLocalConfig ( pluginName,
configName = 'config_local' 
)

load local configuration of module plugged file has to be named config_local.php and has to be in config folder of plugin

Parameters:
string $pluginName

Definition at line 234 of file be_configure.php.

BeConfigure::mergeAllRelations ( forceReading = false  ) 

Returns array with all relations, merging defaultObjRelationType, objRelationType, plugged.objRelationType Set also self::relations and use it when it's not empty and no forced reading is request.

Parameters:
boolean $forceReading true to force to read from config also if self::relations is populated
Returns:
array

Definition at line 253 of file be_configure.php.

Referenced by cacheConfig().

BeConfigure::setExtAuthTypes (  ) 

write in configuration the external authorization types supported

Returns:
array of authorization type

Definition at line 185 of file be_configure.php.

BeConfigure::tableExists ( tableName,
datasource = "default" 
)

check if table/s exist in certain database connection

Parameters:
mixed $tableName, table name or array of table names
string $datasource, datasource to use
Returns:
boolean

Definition at line 218 of file be_configure.php.

Referenced by cacheConfig().


The documentation for this class was generated from the following file:
Generated on Fri Dec 11 2015 15:29:46 by Doxygen 1.7.1  BEditaBEdita 3.7 Corylus