BxDolStudioInstaller Class Reference

Inheritance diagram for BxDolStudioInstaller:

Public Member Functions
	__construct ($aConfig)
	install ($aParams, $bAutoEnable=false)
	uninstall ($aParams, $bAutoDisable=false)
	delete ($aParams)
	enable ($aParams)
	disable ($aParams)
	getVendor ()
	getName ()
	getTitle ()
	getHomeDir ()
Public Member Functions inherited from BxDolInstallerUtils
	getSubtypes ($sModule)
	hashFiles ($sPath, &$aFiles)
	hashCheck ($aFiles, $iModuleId)

Protected Member Functions
	actionOperationFailed ($mixedResult)
	actionCheckDependencies ($sOperation)
	actionCheckDependenciesFailed ($mixedResult)
	actionShowIntroduction ($sOperation)
	actionShowConclusion ($sOperation)
	actionMoveSources ($sOperation)
	actionExecuteSql ($sOperation)
	actionExecuteSqlFailed ($mixedResult)
	actionInstallLanguage ($sOperation)
	actionUpdateLanguages ($sOperation)
	actionUpdateRelations ($sOperation)
	actionUpdateRelationsForAll ($sOperation)
	actionProcessConnections ($sOperation)
	actionProcessMenuTriggers ($sOperation)
	actionProcessPageTriggers ($sOperation)
	actionProcessDeletedProfiles ($sOperation)
	actionProcessEsearches ($sOperation)
	actionRegisterTranscoders ($sOperation)
	actionUnregisterTranscoders ($sOperation)
	actionClearDbCache ($sOperation)
	actionClearTemplateCache ($sOperation)
	_onInstallBefore ()
	_onInstallAfter ()
	_onEnableBefore ()
	_onEnableAfter ()
	_onDisableBefore ()
	_onDisableAfter ()
	_onUninstallBefore ()
	_onUninstallAfter ()
	_perform ($sOperationName, $aParams=array())
	_displayResult ($sAction, $bResult, $sResult='', $bHtmlResponse=true)
	_getFileManager ()
	_isCompatibleWith ()
	filePathWithoutBase ($sPath)
	getMarkersForDb ()
	cleanupMemoryAfterAction ($sModuleName, $sModuleUri, $iModuleId)
Protected Member Functions inherited from BxDolInstallerUtils
	hashInfo ($sPath)

Protected Attributes
	$oDb
	$_aConfig
	$_sBasePath
	$_sHomePath
	$_sModulePath
	$_bUseFtp
	$_aActions
	$_bShowOnSuccess = false
Protected Attributes inherited from BxDolInstallerUtils
	$_aNonHashableFiles = array()

Additional Inherited Members
Static Public Member Functions inherited from BxDolInstallerUtils
static	isAllowUrlInclude ()
static	getModuleConfig ($mixed)
static	isModuleInstalled ($sUri)
static	setModulePendingUninstall ($sUri, $bPendingUninstall=true)
static	isModulePendingUninstall ($sUri)
static	checkModulesPendingUninstall ()
Static Public Member Functions inherited from BxDolIO
static	isRealOwner ()
static	isExecutable ($sFile)
static	isWritable ($sFile)
static	getPermissions ($sFileName)

Detailed Description

Base class for Installer classes in modules engine.

The class contains different check functions which are used during the installation process. An object of the class is created automatically with modules installer. Installation/Uninstallation process can be controlled with config.php file located in [module]/install/ folder.

Example of usage: refer to the BoonEx modules

Memberships/ACL: Doesn't depend on user's membership.

Alerts: no alerts available

Member Function Documentation

actionProcessConnections()

BxDolStudioInstaller::actionProcessConnections ( $sOperation )

protected

Connections objects associated with module data. It must be defined which content is associated with the connection. The key is connection object name and value is array (possible array values: type, conn, table, field_id). If 'type' == 'profiles', then it is considered profiles connection and other possible param is 'conn' ('initiator', 'content' or 'both') If 'type' == 'custom' (or ommited), then other possible params are 'conn', 'table' and 'field_id'

Parameters

string

$sOperation

- operation type.

actionProcessEsearches()

BxDolStudioInstaller::actionProcessEsearches ( $sOperation )

protected

Process the list of extended search forms provided in config array.

Parameters

string

$sOperation

- operation type.

actionProcessMenuTriggers()

BxDolStudioInstaller::actionProcessMenuTriggers ( $sOperation )

protected

Process the list of menu triggers provided in config array. It must be specified in the module which adds menu item and in modules where menu items are added,

See also

BxDolMenu\processMenuTrigger

Parameters

string

$sOperation

- operation type.

actionProcessPageTriggers()

BxDolStudioInstaller::actionProcessPageTriggers ( $sOperation )

protected

Process the list of page triggers provided in config array. It must be specified in the module which adds page block and in modules where page blocks are added,

See also

BxDolPage\processPageTrigger

Parameters

string

$sOperation

- operation type.

actionRegisterTranscoders()

BxDolStudioInstaller::actionRegisterTranscoders ( $sOperation )

protected

Process the list of transcoders provided in config array. Transcoder objects to automatically register/unregister necessary alerts for.

Parameters

string

$sOperation

- operation type.

actionUnregisterTranscoders()

BxDolStudioInstaller::actionUnregisterTranscoders ( $sOperation )

protected

Process the list of transcoders provided in config array. Transcoder objects to automatically register/unregister necessary alerts for.

Parameters

string

$sOperation

- operation type.

actionUpdateRelations()

BxDolStudioInstaller::actionUpdateRelations ( $sOperation )

protected

NOTE. The action is ONLY needed for dependent module to let Notifications based module(s) know that he(they) should update (request and save) handlers from this dependent module.

Reimplemented in BxDolStudioUpdater.

actionUpdateRelationsForAll()

BxDolStudioInstaller::actionUpdateRelationsForAll ( $sOperation )

protected

NOTE. The action is ONLY needed for Notifications based modules to update (request and save) handlers from all dependent modules.

Reimplemented in BxDolStudioUpdater.

filePathWithoutBase()

BxDolStudioInstaller::filePathWithoutBase ( $sPath )

protected

Reimplemented from BxDolInstallerUtils.

---

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

• studio/classes/BxDolStudioInstaller.php