BeforeAddEntriesEvent

BeforeAddEntriesEvent.php : 16 Copy path

Final

Extends BeforeEvent

Implements ShoppingListResultAwareEventInterface

Event emitted before action execution.

Methods¶

__construct() ¶

BeforeAddEntriesEvent.php : 21 Copy path

public __construct(ShoppingListInterface $shoppingList, array<string|int, EntryAddStruct> $entryAddStructs[, ShoppingListInterface|null $shoppingListResult = null ])

Parameters

Name	Type	Default value	Description
$shoppingList	ShoppingListInterface	-	-
$entryAddStructs	array<string\|int, EntryAddStruct>	-	-
$shoppingListResult	ShoppingListInterface\|null	null	-

getEntryAddStructs() ¶

BeforeAddEntriesEvent.php : 35 Copy path

public getEntryAddStructs() : array<string|int, EntryAddStruct>

Return values

array<string|int, EntryAddStruct>

getShoppingList() ¶

BeforeAddEntriesEvent.php : 27 Copy path

public getShoppingList() : ShoppingListInterface

Return values

ShoppingListInterface

getShoppingListResult() ¶

BeforeAddEntriesEvent.php : 40 Copy path

public getShoppingListResult() : ShoppingListInterface

Return values

ShoppingListInterface

hasShoppingListResult() ¶

BeforeAddEntriesEvent.php : 56 Copy path

public hasShoppingListResult() : bool

Return values

bool

isPropagationStopped() ¶

Event.php : 35 Copy path

public isPropagationStopped() : bool

Return values

bool

setShoppingListResult() ¶

BeforeAddEntriesEvent.php : 51 Copy path

public setShoppingListResult(ShoppingListInterface|null $shoppingListResult) : void

Parameters

Name	Type	Default value	Description
$shoppingListResult	ShoppingListInterface\|null	-	-

stopPropagation() ¶

Event.php : 47 Copy path

Stops the propagation of the event to further event listeners.

public stopPropagation() : void

If multiple event listeners are connected to the same event, no further event listener will be triggered once any trigger calls stopPropagation().