Handler
in package
implements
Plugin
Uses
PluginIsInContext
Implement voucher handler
This class provides interfaces for voucher handling
Tags
Interfaces, Classes, Traits and Enums
- Plugin
- Define a system plugin
Table of Contents
- $db : VoucherDBAL|null
- BasketChangeStatus() : void
- Called on basket status change, reaction is needed on cancel
- OnBeforeAddOrUpdateBasket() : void
- Called on save an object
- OnDeleteContent() : void
- React on basket delete
- OnRegisterWidgetIncludes() : void
- RegisterHooks() : array<string|int, mixed>
- Register system hooks
- SetupTemplate() : Result
- Setup getter and setter
- isInContext() : bool
- Is in certain context?
- database() : VoucherDBAL
- Get the database
Properties
$db
private
VoucherDBAL|null
$db
= null
Methods
BasketChangeStatus()
Called on basket status change, reaction is needed on cancel
public
BasketChangeStatus( $req) : void
Parameters
Return values
void —OnBeforeAddOrUpdateBasket()
Called on save an object
public
OnBeforeAddOrUpdateBasket(HookArgument $param) : void
Update the voucher index on basket transitions
Parameters
- $param : HookArgument
-
A hook argument with user and result
Return values
void —OnDeleteContent()
React on basket delete
public
OnDeleteContent( $param) : void
Parameters
Return values
void —OnRegisterWidgetIncludes()
public
OnRegisterWidgetIncludes(HookArgument $param) : void
Parameters
- $param : HookArgument
Return values
void —RegisterHooks()
Register system hooks
public
RegisterHooks() : array<string|int, mixed>
Register a set of handler functions to be called in certain positions.
Return values
array<string|int, mixed> —A list of hooks to register
SetupTemplate()
Setup getter and setter
public
SetupTemplate([array<string|int, mixed> $data = null ]) : Result
The setter is just an interface and not active
Parameters
- $data : array<string|int, mixed> = null
-
New configuration values
Return values
Result —The template fetch 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
Return values
bool —database()
Get the database
private
database() : VoucherDBAL