Extensions API Documentation - Plesk 18.0
\

\pm_Context

Define module constants and setup context

Summary

Methods
Properties
Constants
init()
reset()
isInitialized()
getModuleId()
getPlibDir()
getHtdocsDir()
getVarDir()
getBaseUrl()
getActionUrl()
getModuleInfo()
getModulesListUrl()
getBuyUrl()
getUpgradeLicenseUrl()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A

Methods

init()

init(string  $moduleId)

Initialize module context

Parameters

string $moduleId

reset()

reset()

Reset module context

isInitialized()

isInitialized() : boolean

Check if module context is initialized or not

Returns

boolean

getModuleId()

getModuleId() : string

Retrieve module identity

Returns

string

getPlibDir()

getPlibDir() : string

Retrieve path to module's plib directory

Returns

string

getHtdocsDir()

getHtdocsDir() : string

Retrieve path to module's htdocs directory

Returns

string

getVarDir()

getVarDir() : string

Retrieve path to module's var directory

Returns

string

getBaseUrl()

getBaseUrl() : string

Retrieve module base URL

Returns

string

getActionUrl()

getActionUrl(string  $controller, string  $action = 'index') : string

Retrieve URL for controller action

Parameters

string $controller
string $action

Returns

string

getModuleInfo()

getModuleInfo() : \Zend_Db_Table_Row|\Db_Table_Row_Module

Retrieve information about module from registry

Returns

\Zend_Db_Table_Row|\Db_Table_Row_Module

getModulesListUrl()

getModulesListUrl() : string

Retrieve URL for modules list

Returns

string

getBuyUrl()

getBuyUrl() : string

Retrieve module buy URL

Returns

string

getUpgradeLicenseUrl()

getUpgradeLicenseUrl() : string

Retrieve URL for license upgrade (or buy URL as a fallback)

Returns

string