Ibexa >
Contracts >
ShoppingList >
ShoppingListServiceInterface

ShoppingListServiceInterface

ShoppingListServiceInterface.php : 22 Copy path

Interface

Methods¶

addEntries() ¶

ShoppingListServiceInterface.php : 70 Copy path

public addEntries(ShoppingListInterface $shoppingList, array<string|int, EntryAddStruct> $entryAddStructs) : ShoppingListInterface

Parameters

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

Return values

ShoppingListInterface

Tags

clearShoppingList() ¶

ShoppingListServiceInterface.php : 62 Copy path

public clearShoppingList(ShoppingListInterface $shoppingList) : ShoppingListInterface

Parameters

Name	Type	Default value	Description
$shoppingList	ShoppingListInterface	-	-

Return values

ShoppingListInterface

Tags

createShoppingList() ¶

ShoppingListServiceInterface.php : 42 Copy path

public createShoppingList(ShoppingListCreateStruct $createStruct) : ShoppingListInterface

Parameters

Name	Type	Default value	Description
$createStruct	ShoppingListCreateStruct	-	-

Return values

ShoppingListInterface

Tags

deleteShoppingList() ¶

ShoppingListServiceInterface.php : 57 Copy path

public deleteShoppingList(ShoppingListInterface $shoppingList) : void

Parameters

Name	Type	Default value	Description
$shoppingList	ShoppingListInterface	-	-

Tags

findShoppingLists() ¶

ShoppingListServiceInterface.php : 36 Copy path

public findShoppingLists([ShoppingListQuery|null $query = null ]) : ShoppingListCollectionInterface

Parameters

Name	Type	Default value	Description
$query	ShoppingListQuery\|null	null	-

Return values

ShoppingListCollectionInterface

getEntry() ¶

ShoppingListServiceInterface.php : 34 Copy path

public getEntry(string $identifier) : ShoppingListEntryInterface

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

ShoppingListEntryInterface

Tags

getOrCreateDefaultShoppingList() ¶

ShoppingListServiceInterface.php : 106 Copy path

Returns the default shopping list for the current user.

public getOrCreateDefaultShoppingList() : ShoppingListInterface

If no default list exists, it will be created automatically.

Return values

ShoppingListInterface

Tags

getShoppingList() ¶

ShoppingListServiceInterface.php : 28 Copy path

public getShoppingList(string $identifier) : ShoppingListInterface

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

ShoppingListInterface

Tags

moveEntries() ¶

ShoppingListServiceInterface.php : 93 Copy path

public moveEntries(ShoppingListInterface $targetShoppingList, array<string|int, ShoppingListEntryInterface> $entries[, bool $copy = false ]) : void

Parameters

Name	Type	Default value	Description
$targetShoppingList	ShoppingListInterface	-	-
$entries	array<string\|int, ShoppingListEntryInterface>	-	-
$copy	bool	false	If true, copies entries without deleting from source. If false (default), moves entries (deletes from source).

Tags

removeEntries() ¶

ShoppingListServiceInterface.php : 81 Copy path

public removeEntries(ShoppingListInterface $shoppingList, array<string|int, ShoppingListEntryInterface> $entries) : ShoppingListInterface

Parameters

Name	Type	Default value	Description
$shoppingList	ShoppingListInterface	-	-
$entries	array<string\|int, ShoppingListEntryInterface>	-	-

Return values

ShoppingListInterface

Tags

updateShoppingList() ¶

ShoppingListServiceInterface.php : 48 Copy path

public updateShoppingList(ShoppingListInterface $shoppingList, ShoppingListUpdateStruct $updateStruct) : ShoppingListInterface

Parameters

Name	Type	Default value	Description
$shoppingList	ShoppingListInterface	-	-
$updateStruct	ShoppingListUpdateStruct	-	-

Return values

ShoppingListInterface