Plugin JavaScript Functions

These functions can be called in visitor mode, anywhere your plugin is in a slot.

All of these functions are encapsulated, which means you need to use syntax of the form:

module_class_name.functionName(param1, param2, ...)

to call them from your JavaScript code, where module_class_name is your Module's class name.

You can also use syntax of the form:

$this->callScript('module_class_name', 'functionName', 'param1', 'param2', ...)

to call them from your plugin's init() method.

AJAXLink()

This generates a link to your handleAJAX() method.

instanceId()

Returns the Instance Id of an Instance of your Plugin on the current page.

phrase()

Retrieves one of the Phrases for your Plugin using AJAX.

pluginAJAXLink()

This generates a link to your pluginAJAXLink() method.

refreshPluginSlot()

Triggers a refresh for a Plugin in a Slot.

scrollToSlotTop()

Scrolls the Visitor's screen to the top of a slot on the current page.

showFileLink()

This generates a link to your showFile() method.

showFloatingBoxLink()

This generates a link to your showFloatingBox() method.

showImageLink()

This generates a link to your showImage() method.

showSingleSlotLink()

This generates a link to show your plugin alone on the current page.

showStandalonePageLink()

This generates a link to your showStandalonePage() method.

slotName()

This function returns the name of a Slot that your Plugin is in on a Page.