ModuleManager Class Reference

Public Member Functions
	ModuleManager ()

Static Public Member Functions
static	upgradeComponent ($version)
static	registerSerializationHandler ()
static	addCodeModule ($title, $php_code_file, $component=null, $global=false, $global_position="", $css_class="")
	This utility method adds a code module record for the specified PHP code file. More...

Detailed Description

Definition at line 8 of file module_manager.inc.

Member Function Documentation

addCodeModule()

static ModuleManager::addCodeModule (   $title,   $php_code_file,   $component = null,   $global = false,   $global_position = "",   $css_class = ""  )

static

This utility method adds a code module record for the specified PHP code file.

This can be used within upgrade scripts to programmatically deploy modules.

Parameters

string	$title	human-readable name for the module
string	$php_code_file	file path to the module code, relative either to the home directory or to a component directory if a component is specified
string	$component	(optional) name of the component containing the module code
boolean	$global	(optional) true if the module is global in scope
string	$global_position	(optional) position to display at for global modules. This is required if $global is true.
string	$css_class	(optional) CSS class to be applied to the module when renderered

Returns

Module

Definition at line 39 of file module_manager.inc.

     {
          $file = ($component) ? "{$component},{$php_code_file}" : $php_code_file;
          
          $module = new Module();
          $module->title = $title;
          $module->content_type = "Code";
          $module->php_code_file = $file;
          $module->global = $global;
          $module->global_position = $global_position;
          $module->css_class = $css_class;
          $module->save();
          return $module;
     }

ModuleManager()

ModuleManager::ModuleManager

(

)

Definition at line 10 of file module_manager.inc.

     {
          
     }

registerSerializationHandler()

static ModuleManager::registerSerializationHandler ( )

static

Definition at line 21 of file module_manager.inc.

     {
          SerializationManager::registerHandler("module", "Modules", new SimpleSerializationHandler(Module));
          return true;
     }

upgradeComponent()

static ModuleManager::upgradeComponent (   $version )

static

Definition at line 15 of file module_manager.inc.

     {
          $mgr = new ModuleUpgradeManager();
          $mgr->upgrade($version);
     }    

---

The documentation for this class was generated from the following file:

• C:/code/cms.sonjara.com/cms/components/module/module_manager.inc