Documentation

pm_Context
in package

Define module constants and setup context

Tags
since
11.0

Table of Contents

getActionUrl()  : string
Retrieve URL for controller action
getBaseUrl()  : string
Retrieve module base URL
getBuyUrl()  : string
Retrieve module buy URL
getHtdocsDir()  : string
Retrieve path to module's htdocs directory
getModuleId()  : string
Retrieve module identity
getModuleInfo()  : Zend_Db_Table_Row|Db_Table_Row_Module
Retrieve information about module from registry
getModulesListUrl()  : string
Retrieve URL for modules list
getPlibDir()  : string
Retrieve path to module's plib directory
getUpgradeLicenseUrl()  : string
Retrieve URL for license upgrade (or buy URL as a fallback)
getVarDir()  : string
Retrieve path to module's var directory
init()  : mixed
Initialize module context
isInitialized()  : bool
Check if module context is initialized or not
reset()  : mixed
Reset module context

Methods

getActionUrl()

Retrieve URL for controller action

public static getActionUrl(string $controller[, string $action = 'index' ]) : string
Parameters
$controller : string
$action : string = 'index'
Tags
since
12.0
Return values
string

getBaseUrl()

Retrieve module base URL

public static getBaseUrl() : string
Return values
string

getBuyUrl()

Retrieve module buy URL

public static getBuyUrl() : string
Tags
since
12.5
Return values
string

getHtdocsDir()

Retrieve path to module's htdocs directory

public static getHtdocsDir() : string
Return values
string

getModuleId()

Retrieve module identity

public static getModuleId() : string
Return values
string

getModuleInfo()

Retrieve information about module from registry

public static getModuleInfo() : Zend_Db_Table_Row|Db_Table_Row_Module
Return values
Zend_Db_Table_Row|Db_Table_Row_Module

getModulesListUrl()

Retrieve URL for modules list

public static getModulesListUrl() : string
Return values
string

getPlibDir()

Retrieve path to module's plib directory

public static getPlibDir() : string
Return values
string

getUpgradeLicenseUrl()

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

public static getUpgradeLicenseUrl() : string
Tags
since
17.5
Return values
string

getVarDir()

Retrieve path to module's var directory

public static getVarDir() : string
Return values
string

init()

Initialize module context

public static init(string $moduleId) : mixed
Parameters
$moduleId : string
Return values
mixed

isInitialized()

Check if module context is initialized or not

public static isInitialized() : bool
Tags
since
12.0
Return values
bool

reset()

Reset module context

public static reset() : mixed
Tags
since
11.5
Return values
mixed

Search results