Handler
extends AbstractPlugin
in package
implements
Plugin
Uses
PluginIsInContext
Implement contact form hook This class provides interfaces to register the contact form extension js
Tags
Interfaces, Classes, Traits and Enums
- Plugin
- Define a system plugin
Table of Contents
- $name : string
- $path : string
- __construct() : mixed
- OnAfterSendMail() : void
- OnBeforeResendSendMail() : void
- OnCopyMail() : void
- OnGetEntityAttributes() : void
- Get entity attributes
- OnRegisterWidgetIncludes() : void
- RegisterHooks() : array<string|int, mixed>
- register system hooks Register a set of handler functions to be called in certain positions.
- SetupTemplate() : Result
- Get and set the plugin setup template form
- _setupTemplate() : Result
- isInContext() : bool
- Is in certain context?
Properties
$name
protected
string
$name
= ''
$path
protected
string
$path
= ''
Methods
__construct()
public
__construct() : mixed
Return values
mixed —OnAfterSendMail()
public
OnAfterSendMail(HookArgument $param) : void
Parameters
- $param : HookArgument
-
A hook argument
Return values
void —OnBeforeResendSendMail()
public
OnBeforeResendSendMail(HookArgument $param) : void
Parameters
- $param : HookArgument
-
A hook argument
Return values
void —OnCopyMail()
public
OnCopyMail(HookArgument $param) : void
Parameters
- $param : HookArgument
-
A hook argument
Return values
void —OnGetEntityAttributes()
Get entity attributes
public
OnGetEntityAttributes(HookArgument $reference) : void
This hook is called from object handler Can be used to overrule the internal attribute set
Parameters
- $reference : HookArgument
-
A default hook object
Tags
Return values
void —OnRegisterWidgetIncludes()
public
OnRegisterWidgetIncludes(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —RegisterHooks()
register system hooks Register a set of handler functions to be called in certain positions.
public
RegisterHooks() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of hooks to bind
SetupTemplate()
Get and set the plugin setup template form
public
SetupTemplate([mixed $data = null ]) : Result
Parameters
- $data : mixed = null
Return values
Result —_setupTemplate()
protected
_setupTemplate([mixed $data = null ]) : Result
Parameters
- $data : mixed = null
Return values
Result —isInContext()
Is in certain context?
protected
isInContext(HookArgument $param, string $type, string $widget) : bool
Parameters
- $param : HookArgument
-
The hook argument
- $type : string
-
The type can be scss, css and js to search in widgets or _ to search in global includes
- $widget : string
-
The widget to search for