Docs For Class CMSModule

Class CMSModule

Description

Base module class.

All modules should inherit and extend this class with their functionality.

version: 1.8
abstract:
since: 0.9

Located in /class.CMSModule.php (line 34)

Method Summary

static object The &GetModuleInstance (string $module)

CMSModule CMSModule ()

mixed AddEventHandler (string $modulename, string $eventname, [boolean $removable = true])

string AdminStyle ()

boolean AllowAutoInstall ()

boolean AllowAutoUpgrade ()

boolean AllowSmartyCaching ()

boolean AllowUninstallCleanup ()

void Audit (string $itemid, string $itemname, string $action)

array CallUserTag (string $name, [array $params = array()])

boolean can_cache_output ()

boolean CheckForDependents ()

boolean CheckPermission (string $permission_name)

string CreateContentLink (string $pageid, [string $contents = ''])

nothing CreateEvent (string $eventname)

string CreateFieldsetEnd ()

string CreateFieldsetStart (string $id, string $name, [string $legend_text = ''], [string $addtext = ''], [string $addtext_legend = ''])

string CreateFileUploadInput (string $id, string $name, [string $addttext = ''], [integer $size = '10'], [integer $maxlength = '255'])

string CreateFormEnd ()

string CreateFormStart (string $id, [string $action = 'default'], [string $returnid = ''], [string $method = 'post'], [string $enctype = ''], [boolean $inline = false], [string $idsuffix = ''], [array $params = array()], [string $extra = ''])

string CreateFrontendFormStart (string $id, string $returnid, [string $action = 'default'], [string $method = 'post'], [string $enctype = ''], [boolean $inline = true], [string $idsuffix = ''], [array $params = array()])

string CreateFrontendLink (string $id, string $returnid, string $action, [string $contents = ''], [string $params = array()], [string $warn_message = ''], [boolean $onlyhref = false], [boolean $inline = true], [string $addtext = ''], [boolean $targetcontentonly = false], [string $prettyurl = ''])

string CreateInputCheckbox (string $id, string $name, [string $value = ''], [string $selectedvalue = ''], [string $addttext = ''])

