BaseTrigger

Properties

This abstract class defines the following properties:

$RESERVED_SETTING_NAMES Inherited from BaseTemplate

`$RESERVED_SETTING_NAMES`

Signature

Its type is not specified.

Methods

The abstract class defines the following methods:

getId() ash; Get the ID of this template. Inherited from BaseTemplate
getParameters() ash; Get the list of parameters that can be configured for this template. Inherited from BaseTemplate
getCategory()
getSupportedContexts()
getName() ash; Get the translated name of this template. Inherited from BaseTemplate
getDescription() ash; Get the translated description of this template. Inherited from BaseTemplate
getHelp() ash; Get the translated help text for this template. Inherited from BaseTemplate
getOrder() ash; Get the order for this template. Inherited from BaseTemplate
getIcon() ash; Get the image icon url. Inherited from BaseTemplate
hasAdvancedSettings() ash; Lets you hide the advanced settings tab in the UI. Inherited from BaseTemplate
isCustomTemplate() ash; If your template allows a user to add js/html code to the site for example, you should be overwriting this method and return true. Inherited from BaseTemplate

`getId()`

Get the ID of this template.

The ID is by default automatically generated from the class name, but can be customized by returning a string.

Signature

It returns a string value.

`getParameters()`

Get the list of parameters that can be configured for this template.

Signature

It returns a Setting[] value.

`getCategory()`

Signature

It returns a string value.

`getSupportedContexts()`

Signature

It returns a string[] value.

`getName()`

Get the translated name of this template.

Signature

It returns a string value.

`getDescription()`

Get the translated description of this template.

Signature

It returns a string value.

`getHelp()`

Get the translated help text for this template.

Signature

It returns a string value.

`getOrder()`

Get the order for this template. The lower the order is, the higher in the list the template will be shown.

Signature

It returns a int value.

`getIcon()`

Get the image icon url. We could also use data:uris to return the amount of requests to load a page like this: return 'data:image/svg+xml;base64,' . base64_encode('<svg.

..'); However, we prefer the files since we can better define them in the legal notice.

Signature

It returns a string value.

`hasAdvancedSettings()`

Lets you hide the advanced settings tab in the UI.

Signature

It returns a bool value.

`isCustomTemplate()`

If your template allows a user to add js/html code to the site for example, you should be overwriting this method and return true.

Signature

It returns a bool value.