oxModule Class Reference

Inheritance diagram for oxModule:

Collaboration diagram for oxModule:

List of all members.

Public Member Functions
	setModuleData ($aModule)
	load ($sModuleId)
	loadByDir ($sModuleDir)
	getDescription ()
	getTitle ()
	getId ()
	getExtensions ()
	getFiles ()
	getIdByPath ($sModule)
	getInfo ($sName, $iLang=null)
	isActive ()
	hasExtendClass ()
	isRegistered ()
	hasMetadata ()
	getMetadataPath ()
	getModulePath ($sModuleId=null)
	getModuleFullPath ($sModuleId=null)
	getModulePaths ()
	getTemplates ($sModuleId=null)
Protected Member Functions
	_countActivatedExtensions ($aModuleExtensions, $aInstalledExtensions)
	_countExtensions ($aModuleExtensions)
	_isExtensionsActive ()
	_isInDisabledList ($sId)
Protected Attributes
	$_aModule = array()
	$_blMetadata = false
	$_blRegistered = false

---

Detailed Description

Module class.

Definition at line 9 of file oxmodule.php.

---

Member Function Documentation

oxModule._countActivatedExtensions	(	$	aModuleExtensions,
		$	aInstalledExtensions
	)			[protected]

Counts activated module extensions.

Parameters:

	array	$aModuleExtensions Module extensions
	array	$aInstalledExtensions Installed extensions

Returns:

int

Definition at line 367 of file oxmodule.php.

oxModule._countExtensions

(

$

aModuleExtensions

)

[protected]

Counts module extensions.

Parameters:

array

$aModuleExtensions Module extensions

Returns:

int

Definition at line 392 of file oxmodule.php.

oxModule._isExtensionsActive

(

)

[protected]

Checks if module extensions count is the same as in activated extensions list.

Returns:

bool

Definition at line 411 of file oxmodule.php.

oxModule._isInDisabledList

(

$

sId

)

[protected]

Checks if module is in disabled list.

Parameters:

string

$sId Module id

Returns:

bool

Definition at line 430 of file oxmodule.php.

oxModule.getDescription

(

)

Get module description

Returns:

string

Definition at line 98 of file oxmodule.php.

oxModule.getExtensions

(

)

Returns array of module extensions.

Returns:

array

Definition at line 132 of file oxmodule.php.

oxModule.getFiles

(

)

Returns array of module PHP files.

Returns:

array

Definition at line 142 of file oxmodule.php.

oxModule.getId

(

)

Get module ID

Returns:

string

Definition at line 122 of file oxmodule.php.

oxModule.getIdByPath

(

$

sModule

)

Get module ID

Parameters:

string

$sModule extension full path

Returns:

string

Definition at line 154 of file oxmodule.php.

oxModule.getInfo	(	$	sName,
		$	iLang = null
	)

Get module info item. If second param is passed, will try to get value according selected language.

Parameters:

	string	$sName name of info item to retrieve
	string	$iLang language ID

Returns:

mixed

Definition at line 185 of file oxmodule.php.

oxModule.getMetadataPath

(

)

Get full path to module metadata file.

Returns:

string

Definition at line 271 of file oxmodule.php.

oxModule.getModuleFullPath

(

$

sModuleId = null

)

Returns full module path

Parameters:

string

$sModuleId

Returns:

string

Definition at line 312 of file oxmodule.php.

oxModule.getModulePath

(

$

sModuleId = null

)

Get module dir

Parameters:

string

$sModuleId Module ID

Returns:

string

Definition at line 288 of file oxmodule.php.

oxModule.getModulePaths

(

)

Get module id's with path

Returns:

array

Definition at line 330 of file oxmodule.php.

oxModule.getTemplates

(

$

sModuleId = null

)

Return templates affected by template blocks for given module id.

Parameters:

string

$sModuleId Module id

Returns:

array

Definition at line 342 of file oxmodule.php.

oxModule.getTitle

(

)

Get module title

Returns:

string

Definition at line 110 of file oxmodule.php.

oxModule.hasExtendClass

(

)

Checks if has extend class.

Returns:

bool

Definition at line 237 of file oxmodule.php.

oxModule.hasMetadata

(

)

Checks if module has metadata

Returns:

bool

Definition at line 261 of file oxmodule.php.

oxModule.isActive

(

)

Check if extension is active

Returns:

bool

Definition at line 218 of file oxmodule.php.

oxModule.isRegistered

(

)

Checks if module is registered in any way

Returns:

bool

Definition at line 251 of file oxmodule.php.

oxModule.load

(

$

sModuleId

)

Load module info

Parameters:

string

$sModuleId Module ID

Returns:

bool

Definition at line 50 of file oxmodule.php.

oxModule.loadByDir

(

$

sModuleDir

)

Load module by dir name

Parameters:

string

$sModuleDir Module dir name

Returns:

bool

Definition at line 76 of file oxmodule.php.

oxModule.setModuleData

(

$

aModule

)

Set passed module data

Parameters:

array

$aModule module data

Definition at line 38 of file oxmodule.php.

---

Member Data Documentation

oxModule.$_aModule = array() [protected]

Definition at line 17 of file oxmodule.php.

oxModule.$_blMetadata = false [protected]

Definition at line 24 of file oxmodule.php.

oxModule.$_blRegistered = false [protected]

Definition at line 31 of file oxmodule.php.

---

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

• core/oxmodule.php