Framework Functions

These help you generate html on the page, and help you generate forms and links. Most of these provide you an alternate way of achieving something that you could have written yourself, but by using the framework functions you can take advantage of features such as reloading via AJAX and translation of phrases.

You can use syntax of the form:

$this->functionName()

to call a framework function from anywhere within your plugin's showSlot() method.

closeForm()

Allows you to close a form opened with openForm().

openForm()

Opens a form, that will submit by reloading the Plugin via AJAX.

pagination()

This function allows you to easily create pagination for your Plugins.

phrase()

Retrieves one of the Phrases for your Plugin.

refreshPluginSlotAnchor()

Generates attributes for a hyperlink that will cause your Plugin to reload via AJAX.

refreshPluginSlotAnchorAndJS()

A shortcut function for calling refreshPluginSlotAnchor() and refreshPluginSlotJS().

refreshPluginSlotJS()

Generates JavaScript that will cause your Plugin to reload via AJAX.

remember()

A shortcut function for writing hidden fields.

replacePhraseCodesInString()

Inserts phrases into text containing Phrase Codes.

twigFramework()

Calls the Twig template engine to output a Twig framework.