![]() |
rapila
|
Public Member Functions | |
doWidget () | |
setNew ($bIsNew=true) | |
isNew () | |
setInputName ($sInputName) | |
getElementType () | |
getInputName () | |
getSessionKey () | |
setSetting ($sSettingName, $mSettingValue) | |
allSettings () | |
__construct ($sSessionKey=null) | |
![]() | |
getModuleName () | |
getModuleInfo ($sSetting=null) | |
getDisplayName ($sLanguageId=null) | |
Static Public Member Functions | |
static | includeResources ($oResourceIncluder=null) |
static | isPersistent () |
static | needsLogin () |
static | getCustomMethods () |
static | removeStoredWidgets () |
static | getWidget ($sWidgetType, $sSessionKey=null) |
![]() | |
static | getModuleInstanceByTypeAndName ($sType, $sName) |
static | getClassNameByTypeAndName ($sType, $sName= '') |
static | getDisplayNameByTypeAndName ($sType, $sName, $sLanguageId=null) |
static | getPathArrayByTypeAndName ($sType, $sName) |
static | getModuleInfoByTypeAndName ($sType, $sName) |
static | isModuleEnabled ($sType, $sName) |
static | getDefaultRolesForModule () |
static | isModuleAllowed ($sType, $sName, $oUser=null) |
static | getModuleMetadataByTypeAndName ($sType, $sName) |
static | moduleExists ($sModuleName, $sType=null) |
static | listModulesByType ($sType, $bListEnabledOnly=true) |
static | listModulesByTypeAndAspect ($sType, $sAspect, $bListEnabledOnly=true) |
static | listModuleTypes () |
static | listAllModules ($bListEnabledOnly=true) |
static | getType () |
static | listModules ($bListEnabledOnly=true) |
static | listModulesByAspect ($sAspect, $bListEnabledOnly=true) |
static | getClassNameByName ($sModuleName) |
static | getNameByClassName ($sClassName) |
static | getDisplayNameByName ($sModuleName, $sLangugaeId=null) |
static | getModuleInstance ($sModuleName) |
static | moduleName () |
static | isValidModuleClassName ($sName) |
static | isValidModuleClassNameOfAnyType ($sName) |
static | isSingleton () |
Public Attributes | |
const | USE_NAMESPACED_CSS = true |
const | WIDGET_SESSION_KEY = 'widget_storage' |
![]() | |
const | INFO_FILE = FILENAME_INFO |
Static Protected Member Functions | |
static | includeWidgetResources ($bEndDependenciesOnJS=false, $oResourceIncluder=null) |
![]() | |
static | constructTemplateForModuleAndType ($sModuleType, $sModuleName, $sTemplateName=null, $bForceGlobalTemplatesDir=false) |
static | template ($sTemplateName=null, $bForceGlobalTemplatesDir=false) |
Protected Attributes | |
$sPersistentSessionKey = null | |
$sInputName = null | |
$aInitialSettings = array() | |
Static Protected Attributes | |
static | $MODULE_TYPE = 'widget' |
![]() | |
static | $MODULE_TYPE |
Additional Inherited Members | |
![]() | |
constructTemplate ($sTemplateName=null, $bForceGlobalTemplatesDir=false) | |
|
static |
Instanciates a widget or extracts it from the session. This method is preferred over using “new MyWidgetModule()” because it takes into account the session key as well as the disabled flag. Pass additional arguments to the module’s constructor after the session key. If your module is not persistent, do not pass a session key.
string | $sWidgetType | The widget_type (in underscore notation) |
string | null | $sSessionKey | The session key (most often null, but still required for persistent modules if you wish to pass additional parameters) |