string CreateInputColor (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputDataList (string $id, string $name, [string $value = ''], string $items, [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string CreateInputDate (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputDatetime (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputDatetimeLocal (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputDropdown (string $id, string $name, string $items, [string $selectedindex = -1], [string $selectedvalue = ''], [string $addttext = ''])

string CreateInputEmail (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string CreateInputFile (string $id, string $name, [string $accept = ''], [string $size = '10'], [string $addttext = ''])

string CreateInputHidden (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputMonth (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputNumber (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputPassword (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string CreateInputRadioGroup (string $id, string $name, string $items, [string $selectedvalue = ''], [string $addttext = ''], [string $delimiter = ''])

string CreateInputRange (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputReset (string $id, string $name, [string $value = 'Reset'], [string $addttext = ''])

string CreateInputSearch (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string CreateInputSelectList (string $id, string $name, string $items, [string $selecteditems = array()], [string $size = 3], [string $addttext = ''], [boolean $multiple = true])

string CreateInputSubmit (string $id, string $name, [string $value = ''], [string $addttext = ''], [string $image = ''], [string $confirmtext = ''])

string CreateInputTel (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string CreateInputText (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string CreateInputTextWithLabel (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''], [string $label = ''], [string $labeladdtext = ''])

string CreateInputTime (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateInputUrl (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string CreateInputWeek (string $id, string $name, [string $value = ''], [string $addttext = ''])

string CreateLabelForInput (string $id, string $name, [string $labeltext = ''], [string $addttext = ''])

string CreateLink (string $id, string $action, [string $returnid = ''], [string $contents = ''], [string $params = array()], [string $warn_message = ''], [boolean $onlyhref = false], [boolean $inline = false], [string $addttext = ''], [boolean $targetcontentonly = false], [string $prettyurl = ''])

string CreatePagination (string $id, string $action, string $returnid, string $page, string $totalrows, string $limit, [boolean $inline = false])

void; CreateParameter (string $param, [string $defaultval = ''], [string $helpstring = ''], [boolean $optional = true])

void CreatePermission (string $permission_name, string $permission_text)

string CreateReturnLink (string $id, string $returnid, [string $contents = ''], [string $params = array()], [boolean $onlyhref = false])

void CreateStaticRoutes ()

string CreateSyntaxArea (string $id, string $text, string $name, [string $classname = ''], [string $htmlid = ''], [string $encoding = ''], [string $stylesheet = ''], [string $cols = '80'], [string $rows = '15'], [string $addtext = ''])

string CreateTextArea (bool $enablewysiwyg, string $id, string $text, string $name, [string $classname = ''], [string $htmlid = ''], [string $encoding = ''], [string $stylesheet = ''], [string $cols = '80'], [string $rows = '15'], [string $forcewysiwyg = ''], [string $wantedsyntax = ''], [string $addtext = ''])

string CreateTooltip (string $helptext, [string $linktext = "?"], [string $forcewidth = ""], [string $classname = "admin-tooltip admin-tooltip-box"], [string $href = ""])

string CreateTooltipLink (string $id, string $action, string $returnid, string $contents, string $tooltiptext, [string $params = array()])

string CreateXMLPackage (string &$message, integer &$filecount)

string. create_url (string $id, string $action, [integer $returnid = ''], [hash $params = array()], [boolean $inline = false], [boolean $targetcontentonly = false], [string $prettyurl = ''])

void DefaultLanguage ()

boolean DeleteTemplate ([string $tpl_name = ''], [string $modulename = ''])

string DoAction (string $name, string $id, string $params, [integer $returnid = ''])

boolean DoEvent (string $originator, string $eventname, array &$params)

string EndTab ()

string EndTabContent ()

string EndTabHeaders ()

string GetAbout ()

string GetAdminDescription ()

string GetAdminSection ()

string GetAuthor ()

string GetAuthorEmail ()

string GetChangeLog ()

array GetConfig ()

mixed GetContentBlockInput (string $blockName, mixed $value, array $params, [boolean $adding = false])

mixed GetContentBlockValue (string $blockName, array $blockParams, array $inputParams)

object GetContentTypeInstance ()

string GetDashboardOutput ()

string GetDatabaseResource (string $template)

object Adodb &GetDb ()

array GetDependencies ()

string GetDescription ([string $lang = 'en_US'])

string GetEventDescription (string $eventname)

string GetEventHelp (string $eventname)

string GetFileResource (string $template)

string GetFriendlyName ()

string GetHeaderHTML ()

string GetHelp (string 0)

string GetHelpPage ()

string GetModulePath ()

array GetModulesWithCapability (an $capability, [associative $params = array()])

string GetModuleURLPath ([boolean $use_ssl = false])

string GetName ()

object A GetNotificationOutput ([int $priority = 2])

array GetParameters ()

string GetPreference (string $preference_name, [string $defaultvalue = ''])

string GetTemplate (string $tpl_name, [string $modulename = ''])

string GetTemplateFromFile (string $template_name)

array GetVariables ()

string GetVersion ()

string get_pretty_url (string $id, string $action, [integer $returnid = ''], [hash $params = array()], [boolean $inline = false])

array get_tasks ()

boolean HandlesEvents ()

boolean HasAdmin ()

boolean HasCapability (an $capability, [associative $params = array()])

boolean HasContentType ()

void InitializeAdmin ()

void InitializeFrontend ()

mixed Install ()

XHTML InstallPostMessage ()

boolean IsAdminOnly ()

boolean IsContentModule ()

void IsDatabaseTemplateCached (string $tpl_name, [string $designation = ''], [string $timestamp = ''])

void IsFileTemplateCached (string $tpl_name, [string $designation = ''], [string $timestamp = ''], [string $cacheid = ''])

boolean IsPluginModule ()

boolean IsSoapModule ()

boolean IsSyntaxHighlighter ()

boolean IsWYSIWYG ()

string Lang ()

boolean LazyLoadAdmin ()

boolean LazyLoadFrontend ()

array ListTemplates ([string $modulename = ''])

array ListUserTags ()

string MaximumCMSVersion ()

string MinimumCMSVersion ()

string ProcessTemplate (string $tpl_name, [string $designation = ''], [boolean $cache = false], [string $cacheid = ''])

string ProcessTemplateFromData (data $data)

string ProcessTemplateFromDatabase (string $tpl_name, [string $designation = ''], [boolean $cache = false], [string $modulename = ''])

void Redirect (string $id, string $action, [string $returnid = ''], [string $params = array()], [boolean $inline = false])

void RedirectContent (string $id)

void RedirectForFrontEnd (string $id, string $returnid, string $action, [string $params = array()], [boolean $inline = true])

void RedirectToAdmin (string $page, [array $params = array()])

void RedirectToAdminTab ([string $tab = ''], [mixed $params = ''], [string $action = ''])

void RegisterBulkContentFunction (string $label, string $action)

void RegisterContentType (string $name, string $file, [string $friendlyname = ''])

void RegisterModulePlugin ([boolean $forcedb = FALSE], [mixed $cachable = null])

void RegisterRoute (string $routeregex, [array $defaults = array()])

void RegisterSmartyPlugin (string $name, string $type, mixed $callback, [boolean $cachable = TRUE], [integer $usage = 0])

void RemoveEvent (string $eventname)

void RemoveEventHandler (string $modulename, string $eventname)

void RemovePermission (string $permission_name)

boolean RemovePreference ([string $preference_name = ''])

void RemoveSmartyPlugin ([string $name = ''])

void RestrictUnknownParams ([boolean $flag = true])

void SendEvent (string $eventname, array $params)

string SetContentType (string $contenttype)

void SetCurrentTab (string $tab)

void SetError (mixed $str)

void SetMessage (mixed $str)

void SetParameters ()

void; SetParameterType (string $param, define $type)

void SetPreference (string $preference_name, string $value)

string SetTabHeader (string $tabid, string $title, [boolean $active = false])

boolean SetTemplate (string $tpl_name, string $content, [string $modulename = ''])

string ShowErrors (errors $errors)

boolean ShowInSyntaxList ()

boolean ShowInWYSIWYG ()

string ShowMessage (message $message)

string StartTab (string $tabid, [arrray $params = array()])

string StartTabContent ()

string StartTabHeaders ()

boolean SupportsLazyLoading ()

boolean SuppressAdminOutput (array &$request)

boolean SyntaxActive ()

string SyntaxGenerateBody ()

string SyntaxGenerateHeader ([string $htmlresult = ''])

string SyntaxPageForm ()

string SyntaxPageFormSubmit ()

string SyntaxTextarea ([string $name = 'textarea'], [string $syntax = 'html'], [int $columns = '80'], [int $rows = '15'], [string $encoding = ''], [string $content = ''], [string $stylesheet = ''], [string $addtext = ''])

mixed Uninstall ()

XHTML UninstallPostMessage ()

XHTML UninstallPreMessage ()

boolean Upgrade (string $oldversion, string $newversion)

string ValidateContentBlockValue (string $blockName, mixed $value, arrray $blockparams)

boolean VisibleToAdminUser ()

boolean WYSIWYGActive ()

string WYSIWYGGenerateBody ()

string WYSIWYGGenerateHeader ([string $htmlresult = ''])

string WYSIWYGPageForm ()

string WYSIWYGPageFormSubmit ()

string WYSIWYGTextarea ([string $name = 'textarea'], [int $columns = '80'], [int $rows = '15'], [string $encoding = ''], [string $content = ''], [string $stylesheet = ''], [string $addtext = ''])

void &__get (string $key)

Methods

static method GetModuleInstance (line 2694)

Get a reference to another module object

return: module object, or FALSE
final:
access: public

static object The &GetModuleInstance (string $module)

string $module: The required module name.

Constructor CMSModule (line 182)

Constructor

access: public

CMSModule CMSModule ()

AddEventHandler (line 3374)

Add an event handler for an existing eg event.

return: If successful, true. If it fails, false.
final:
access: public

mixed AddEventHandler (string $modulename, string $eventname, [boolean $removable = true])

string $eventname: The name of the event
boolean $removable: Can this event be removed from the list?
string $modulename: modulename The name of the module sending the event, or 'Core'

AdminStyle (line 3133)

Called in the admin theme for every installed module, this method allows the module to output style information for use in the admin theme.

return: css text.
abstract:

string AdminStyle ()

AllowAutoInstall (line 1197)

Returns whether or not modules should be autoupgraded while upgrading

CMS versions. Generally only useful for modules included with the CMS base install, but there could be a situation down the road where we have different distributions with different modules included in them. Defaults to TRUE, as there is not many reasons to not allow it.

abstract:

boolean AllowAutoInstall ()

AllowAutoUpgrade (line 1212)

Returns whether or not modules should be autoupgraded while upgrading

abstract:

boolean AllowAutoUpgrade ()

AllowSmartyCaching (line 430)

Callback to determine if the output from a call to the module can be cached by smarty.

author: Robert Campbell
since: 1.11
access: public

boolean AllowSmartyCaching ()

AllowUninstallCleanup (line 1124)

Function that gets called upon module uninstall, and returns a boolean to indicate whether or not the core should remove all module events, event handlers, module templates, and preferences.

The module must still remove its own database tables and permissions

return: whether the core may remove all module events, event handles, module templates, and preferences on uninstall (defaults to true)
abstract:

boolean AllowUninstallCleanup ()

Audit (line 3161)

Put an event into the audit (admin) log. This should be done on most admin events for consistency.

final:
access: public

void Audit (string $itemid, string $itemname, string $action)

string $itemid: item id, useful for working on a specific record (i.e article or user)
string $itemname: item name
string $action: action name

CallUserTag (line 2988)

Call a specific user defined tag

final:
access: public

array CallUserTag (string $name, [array $params = array()])

string $name: Name of the user defined tag
array $params: Parameters for the user defined tag.

can_cache_output (line 416)

Callback to determine if the output from a call to the module can be cached by smarty.

author: Robert Campbell
since: 1.11
access: public

boolean can_cache_output ()

CheckForDependents (line 1240)

Checks to see if currently installed modules depend on this module. This is used by the plugins.php page to make sure that a module can't be uninstalled before any modules depending on it are uninstalled first.

final:
access: public

boolean CheckForDependents ()

CheckPermission (line 3290)

Checks a permission against the currently logged in user.

final:
access: public

boolean CheckPermission (string $permission_name)

string $permission_name: The name of the permission to check against the current user

CreateContentLink (line 2562)

Returns the xhtml equivalent of an href link for content links. This is basically a nice little wrapper to make sure that we go back to where we want and that it's xhtml complient

string CreateContentLink (string $pageid, [string $contents = ''])

string $pageid: the page id of the page we want to direct to
string $contents: The optional text or XHTML contents of the generated link

CreateEvent (line 3387)

Inform the system about a new event that can be generated

final:
access: public

nothing CreateEvent (string $eventname)

string $eventname: The name of the event

CreateFieldsetEnd (line 1886)

Returns the end of the fieldset in a form. This is basically just a wrapper around </form>, but could be extended later on down the road. It's here mainly for consistency.

final:

string CreateFieldsetEnd ()

CreateFieldsetStart (line 1873)

Returns the xhtml equivalent of an fieldset and legend. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

final:

string CreateFieldsetStart (string $id, string $name, [string $legend_text = ''], [string $addtext = ''], [string $addtext_legend = ''])

string $id: The id given to the module on execution (not really used yet, but might be later)
string $name: The html name of the textbox (not really used yet, but might be later on)
string $legend_text: The legend_text for this fieldset, if applicaple
string $addtext: Any additional text that should be added into the tag when rendered
string $addtext_legend: Any additional text that should be added into the legend tag when rendered

CreateFileUploadInput (line 2337)

Returns the xhtml equivalent of a file upload input. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateFileUploadInput (string $id, string $name, [string $addttext = ''], [integer $size = '10'], [integer $maxlength = '255'])

string $id: The id given to the module on execution
string $name: The html name of the input
string $addttext: Any additional text that should be added into the tag when rendered
integer $size: The size of the text field associated with the file upload field. Some browsers may not respect this value.
integer $maxlength: The maximim length of the content of the text field associated with the file upload field. Some browsers may not respect this value.

CreateFormEnd (line 1938)

Returns the end of the a module form. This is basically just a wrapper around </form>, but could be extended later on down the road. It's here mainly for consistency.

string CreateFormEnd ()

CreateFormStart (line 1926)

Returns the start of a module form

string $id: The id given to the module on execution
string $action: The action that this form should do when the form is submitted
string $returnid: The id to eventually return to when the module is finished it's task
string $method: Method to use for the form tag. Defaults to 'post'
string $enctype: Optional enctype to use, Good for situations where files are being uploaded
boolean $inline: A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)
string $idsuffix: Text to append to the end of the id and name of the form
array $params: Extra parameters to pass along when the form is submitted
string $extra: Text to append to the <form>-statement, for instanse for javascript-validation code

CreateFrontendFormStart (line 1905)

Returns the start of a module form, optimized for frontend use

string $id: The id given to the module on execution
string $returnid: The id to eventually return to when the module is finished it's task
string $action: The action that this form should do when the form is submitted
string $method: Method to use for the form tag. Defaults to 'post'
string $enctype: Optional enctype to use, Good for situations where files are being uploaded
boolean $inline: A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)
string $idsuffix: Text to append to the end of the id and name of the form
array $params: Extra parameters to pass along when the form is submitted

CreateFrontendLink (line 2482)

Returns the xhtml equivalent of an href link This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string $id: The id given to the module on execution
string $returnid: The id to eventually return to when the module is finished it's task
string $action: The action that this form should do when the link is clicked
string $contents: The text that will have to be clicked to follow the link
string $params: An array of params that should be inlucded in the URL of the link. These should be in a $key=>$value format.
string $warn_message: Text to display in a javascript warning box. If they click no, the link is not followed by the browser.
boolean $onlyhref: A flag to determine if only the href section should be returned
boolean $inline: A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)
string $addtext: Any additional text that should be added into the tag when rendered
boolean $targetcontentonly: A flag indicating that the output of this link should target the content area of the destination page.
string $prettyurl: An optional pretty url segment (relative to the root of the site) to use when generating the link.

CreateInputCheckbox (line 2285)

Returns the xhtml equivalent of a checkbox. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputCheckbox (string $id, string $name, [string $value = ''], [string $selectedvalue = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the checkbox
string $value: The value returned from the input if selected
string $selectedvalue: The current value. If equal to $value the checkbox is selected
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputColor (line 2008)

Returns the html5 equivalent of an input of type color. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputColor (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputDataList (line 2375)

Returns the html5 equivalent input field with datalist options. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputDataList (string $id, string $name, [string $value = ''], string $items, [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $items: An array of items to put into the list... they should be $key=>$value pairs
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputDate (line 2025)

Returns the html5 equivalent of an input of type date. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputDate (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputDatetime (line 2042)

Returns the html5 equivalent of an input of type datetime. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputDatetime (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputDatetimeLocal (line 2059)

Returns the html5 equivalent of an input of type datetime-local. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputDatetimeLocal (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputDropdown (line 2356)

Returns the xhtml equivalent of a dropdown list. This is basically a nice little wrapper to make sure that id's are placed in names and also that it is xhtml compliant.

string CreateInputDropdown (string $id, string $name, string $items, [string $selectedindex = -1], [string $selectedvalue = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the dropdown list
string $items: An array of items to put into the dropdown list... they should be $key=>$value pairs
string $selectedindex: The default selected index of the dropdown list. Setting to -1 will result in the first choice being selected
string $selectedvalue: The default selected value of the dropdown list. Setting to '' will result in the first choice being selected
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputEmail (line 2162)

Returns the html5 equivalent of an input textbox of type email. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputEmail (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputFile (line 2234)

Returns the xhtml equivalent of a file-selector field. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputFile (string $id, string $name, [string $accept = ''], [string $size = '10'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $accept: The MIME-type to be accepted, default is all
string $size: The number of columns wide the textbox should be displayed
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputHidden (line 2268)

Returns the xhtml equivalent of a hidden field. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputHidden (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the hidden field
string $value: The predefined value of the field, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputMonth (line 2076)

Returns the html5 equivalent of an input of type month. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputMonth (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputNumber (line 2127)

Returns the html5 equivalent of an input of type number. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputNumber (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputPassword (line 2252)

Returns the xhtml equivalent of an input password-box. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputPassword (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputRadioGroup (line 2412)

Returns the xhtml equivalent of a set of radio buttons. This is basically a nice little wrapper to make sure that id's are placed in names and also that it is xhtml compliant.

string CreateInputRadioGroup (string $id, string $name, string $items, [string $selectedvalue = ''], [string $addttext = ''], [string $delimiter = ''])

string $id: The id given to the module on execution
string $name: The html name of the radio group
string $items: An array of items to create as radio buttons... they should be $key=>$value pairs
string $selectedvalue: The default selected index of the radio group. Setting to -1 will result in the first choice being selected
string $addttext: Any additional text that should be added into the tag when rendered
string $delimiter: A delimiter to throw between each radio button, e.g., a
tag or something for formatting

CreateInputRange (line 2144)

Returns the html5 equivalent of an input of type range. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputRange (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputReset (line 2320)

Returns the xhtml equivalent of a reset button. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputReset (string $id, string $name, [string $value = 'Reset'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the button
string $value: The predefined value of the button, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputSearch (line 2198)

Returns the html5 equivalent of an input of type search. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputSearch (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputSelectList (line 2394)

Returns the xhtml equivalent of a multi-select list. This is basically a nice little wrapper to make sure that id's are placed in names and also that it is xhtml compliant.

string CreateInputSelectList (string $id, string $name, string $items, [string $selecteditems = array()], [string $size = 3], [string $addttext = ''], [boolean $multiple = true])

string $id: The id given to the module on execution
string $name: The html name of the select list
string $items: An array of items to put into the list... they should be $key=>$value pairs
string $selecteditems: An array of items in the list that should default to selected.
string $size: The number of rows to be visible in the list (before scrolling).
string $addttext: Any additional text that should be added into the tag when rendered
boolean $multiple: indicates wether multiple selections are allowed (defaults to true)

CreateInputSubmit (line 2304)

Returns the xhtml equivalent of a submit button. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputSubmit (string $id, string $name, [string $value = ''], [string $addttext = ''], [string $image = ''], [string $confirmtext = ''])

string $id: The id given to the module on execution
string $name: The html name of the button
string $value: The predefined value of the button, if any
string $addttext: Any additional text that should be added into the tag when rendered
string $image: Use an image instead of a regular button
string $confirmtext: Optional text to display in a confirmation message.

CreateInputTel (line 2180)

Returns the html5 equivalent of an input textbox of type tel. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputTel (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputText (line 1955)

Returns the xhtml equivalent of an input textbox. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputText (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputTextWithLabel (line 1991)

Returns the xhtml equivalent of an input textbox with label. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered
string $label: The text for label
string $labeladdtext: Any additional text that should be added into the tag when rendered

CreateInputTime (line 2110)

Returns the html5 equivalent of an input of type time. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputTime (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputUrl (line 2216)

Returns the html5 equivalent of an input of type url. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateInputUrl (string $id, string $name, [string $value = ''], [string $size = '10'], [string $maxlength = '255'], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the textbox
string $value: The predefined value of the textbox, if any
string $size: The number of columns wide the textbox should be displayed
string $maxlength: The maximum number of characters that should be allowed to be entered
string $addttext: Any additional text that should be added into the tag when rendered

CreateInputWeek (line 2093)

Returns the html5 equivalent of an input of type week. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's html5 compliant.

string CreateInputWeek (string $id, string $name, [string $value = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field
string $value: The predefined value of the textbox, if any
string $addttext: Any additional text that should be added into the tag when rendered

CreateLabelForInput (line 1971)

Returns the xhtml equivalent of an label for input field. This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string CreateLabelForInput (string $id, string $name, [string $labeltext = ''], [string $addttext = ''])

string $id: The id given to the module on execution
string $name: The html name of the input field this label is associated to
string $labeltext: The text in the label
string $addttext: Any additional text that should be added into the tag when rendered

CreateLink (line 2506)

Returns the xhtml equivalent of an href link This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

string $id: The id given to the module on execution
string $action: The action that this form should do when the link is clicked
string $returnid: The id to eventually return to when the module is finished it's task
string $contents: The text that will have to be clicked to follow the link
string $params: An array of params that should be inlucded in the URL of the link. These should be in a $key=>$value format.
string $warn_message: Text to display in a javascript warning box. If they click no, the link is not followed by the browser.
boolean $onlyhref: A flag to determine if only the href section should be returned
boolean $inline: A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)
string $addttext: Any additional text that should be added into the tag when rendered
boolean $targetcontentonly: A flag to determine if the link should target the default content are of the destination page.
string $prettyurl: An optional pretty url segment (related to the root of the website) for a pretty url.

CreatePagination (line 3179)

Creates a string containing links to all the pages.

deprecated:

string CreatePagination (string $id, string $action, string $returnid, string $page, string $totalrows, string $limit, [boolean $inline = false])

string $id: The id given to the module on execution
string $action: The action that this form should do when the form is submitted
string $returnid: The id to eventually return to when the module is finished it's task
string $page: the current page to display
string $totalrows: the amount of items being listed
string $limit: the amount of items to list per page
boolean $inline: A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)

CreateParameter (line 763)

Create a parameter and it's documentation for display in the module help.

i.e: $this->CreateParameter('numarticles',100000,$this->Lang('help_numarticles'),true);

void; CreateParameter (string $param, [string $defaultval = ''], [string $helpstring = ''], [boolean $optional = true])

string $param: Parameter name;
string $defaultval: Default parameter value
string $helpstring: Help String
boolean $optional: Flag indicating wether this parameter is optional or required.

CreatePermission (line 3266)

Create's a new permission for use by the module.

final:
access: public

void CreatePermission (string $permission_name, string $permission_text)

string $permission_name: Name of the permission to create
string $permission_text: Description of the permission

CreateReturnLink (line 2580)

Returns the xhtml equivalent of an href link for Content links. This is basically a nice little wrapper to make sure that we go back to where we want to and that it's xhtml compliant.

string CreateReturnLink (string $id, string $returnid, [string $contents = ''], [string $params = array()], [boolean $onlyhref = false])

string $id: The id given to the module on execution
string $returnid: The id to return to when the module is finished it's task
string $contents: The text that will have to be clicked to follow the link
string $params: An array of params that should be inlucded in the URL of the link. These should be in a $key=>$value format.
boolean $onlyhref: A flag to determine if only the href section should be returned

CreateStaticRoutes (line 620)

author: Robert Campbell
since: 1.11
access: public

void CreateStaticRoutes ()

CreateSyntaxArea (line 2458)

Returns the xhtml equivalent of a textarea. Also takes Syntax hilighter preference into consideration if it's called from the admin side.

string $id: The id given to the module on execution
string $text: The text to display in the textarea's content
string $name: The html name of the textarea
string $classname: The CSS class to associate this textarea to
string $htmlid: The html id to give to this textarea
string $encoding: The encoding to use for the content
string $stylesheet: The text of the stylesheet associated to this content. Only used for certain WYSIWYGs
string $cols: The number of characters wide (columns) the resulting textarea should be
string $rows: The number of characters high (rows) the resulting textarea should be
string $addtext: Additional text for the text area tag.

CreateTextArea (line 2436)

Returns the xhtml equivalent of a textarea. Also takes WYSIWYG preference into consideration if it's called from the admin side.

bool $enablewysiwyg: Should we try to create a WYSIWYG for this textarea?
string $id: The id given to the module on execution
string $text: The text to display in the textarea's content
string $name: The html name of the textarea
string $classname: The CSS class to associate this textarea to
string $htmlid: The html id to give to this textarea
string $encoding: The encoding to use for the content
string $stylesheet: The text of the stylesheet associated to this content. Only used for certain WYSIWYGs
string $cols: The number of characters wide (columns) the resulting textarea should be
string $rows: The number of characters high (rows) the resulting textarea should be
string $forcewysiwyg: The wysiwyg-system to be forced even if the user has chosen another one
string $wantedsyntax: The language the content should be syntaxhightlighted as
string $addtext: Any additional text to include with the textarea field.

CreateTooltip (line 1832)

Returns the xhtml equivalent of a tooltip help link.

deprecated:
final:

string CreateTooltip (string $helptext, [string $linktext = "?"], [string $forcewidth = ""], [string $classname = "admin-tooltip admin-tooltip-box"], [string $href = ""])

string $helptext: The help text to be shown on mouse over
string $linktext: The text to be shown as the link, default to a simple question mark
string $forcewidth: Forces another width of the popupbox than the one set in admin css
string $classname: An alternative classname for the a-link of the tooltip
string $href: The URL or url portion to use in the href portion of the generated link.

CreateTooltipLink (line 1856)

Returns the xhtml equivalent of a tooltip-enabled href link This is basically a nice little wrapper to make sure that id's are placed in names and also that it's xhtml compliant.

deprecated:
final:

string CreateTooltipLink (string $id, string $action, string $returnid, string $contents, string $tooltiptext, [string $params = array()])

string $id: The id given to the module on execution
string $action: The action that this form should do when the link is clicked
string $returnid: The id to eventually return to when the module is finished it's task
string $contents: The text that will have to be clicked to follow the link
string $tooltiptext: The helptext to be shown as tooltip-popup
string $params: An array of params that should be inlucded in the URL of the link. These should be in a $key=>$value format.

CreateXMLPackage (line 1266)

Creates an xml data package from the module directory.

return: XML Text
final:
access: public

string CreateXMLPackage (string &$message, integer &$filecount)

string &$message: reference to returned message.
integer &$filecount: reference to returned file count.

create_url (line 2527)

Returns a URL to a module action This method is called by the CreateLink methods when creating a link to a module action.

since: 1.10
access: public

string. create_url (string $id, string $action, [integer $returnid = ''], [hash $params = array()], [boolean $inline = false], [boolean $targetcontentonly = false], [string $prettyurl = ''])

string $id: The module action id (cntnt01 indicates that the defaul content block of the destination page should be used).
string $action: The module action name
integer $returnid: The destination page.
hash $params: Areay of parameters for the URL. These will be ignored if the prettyurl argument is specified.
boolean $inline: Wether the target of the output link is the same tag on the same page.
boolean $targetcontentonly: Wether the target of the output link targets the content area of the destination page.
string $prettyurl: An optional url segment related to the root of the page for pretty url purposes.

DefaultLanguage (line 2744)

Sets the default language (usually en_US) for the module. There should be at least a language file for this language if the Lang() function is used at all.

deprecated: Modules should use en_US as their default language.
abstract:

void DefaultLanguage ()

DeleteTemplate (line 2868)

Delete a module template from the database

final:
access: public

boolean DeleteTemplate ([string $tpl_name = ''], [string $modulename = ''])

string $tpl_name: the Template name, if empty all templates associated with the module are deleted.
string $modulename: The module name, if empty the current module name is used.

DoAction (line 1698)

Used for navigation between "pages" of a module. Forms and links should pass an action with them so that the module will know what to do next.

By default, DoAction will be passed 'default' and 'defaultadmin', depending on where the module was called from. If being used as a module or content type, 'default' will be passed. If the module was selected from the list on the admin menu, then 'defaultadmin' will be passed.

In order to allow splitting up functionality into multiple PHP files the default behaviour of this method is to look for a file named action.<action name>.php in the modules directory, and if it exists include it.

return: output XHTML.
abstract:

string DoAction (string $name, string $id, string $params, [integer $returnid = ''])

string $name: Name of the action to perform
string $id: The ID of the module
string $params: The parameters targeted for this module
integer $returnid: The current page id that is being displayed.

DoEvent (line 3407)

An event that this module is listening to has occurred, and should be handled.

This method must be over-ridden if this module is capable of handling events. of any type.

The default behavior of this method is to check for a function called event.<originator>.<eventname>.php in the module directory, and if this file exists it, include it to handle the event.

abstract:

boolean DoEvent (string $originator, string $eventname, array &$params)

string $originator: The name of the originating module
string $eventname: The name of the event
array &$params: Array of parameters provided with the event.

EndTab (line 3114)

Output a string to indicate the end of the output for a specific tab.

final:

string EndTab ()

EndTabContent (line 3085)

Output a string to indicate the end of XHTML areas for tabs.

final:

string EndTabContent ()

EndTabHeaders (line 3063)

Output a string to stop the output of headers and close the necessary XHTML div.

final:

string EndTabHeaders ()

GetAbout (line 447)

Returns a sufficient about page for a module

return: The about page HTML text.
abstract:

string GetAbout ()

GetAdminDescription (line 793)

Returns a description of what the admin link does.

abstract:

string GetAdminDescription ()

GetAdminSection (line 1296)

Returns which admin section this module belongs to.

this is used to place the module in the appropriate admin navigation section. Valid options are currently:

content, layout, files, usersgroups, extensions, preferences, admin

abstract:

string GetAdminSection ()

GetAuthor (line 825)

Returns the name of the author

return: The name of the author.
abstract:

string GetAuthor ()

GetAuthorEmail (line 836)

Returns the email address of the author

return: The email address of the author.
abstract:

string GetAuthorEmail ()

GetChangeLog (line 814)

Returns the changelog for the module

return: HTML text of the changelog.

string GetChangeLog ()

GetConfig (line 854)

Returns the cms->config object as a reference

return: The config hash.
deprecated:
final:
access: public

array GetConfig ()

GetContentBlockInput (line 902)

Get an input field for a module generated content block type.

This method can be overridden if the module is providing content block types to the CMSMS content objects.

return: Either an array with two elements (prompt, and xhtml element) or a string containing only the xhtml input element.
abstract:

mixed GetContentBlockInput (string $blockName, mixed $value, array $params, [boolean $adding = false])

string $blockName: Content block name
mixed $value: Content block value
array $params: Content block parameters
boolean $adding: A flag indicating wether the content editor is in create mode (adding) vs. edit mod.

GetContentBlockValue (line 921)

Return a value for a module generated content block type.

Given input parameters (i.e: via _POST or _REQUEST), this method will extract a value for the given content block information.

This method can be overridden if the module is providing content block types to the CMSMS content objects.

return: The content block value if possible.
abstract:

mixed GetContentBlockValue (string $blockName, array $blockParams, array $inputParams)

string $blockName: Content block name
array $blockParams: Content block parameters
array $inputParams: input parameters

GetContentTypeInstance (line 1015)

Return an instance of the new content type

This method must be overridden if this object is providing a content type.

deprecated:
abstract:

object GetContentTypeInstance ()

GetDashboardOutput (line 3525)

Returns the output the module wants displayed in the dashboard

return: dashboard-content
abstract:

string GetDashboardOutput ()

GetDatabaseResource (line 2783)

A function to return a resource identifier to a module specific database template

author: calguy1000
since: 1.11
access: public

string GetDatabaseResource (string $template)

string $template: The template name.

GetDb (line 866)

Returns the cms->db object as a reference

return: Database object.
deprecated:
final:
access: public

object Adodb &GetDb ()

GetDependencies (line 1225)

Returns a list of dependencies and minimum versions that this module requires. It should return an hash, eg.

return array('somemodule'=>'1.0', 'othermodule'=>'1.1');

abstract:

array GetDependencies ()

GetDescription (line 782)

Returns a short description of the module

abstract:

string GetDescription ([string $lang = 'en_US'])

string $lang: Optional language that the admin is using. If that language is not defined, use en_US.

GetEventDescription (line 3438)

Get a (langified) description for an event this module created.

This method must be over-ridden if this module created any events.

abstract:

string GetEventDescription (string $eventname)

string $eventname: The name of the event

GetEventHelp (line 3453)

Get a (langified) descriptionof the details about when an event is created, and the parameters that are attached with it.

This method must be over-ridden if this module created any events.

abstract:

string GetEventHelp (string $eventname)

string $eventname: The name of the event

GetFileResource (line 2797)

A function to return a resource identifier to a module specific file template

author: calguy1000
since: 1.11
access: public

string GetFileResource (string $template)

string $template: The template name.

GetFriendlyName (line 515)

Returns a translatable name of the module. For modulues who's names can probably be translated into another language (like News)

abstract:

string GetFriendlyName ()

GetHeaderHTML (line 577)

Returns XHTML that needs to go between the <head> tags when this module is called from an admin side action.

This method is called by the admin theme when executing an action for a specific module.

return: XHTML text

string GetHeaderHTML ()

GetHelp (line 565)

Returns the help for the module

return: Help HTML Text.
abstract:

string GetHelp (string 0)

string 0: Optional language that the admin is using. If that language is not defined, use en_US.

GetHelpPage (line 460)

Returns a sufficient help page for a module this function should not be overridden

return: The help page HTML text.
final:
access: public

string GetHelpPage ()

GetModulePath (line 483)

Returns the full path to the module directory.

return: The full path to the module directory.
final:
access: public

string GetModulePath ()

GetModulesWithCapability (line 2708)

Returns an array of modulenames with the specified capability and which are installed and enabled, of course

final:
access: public

array GetModulesWithCapability (an $capability, [associative $params = array()])

an $capability: id specifying which capability to check for, could be "wysiwyg" etc.
associative $params: array further params to get more detailed info about the capabilities. Should be syncronized with other modules of same type

GetModuleURLPath (line 502)

Returns the URL path to the module directory.

return: The full path to the module directory.
final:
access: public

string GetModuleURLPath ([boolean $use_ssl = false])

boolean $use_ssl: Optional generate an URL using HTTPS path

GetName (line 472)

Returns the name of the module

return: The name of the module.
abstract:

string GetName ()

GetNotificationOutput (line 3539)

Returns the output the module wants displayed in the notification area

return: stdClass object with two properties.... priority (1->3)... and html, which indicates the text to display for the Notification.
abstract:

object A GetNotificationOutput ([int $priority = 2])

int $priority: Notification priority between 1 and 3

GetParameters (line 632)

Returns a list of parameters and their help strings in a hash. This is generally used internally.

final:
access: public

array GetParameters ()

GetPreference (line 3323)

Returns a module preference if it exists.

final:
access: public

string GetPreference (string $preference_name, [string $defaultvalue = ''])

string $preference_name: The name of the preference to check
string $defaultvalue: The default value, just in case it doesn't exist

GetTemplate (line 2824)

Returns a database saved template. This should be used for admin functions only, as it doesn't follow any smarty caching rules.

final:
access: public

string GetTemplate (string $tpl_name, [string $modulename = ''])

string $tpl_name: template name
string $modulename: module name. If empty the current module name is used.

GetTemplateFromFile (line 2838)

Returns contents of the template that resides in modules/ModuleName/templates/{template_name}.tpl Code adapted from the Guestbook module

final:
access: public

string GetTemplateFromFile (string $template_name)

string $template_name: template name

GetVariables (line 878)

Returns CMSMS temporary and state variables.

return: a hash of CMSMS temporary variables.
deprecated: Subject for removal in CMSMS 1.12
final:
access: public

array GetVariables ()

GetVersion (line 526)

Returns the version of the module

abstract:

string GetVersion ()

get_pretty_url (line 2549)

Return a pretty url string for a module action This method is called by the create_url and the CreateLink methods if the pretty url argument is not specified in order to attempt automating a pretty url for an action.

abstract:
since: 1.10
access: public

string get_pretty_url (string $id, string $action, [integer $returnid = ''], [hash $params = array()], [boolean $inline = false])

string $id: The module action id (cntnt01 indicates that the defaul content block of the destination page should be used).
string $action: The module action name
integer $returnid: The destination page.
hash $params: Areay of parameters for the URL. These will be ignored if the prettyurl argument is specified.
boolean $inline: Wether the target of the output link is the same tag on the same page.

get_tasks (line 1437)

Returns a list of the tasks that this module manages

return: of CmsRegularTask objects, or one object. NULL if not handled.
abstract:
since: 1.8

array get_tasks ()

HandlesEvents (line 3466)

A callback indicating if this module has a DoEvent method to handle incoming events.

abstract:

boolean HandlesEvents ()

HasAdmin (line 1281)

Return true if there is an admin for the module. Returns false by default.

abstract:

boolean HasAdmin ()

HasCapability (line 1424)

Returns true if the modules thinks it has the capability specified

abstract:

boolean HasCapability (an $capability, [associative $params = array()])

an $capability: id specifying which capability to check for, could be "wysiwyg" etc.
associative $params: array further params to get more detailed info about the capabilities. Should be syncronized with other modules of same type

HasContentType (line 977)

Does this module support a custom content type?

This method can be overridden if the module is defining one or more custom content types (note this is different than content block types)

abstract:

boolean HasContentType ()

InitializeAdmin (line 691)

Called from within the constructor, ONLY for admin module actions. This method should be overridden to create routes, and set handled parameters, and perform other initialization tasks that need to be setup for all frontend actions.

see: CMSModule::CreateParameter()
abstract:
access: protected

void InitializeAdmin ()

InitializeFrontend (line 675)

Called from within the constructor, ONLY for frontend module actions. This method should be overridden to create routes, and set handled parameters, and perform other initialization tasks that need to be setup for all frontend actions.

void InitializeFrontend ()

Install (line 1045)

Function that will get called as module is installed. This function should do any initialization functions including creating database tables. It should return a string message if there is a failure. Returning nothing (FALSE) will allow the install procedure to proceed.

The default behavior of this method is to include a file named method.install.php in the module directory, if one can be found. This provides a way of splitting secondary functions into other files.

return: FALSE indicates no error. Any other value will be used as an error message.
abstract:

mixed Install ()

InstallPostMessage (line 1074)

Display a message after a successful installation of the module.

return: Text
abstract:

XHTML InstallPostMessage ()

IsAdminOnly (line 804)

Returns whether this module should only be loaded from the admin

abstract:

boolean IsAdminOnly ()

IsContentModule (line 1325)

Returns true if the module should be treated as a content module.

Returns false by default.

abstract:

boolean IsContentModule ()

IsDatabaseTemplateCached (line 2920)

Test if a database template has been compiled and is cached by smarty.

deprecated:
final:
access: public

void IsDatabaseTemplateCached (string $tpl_name, [string $designation = ''], [string $timestamp = ''])

string $tpl_name: The template name
string $designation: The cache designation
string $timestamp: The cache timestamp

IsFileTemplateCached (line 2886)

Test if a file template has been compiled and is cached by smarty.

deprecated:
final:
access: public

void IsFileTemplateCached (string $tpl_name, [string $designation = ''], [string $timestamp = ''], [string $cacheid = ''])

string $tpl_name: The template name
string $designation: The cache designation
string $timestamp: The cache timestamp
string $cacheid: The cache id (for caching).

IsPluginModule (line 1337)

Returns true if the module should be treated as a plugin module (like {cms_module module='name'}. Returns false by default.

abstract:

boolean IsPluginModule ()

IsSoapModule (line 1349)

Returns true if the module acts as a soap server

abstract:

boolean IsSoapModule ()

IsSyntaxHighlighter (line 1458)

Returns true if this module should be treated as a Syntax Highlighting module. It returns false be default.

abstract:

boolean IsSyntaxHighlighter ()

IsWYSIWYG (line 1575)

Returns true if this module should be treated as a WYSIWYG module. It returns false be default.

abstract:

boolean IsWYSIWYG ()

Lang (line 2757)

Returns the corresponding translated string for the id given.

This method accepts variable arguments. The first argument (required) is the language string key (a string) Further arguments may be sprintf arguments matching the specified key.

final:
access: public

string Lang ()

LazyLoadAdmin (line 1398)

Returns true if the module may support lazy loading in the admin interface.

Note: The results of this function are not read on each request, only during install and upgrade therefore if the return value of this function changes the version number of the module should be increased to force a re-load

In CMSMS 1.10 routes are loaded upon each request, if a module registers routes it cannot be lazy loaded.

abstract:
since: 1.10
access: public

boolean LazyLoadAdmin ()

LazyLoadFrontend (line 1380)

Returns true if the module may support lazy loading in the front end

In CMSMS 1.10 routes are loaded upon each request, if a module registers routes it cannot be lazy loaded.

abstract:
since: 1.10
access: public

boolean LazyLoadFrontend ()

ListTemplates (line 2809)

List Templates associated with a module

final:
access: public

array ListTemplates ([string $modulename = ''])

string $modulename: module name. If empty the current module name is used.

ListUserTags (line 2973)

Return a list of user defined tags

final:
access: public

array ListUserTags ()

MaximumCMSVersion (line 550)

Returns the maximum version necessary to run this version of the module.

deprecated:
abstract:

string MaximumCMSVersion ()

MinimumCMSVersion (line 537)

Returns the minimum version necessary to run this version of the module.

abstract:

string MinimumCMSVersion ()

ProcessTemplate (line 2903)

Process A File template through smarty

deprecated:
final:
access: public

string ProcessTemplate (string $tpl_name, [string $designation = ''], [boolean $cache = false], [string $cacheid = ''])

string $tpl_name: Template name
string $designation: Cache Designation
boolean $cache: Cache flag
string $cacheid: Unique cache flag

ProcessTemplateFromData (line 2937)

Given a template in a variable, this method processes it through smarty note, there is no caching involved.

Note: this function is deprecated and scheduled for removal.

deprecated:
final:
access: public

string ProcessTemplateFromData (data $data)

data $data: Input template

ProcessTemplateFromDatabase (line 2953)

Process a smarty template associated with a module through smarty and return the results

final:
access: public

string ProcessTemplateFromDatabase (string $tpl_name, [string $designation = ''], [boolean $cache = false], [string $modulename = ''])

string $tpl_name: Template name
string $designation: (optional) Designation
boolean $cache: (optional) Cachable flag
string $modulename: (optional) module name, if empty the current module is used.

Redirect (line 2642)

Redirects the user to another action of the module.

void Redirect (string $id, string $action, [string $returnid = ''], [string $params = array()], [boolean $inline = false])

string $id: The id given to the module on execution
string $action: The action that this form should do when the form is submitted
string $returnid: The id to eventually return to when the module is finished it's task
string $params: An array of params that should be inlucded in the URL of the link. These should be in a $key=>$value format.
boolean $inline: A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)

RedirectContent (line 2676)

Redirects the user to a content page outside of the module. The passed around returnid is frequently used for this so that the user will return back to the page from which they first entered the module.

void RedirectContent (string $id)

string $id: Content id to redirect to.

RedirectForFrontEnd (line 2628)

Redirects the user to another action of the module.

This function is optimized for frontend use.

void RedirectForFrontEnd (string $id, string $returnid, string $action, [string $params = array()], [boolean $inline = true])

string $id: The id given to the module on execution
string $returnid: The action that this form should do when the form is submitted
string $action: The id to eventually return to when the module is finished it's task
string $params: An array of params that should be inlucded in the URL of the link. These should be in a $key=>$value format.
boolean $inline: A flag to determine if actions should be handled inline (no moduleinterface.php -- only works for frontend)

RedirectToAdmin (line 2662)

Redirects to an admin page

void RedirectToAdmin (string $page, [array $params = array()])

string $page: php script to redirect to
array $params: optional array of url parameters

RedirectToAdminTab (line 2603)

Redirect to the specified tab.

Applicable only to admin actions.

author: Robert Campbell
since: 1.11

void RedirectToAdminTab ([string $tab = ''], [mixed $params = ''], [string $action = ''])

string $tab: The tab name. If empty, the current tab is used.
mixed $params: An assoiciative array of params, or null
string $action: The action name (if not specified, defaultadmin is assumed)

RegisterBulkContentFunction (line 955)

For use in the CMSMS content list this method allows a module to register a bulk content action.

final:
access: public

void RegisterBulkContentFunction (string $label, string $action)

string $label: A label for the action
string $action: A module action name.

RegisterContentType (line 992)

deprecated:
final:
access: public

void RegisterContentType (string $name, string $file, [string $friendlyname = ''])

string $name: A name for the new content type
string $file: A filename containing the content type definition.
string $friendlyname: A friendly name for this content type.

RegisterModulePlugin (line 369)

Register a plugin to smarty with the name of the module. This method should be called from the module constructor, or from the SetParameters method.

Note:

see: CMSModule::SetParameters()
see: CMSModule::can_cache_output()
deprecated:
final:
access: public

void RegisterModulePlugin ([boolean $forcedb = FALSE], [mixed $cachable = null])

boolean $forcedb: Indicate wether this registration should be forced to be entered in the database. Default value is false (for compatibility)
mixed $cachable: Indicate wether this plugins output should be cachable. If null, use the site preferences, and the can_cache_output method. Otherwise a boolean is expected.

RegisterRoute (line 606)

Note: This method is not compatible wih lazy loading in the front end.

see: CMSModule::SetParameters()
final:
access: public

void RegisterRoute (string $routeregex, [array $defaults = array()])

string $routeregex: Regular Expression Route to register
array $defaults: Defaults for parameters that might not be included in the url

RegisterSmartyPlugin (line 321)

This method registers a static plugin to the plugins database table, and should be used only when a module is installed or upgraded.

author: calguy1000
see: smarty documentation.
since: 1.11
access: public

void RegisterSmartyPlugin (string $name, string $type, mixed $callback, [boolean $cachable = TRUE], [integer $usage = 0])

string $name: The plugin name
string $type: The plugin type (function,compiler,block, etc)
mixed $callback: The function callback (must be a static function)
boolean $cachable: Wether this function is cachable.
integer $usage: Indicates frontend (0), or frontend and backend (1) availability.

RemoveEvent (line 3482)

Remove an event from the CMS system This function removes all handlers to the event, and completely removes all references to this event from the database

Note, only events created by this module can be removed.

final:
access: public

void RemoveEvent (string $eventname)

string $eventname: The name of the event

RemoveEventHandler (line 3499)

Remove an event handler from the CMS system This function removes all handlers to the event, and completely removes all references to this event from the database

Note, only events created by this module can be removed.

final:
access: public

void RemoveEventHandler (string $modulename, string $eventname)

string $modulename: The module name (or Core)
string $eventname: The name of the event

RemovePermission (line 3304)

Removes a permission from the system. If recreated, the permission would have to be set to all groups again.

final:
access: public

void RemovePermission (string $permission_name)

string $permission_name: The name of the permission to remove

RemovePreference (line 3349)

Removes a module preference. If no preference name is specified, removes all module preferences.

final:
access: public

boolean RemovePreference ([string $preference_name = ''])

string $preference_name: The name of the preference to remove. If empty all preferences associated with the module are removed.

RemoveSmartyPlugin (line 342)

Unregister a smarty plugin from the system.

This method removes any matching rows from the database, and should only be used in a modules uninstall or upgrade routine.

author: calguy1000
since: 1.11
access: public

void RemoveSmartyPlugin ([string $name = ''])

string $name: The smarty plugin name. If no name is specified all smarty plugins registered to this module will be removed.

RestrictUnknownParams (line 707)

A method to indicate that the system should drop and optionally generate an error about unknown parameters on frontend actions.

void RestrictUnknownParams ([boolean $flag = true])

boolean $flag: Flag indicating wether unknown params should be restricted.

SendEvent (line 3514)

Trigger an event.

This function will call all registered event handlers for the event

final:
access: public

void SendEvent (string $eventname, array $params)

string $eventname: The name of the event
array $params: The parameters associated with this event.

SetContentType (line 3145)

Set the content-type header.

return: valid content type string.
abstract:

string SetContentType (string $contenttype)

string $contenttype: Value to set the content-type header too

SetCurrentTab (line 3012)

Set the current tab for the action.

Used for the various template forms, this method can be used to control the tab that is displayed by default when redirecting to an action that displays multiple tabs.

author: calguy1000
since: 1.11

void SetCurrentTab (string $tab)

string $tab: The tab name

SetError (line 3244)

Set an error message.

author: Robert Campbell
since: 1.11
access: public

void SetError (mixed $str)

mixed $str: The message. Accepts either an array of messages or a single string.

SetMessage (line 3211)

Set a display message.

author: Robert Campbell
since: 1.11
access: public

void SetMessage (mixed $str)

mixed $str: The message. Accepts either an array of messages or a single string.

SetParameters (line 658)

Called from within the constructor, This method should be overridden to call the CreaeteParameter method for each parameter that the module understands.

Note: In past versions of CMSMS This method was used for both admin and frontend requests to register routes, and create parameters, and register a module plugin, etc. As of version 1.10 this method is deprecated, and the appropriate functions are InitializeFrontend() and InitializeAdmin() This method is scheduled for removal in version 1.11

void SetParameters ()

SetParameterType (line 730)

Indicate the name of, and type of a parameter that is acceptable for frontend actions.

possible values for type are: CLEAN_INT,CLEAN_FLOAT,CLEAN_NONE,CLEAN_STRING

i.e: $this->SetParameterType('numarticles',CLEAN_INT);

see: CMSModule::CreateParameter()
see: CMSModule::SetParameters()
final:
access: public

void; SetParameterType (string $param, define $type)

string $param: Parameter name;
define $type: Parameter type;

SetPreference (line 3336)

Sets a module preference.

final:
access: public

void SetPreference (string $preference_name, string $value)

string $preference_name: The name of the preference to set
string $value: The value to set it to

SetTabHeader (line 3040)

Set a specific tab header.

i.e: echo $this->SetTabHeader('preferences',$this->Lang('preferences'));

final:

string SetTabHeader (string $tabid, string $title, [boolean $active = false])

string $tabid: The tab id
string $title: The tab title
boolean $active: A flag indicating wether this tab is active.

SetTemplate (line 2854)

Sets a smarty template into the database and associates it with a module.

final:
access: public

boolean SetTemplate (string $tpl_name, string $content, [string $modulename = ''])

string $tpl_name: The template name
string $content: The template content
string $modulename: The module name, if empty the current module name is used.

ShowErrors (line 3225)

ShowErrors Outputs errors in a nice error box with a troubleshooting link to the wiki

final:

string ShowErrors (errors $errors)

errors $errors: - array or string of errors to be shown

ShowInSyntaxList (line 1553)

Returns whether or not this module should show in any module lists generated by a WYSIWYG.

abstract:

boolean ShowInSyntaxList ()

ShowInWYSIWYG (line 1668)

Returns whether or not this module should show in any module lists generated by a WYSIWYG.

abstract:

boolean ShowInWYSIWYG ()

ShowMessage (line 3193)

ShowMessage Returns a formatted page status message

final:

string ShowMessage (message $message)

message $message: - Message to be shown

StartTab (line 3098)

Output a string to indicate the start of the output for a specific tab

final:

string StartTab (string $tabid, [arrray $params = array()])

string $tabid: tabid (see SetTabHeader)
arrray $params: Parameters

StartTabContent (line 3074)

Output a string to indicate the start of XHTML areas for tabs.

final:

string StartTabContent ()

StartTabHeaders (line 3025)

Output a string suitable for staring tab headers i.e: echo $this->StartTabHeaders();

final:

string StartTabHeaders ()

SupportsLazyLoading (line 1362)

Returns true if the module may support lazy loading in the front end

deprecated:
abstract:
since: 1.8
access: public

boolean SupportsLazyLoading ()

SuppressAdminOutput (line 590)

Use this method to prevent the admin interface from outputting header, footer, theme, etc, so your module can output files directly to the administrator.

Do this by returning true.

boolean SuppressAdminOutput (array &$request)

array &$request: The input request. This can be used to test conditions wether or not admin output should be suppressed.

SyntaxActive (line 1471)

Returns true if this SyntaxHighlighter should be considered active, eventhough it's not the choice of the user. Used for forcing a wysiwyg.

returns false be default.

abstract:

boolean SyntaxActive ()

SyntaxGenerateBody (line 1522)

Returns body code specific to this SyntaxHighlighter

abstract:

string SyntaxGenerateBody ()

SyntaxGenerateHeader (line 1511)

Returns header code specific to this SyntaxHighlighter

abstract:

string SyntaxGenerateHeader ([string $htmlresult = ''])

string $htmlresult: The html-code of the page before replacing SyntaxHighlighter-stuff

SyntaxPageForm (line 1483)

Returns content destined for the <form> tag. It's useful if javascript is needed for the onsubmit of the form.

abstract:

string SyntaxPageForm ()

SyntaxPageFormSubmit (line 1498)

This is a function that would be called before a form is submitted.

Generally, a dropdown box or something similar that would force a submit of the form via javascript should put this in their onchange line as well so that the SyntaxHighlighter can do any cleanups before the actual form submission takes place.

abstract:

string SyntaxPageFormSubmit ()

SyntaxTextarea (line 1541)

Returns the textarea specific for this WYSIWYG.

abstract:

string $name: HTML name of the textarea
string $syntax: the language which the content should be highlighted as
int $columns: Number of columns wide that the textarea should be
int $rows: Number of rows long that the textarea should be
string $encoding: Encoding of the content
string $content: Content to show in the textarea
string $stylesheet: Stylesheet for content, if available
string $addtext: additional attributes to include in textarea tag.

Uninstall (line 1092)

Function that will get called as module is uninstalled. This function should remove any database tables that it uses and perform any other cleanup duties.

It should return a string message if there is a failure. Returning nothing (FALSE) will allow the uninstall procedure to proceed.

The default behaviour of this function is to include a file called method.uninstall.php in your module directory to do uninstall operations.

return: FALSE indicates that the module uninstalled correctly, any other value indicates an error message.
abstract:

mixed Uninstall ()

UninstallPostMessage (line 1147)

Display a message after a successful uninstall of the module.

return: Text, or FALSE
abstract:

XHTML UninstallPostMessage ()

UninstallPreMessage (line 1136)

Display a message and a Yes/No dialog before doing an uninstall. Returning noting (FALSE) will go right to the uninstall.

return: Text, or FALSE.
abstract:

XHTML UninstallPreMessage ()

Upgrade (line 1167)

Function to perform any upgrade procedures. This is mostly used to for

updating databsae tables, but can do other duties as well. It should return a string message if there is a failure. Returning nothing (FALSE) will allow the upgrade procedure to proceed. Upgrades should have a path so that they can be upgraded from more than one version back. While not a requirement, it makes life easy for your users.

The default behavior of this method is to call a function called method.upgrade.php in your module directory, if it exists.

boolean Upgrade (string $oldversion, string $newversion)

string $oldversion: The version we are upgrading from
string $newversion: The version we are upgrading to

ValidateContentBlockValue (line 939)

Validate the value for a module generated content block type.

This method can be overridden if the module is providing content block types to the CMSMS content objects.

return: An error message if the value is invalid, empty otherwise.
abstract:

string ValidateContentBlockValue (string $blockName, mixed $value, arrray $blockparams)

string $blockName: Content block name
mixed $value: Content block value
arrray $blockparams: Content block parameters.

VisibleToAdminUser (line 1313)

Returns true or false, depending on whether the user has the right permissions to see the module in their Admin menus.

Typically permission checks are done in the overriden version of this method.

Defaults to true.

abstract:

boolean VisibleToAdminUser ()

WYSIWYGActive (line 1588)

Returns true if this wysiwyg should be considered active, eventhough it's not the choice of the user. Used for forcing a wysiwyg.

returns false be default.

abstract:

boolean WYSIWYGActive ()

WYSIWYGGenerateBody (line 1638)

Returns body code specific to this WYSIWYG

abstract:

string WYSIWYGGenerateBody ()

WYSIWYGGenerateHeader (line 1627)

Returns header code specific to this WYSIWYG

abstract:

string WYSIWYGGenerateHeader ([string $htmlresult = ''])

string $htmlresult: The html-code of the page before replacing WYSIWYG-stuff

WYSIWYGPageForm (line 1600)

Returns content destined for the <form> tag. It's useful if javascript is needed for the onsubmit of the form.

abstract:

string WYSIWYGPageForm ()

WYSIWYGPageFormSubmit (line 1615)

This is a function that would be called before a form is submitted.

Generally, a dropdown box or something similar that would force a submit of the form via javascript should put this in their onchange line as well so that the WYSIWYG can do any cleanups before the actual form submission takes place.

abstract:

string WYSIWYGPageFormSubmit ()

WYSIWYGTextarea (line 1656)

Returns the textarea specific for this WYSIWYG.

abstract:

string WYSIWYGTextarea ([string $name = 'textarea'], [int $columns = '80'], [int $rows = '15'], [string $encoding = ''], [string $content = ''], [string $stylesheet = ''], [string $addtext = ''])

string $name: HTML name of the textarea
int $columns: Number of columns wide that the textarea should be
int $rows: Number of rows long that the textarea should be
string $encoding: Encoding of the content
string $content: Content to show in the textarea
string $stylesheet: Stylesheet for content, if available
string $addtext: Additional attributes to include in textarea tag.

__get (line 157)

Magic methods. This handles the deprecated. $this->db etc, syntax.

deprecated:
access: public

void &__get (string $key)

string $key: The key to get. possible values are cms,db,smarty.config

Documentation generated on Sun, 12 Aug 2012 08:38:23 -0600 by phpDocumentor 1.3.2