| Modules | |
| Author | Jaybill McCarthy |
| License | http://communit.as/docs/license |
| See Also | Cts_Db_Table_Abstract |
| Instance Variables | |
| $_name | The name of the table or view to interact with in the data source. |
| $_primary | The primary key of the table or view to interact with in the data source. |
| $_parsed_ini | |
| $errors | |
| $success | |
| $notice | |
| Instance Methods | |
| exists | Verifies the existence of a module. |
| See Also | |
| getEnabledModules | Returns a list of modules which are set as enabled in the database. |
| isEnabled | Verifies the enabled status of a module. |
| enable | Enables a module. |
| disable | The ID of the module to disable. |
| install | Installs a module. |
| uninstall | Uninstalls a module. |
| parseIni | Parses an module.ini file for a given module. |
| setDefaultConfig | |
| upgradeDatabase | Upgrades the database components for a given module to the latest version for that module. |
| setup | |
| Private or Protected Methods | |
| runFilter | Executes a filter. |
Verifies the existence of a module. This method does not check whether the module is installed or enabled. To check whether a module is enabled, use isEnabled.
| module_id | The ID of the module for which to verify its existence. |
Returns: boolean
function isEnabled( $module_id )
Verifies the enabled status of a module. Does not necessarily verify whether a module exists or is installed, but inherently, if a module comes up positive for being enabled, then it does exist and has been installed.
| module_id | The ID of the module for which to verify its enabled status. |
Returns: boolean
function install( $module_id )
Installs a module. The module files must be placed in the modules directory for it to be installable. Installation should typically be done using the modules screen in the admin tools.
| module_id | The ID of the module to install. |
Returns: boolean indicating whether the filter was successfully executed
The name of the table or view to interact with in the data source.
protected $_name
The primary key of the table or view to interact with in the data source.
protected $_primary
protected $_parsed_ini
public $errors
public $success
public $notice
Returns a list of modules which are set as enabled in the database.
function getEnabledModules( $include_default = true )
Verifies the enabled status of a module.
function isEnabled( $module_id )
Enables a module.
function enable( $module_id )
The ID of the module to disable.
function disable( $module_id )
Installs a module.
function install( $module_id )
Uninstalls a module.
function uninstall( $module_id )
Parses an module.ini file for a given module.
function parseIni( $module_id )
function setDefaultConfig( $module_id )
Upgrades the database components for a given module to the latest version for that module.
function upgradeDatabase( $module_id )
function setup( $module_id )
Executes a filter.
private function runFilter( $filter_name )