bitlair/revbank
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document ABORT constant as possible return value from hook

Browse source 
This feature was introduced way back in commit add31004.
This commit is contained in:
Juerd Waalboer 2021-12-03 01:49:25 +01:00
parent 6850ed22be
commit 9cda968d53
1 changed files with 3 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

12
lib/RevBank/Plugins.pod
View file

@ -114,15 +114,9 @@ cart, re-evaluate your assumptions when upgrading!
Hooks SHOULD NOT prompt for input or execute programs that do so.
A plugin that exists only for its hooks, MUST still provide a C<command> method.
The suggested implementation for a no-op C<command> method is:
sub command {
return NEXT;
}
Hooks are called as class methods. The return value is ignored. Hooks MUST NOT
interfere with the transaction flow (e.g. abort it).
Hooks are called as class methods. The return value MUST be either C<ABORT>,
which causes the ongoing transaction to be aborted, or a non-reference, which
will be ignored.
The following hooks are available, with their respective arguments: