MaterialAwareInterface
in
Classes that implement this Interface can participate in material flow detection with greater depth
This interface is used by Class Scripts to give a hook into the detection process. This will allow the addition of domain specific logic into the detection code.
Table of Contents
Methods
- afterCloseMovement() : bool
- This method is called after the entry is closed. The return argument does nothing for now.
- beforeCloseMovement() : bool
- This method is called before the entry is closed. The return argument indicates to the caller if the default functionality should still occur.
Methods
afterCloseMovement()
This method is called after the entry is closed. The return argument does nothing for now.
public
afterCloseMovement(LedgerEntry $entry) : bool
Parameters
- $entry : LedgerEntry
Return values
boolbeforeCloseMovement()
This method is called before the entry is closed. The return argument indicates to the caller if the default functionality should still occur.
public
beforeCloseMovement(LedgerEntry $entry) : bool
Returning false will cause the entry to be left in an open state. It is highly recommended to close the entry (give it an amount, direction, start and end) and its corresponding entries if false is returned. Note that if false is returned the afterCloseMovement function will still be called.
Parameters
- $entry : LedgerEntry