diff --git a/code_samples/shopping_list/add_to_shopping_list/assets/js/add-to-shopping-list.ts b/code_samples/shopping_list/add_to_shopping_list/assets/js/add-to-shopping-list.ts new file mode 100644 index 0000000000..05cba82778 --- /dev/null +++ b/code_samples/shopping_list/add_to_shopping_list/assets/js/add-to-shopping-list.ts @@ -0,0 +1,18 @@ +// Shopping list service +import ShoppingList from '@ibexa-shopping-list/src/bundle/Resources/public/js/component/shopping.list'; +// The Add to shopping list interaction +import { AddToShoppingList } from '@ibexa-shopping-list/src/bundle/Resources/public/js/component/add.to.shopping.list'; +// List of all user's shopping lists +import { ShoppingListsList } from '@ibexa-shopping-list/src/bundle/Resources/public/js/component/shopping.lists.list'; + +(function (global: Window, doc: Document) { + const shoppingList = new ShoppingList(); + shoppingList.init(); // Fetch user's shopping lists + + const addToShoppingListsNodes = doc.querySelectorAll('.ibexa-sl-add-to-shopping-list'); + addToShoppingListsNodes.forEach((addToShoppingListNode) => { + const addToShoppingList = new AddToShoppingList({ node: addToShoppingListNode, ListClass: ShoppingListsList }); + + addToShoppingList.init(); + }); +})(window, window.document); diff --git a/code_samples/shopping_list/add_to_shopping_list/config/packages/views.yaml b/code_samples/shopping_list/add_to_shopping_list/config/packages/views.yaml new file mode 100644 index 0000000000..753bb3b616 --- /dev/null +++ b/code_samples/shopping_list/add_to_shopping_list/config/packages/views.yaml @@ -0,0 +1,10 @@ +ibexa: + system: + default: + content_view: + full: + product: + controller: 'App\Controller\ProductViewController::viewAction' + template: '@ibexadesign/full/product.html.twig' + match: + '@Ibexa\Contracts\ProductCatalog\ViewMatcher\ProductBased\IsProduct': true diff --git a/code_samples/shopping_list/add_to_shopping_list/src/Controller/ProductViewController.php b/code_samples/shopping_list/add_to_shopping_list/src/Controller/ProductViewController.php new file mode 100644 index 0000000000..3c67c35ed9 --- /dev/null +++ b/code_samples/shopping_list/add_to_shopping_list/src/Controller/ProductViewController.php @@ -0,0 +1,35 @@ +productService->getProductFromContent($view->getContent()); + if ($product->isBaseProduct()) { + $view->addParameters([ + 'variants' => new BatchIterator(new ProductVariantFetchAdapter( + $this->productService, + $product, + new ProductVariantQuery(), + )), + ]); + } + + return $view; + } +} diff --git a/code_samples/shopping_list/add_to_shopping_list/templates/themes/standard/full/product.html.twig b/code_samples/shopping_list/add_to_shopping_list/templates/themes/standard/full/product.html.twig new file mode 100644 index 0000000000..07fff9334e --- /dev/null +++ b/code_samples/shopping_list/add_to_shopping_list/templates/themes/standard/full/product.html.twig @@ -0,0 +1,56 @@ +{% extends '@ibexadesign/pagelayout.html.twig' %} + +{% set product = content|ibexa_get_product %} + +{% block meta %} + {% set token = csrf_token ?? csrf_token(ibexa_get_rest_csrf_token_intention()) %} + + +{% endblock %} + +{% block content %} + {{ ibexa_content_name(content) }} + {{ product.code }} + {% if not product.isBaseProduct() and can_view_shopping_list and can_edit_shopping_list %} + {% set component %} + {% include '@ibexadesign/shopping_list/component/add_to_shopping_list/add_to_shopping_list.html.twig' with { + product_code: product.code, + } %} + {% endset %} + {{ _self.add_to_shopping_list(product, component) }} + {% endif %} + + {% if product.isBaseProduct() %} + + {% endif %} +{% endblock %} + +{% block javascripts %} + {{ encore_entry_script_tags('add-to-shopping-list-js') }} +{% endblock %} + +{% macro add_to_shopping_list(product, component) %} + {% set widget_id = 'add-to-shopping-list-' ~ product.code|slug %} + + +{% endmacro %} diff --git a/code_samples/shopping_list/add_to_shopping_list/webpack.config.js b/code_samples/shopping_list/add_to_shopping_list/webpack.config.js new file mode 100644 index 0000000000..bee99eec81 --- /dev/null +++ b/code_samples/shopping_list/add_to_shopping_list/webpack.config.js @@ -0,0 +1,60 @@ +const fs = require('fs'); +const path = require('path'); +const Encore = require('@symfony/webpack-encore'); +const getWebpackConfigs = require('@ibexa/frontend-config/webpack-config/get-configs'); +const customConfigsPaths = require('./var/encore/ibexa.webpack.custom.config.js'); + +const customConfigs = getWebpackConfigs(Encore, customConfigsPaths); +const isReactBlockPathCreated = fs.existsSync('./assets/page-builder/react/blocks'); + +Encore.reset(); +Encore + .setOutputPath('public/build/') + .setPublicPath('/build') + .enableSassLoader() + .enableReactPreset((options) => { + options.runtime = 'classic'; + }) + .enableSingleRuntimeChunk() + .copyFiles({ + from: './assets/images', + to: 'images/[path][name].[ext]', + pattern: /\.(png|svg)$/, + }) + .configureBabelPresetEnv((config) => { + config.useBuiltIns = 'usage'; + config.corejs = 3; + }); + +// Welcome page stylesheets +Encore.addEntry('welcome-page-css', [ + path.resolve(__dirname, './assets/scss/welcome-page.scss'), +]); + +// Welcome page javascripts +Encore.addEntry('welcome-page-js', [ + path.resolve(__dirname, './assets/js/welcome.page.js'), +]); + +if (isReactBlockPathCreated) { + // React Blocks javascript + Encore.addEntry('react-blocks-js', './assets/js/react.blocks.js'); +} + +//Encore.addEntry('app', './assets/app.js'); + +Encore + .enableTypeScriptLoader() + .addAliases({ + '@ibexa-shopping-list': path.resolve('./vendor/ibexa/shopping-list'), + }) + .addEntry('add-to-shopping-list-js', [ + path.resolve(__dirname, './assets/js/add-to-shopping-list.ts'), + ]) +; + +const projectConfig = Encore.getWebpackConfig(); + +projectConfig.name = 'app'; + +module.exports = [...customConfigs, projectConfig]; diff --git a/code_samples/shopping_list/install/src/Migrations/Ibexa/migrations/shopping_list_user.yaml b/code_samples/shopping_list/install/src/Migrations/Ibexa/migrations/shopping_list_user.yaml new file mode 100644 index 0000000000..ed3e6784bb --- /dev/null +++ b/code_samples/shopping_list/install/src/Migrations/Ibexa/migrations/shopping_list_user.yaml @@ -0,0 +1,33 @@ +- type: reference + mode: load + filename: references/customer_group_references.yml + +- type: role + mode: create + metadata: + identifier: Shopping List User + policies: + - module: shopping_list + function: create + limitations: + - identifier: ShoppingListOwner + values: [self] + - module: shopping_list + function: view + limitations: + - identifier: ShoppingListOwner + values: [self] + - module: shopping_list + function: edit + limitations: + - identifier: ShoppingListOwner + values: [self] + - module: shopping_list + function: delete + limitations: + - identifier: ShoppingListOwner + values: [self] + actions: + - action: assign_role_to_user_group + value: + id: 'reference:ref__checkout__customers_user_group__content_id' diff --git a/code_samples/shopping_list/php_api/src/Command/ShoppingListMoveCommand.php b/code_samples/shopping_list/php_api/src/Command/ShoppingListMoveCommand.php new file mode 100644 index 0000000000..91e8bddb04 --- /dev/null +++ b/code_samples/shopping_list/php_api/src/Command/ShoppingListMoveCommand.php @@ -0,0 +1,77 @@ +userService->loadUserByLogin($login); + $this->permissionResolver->setCurrentUserReference($user); + + $sourceList = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($prefix . '-source')); + $targetList = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($prefix . '-target')); + + $sourceList = $this->shoppingListService->addEntries($sourceList, [new EntryAddStruct($productCodes[0]), new EntryAddStruct($productCodes[1])]); + $targetList = $this->shoppingListService->addEntries($targetList, [new EntryAddStruct($productCodes[1])]); + + $entriesToMove = []; + $entriesToRemove = []; + foreach ($movedProductCodes as $productCode) { + if ($sourceList->getEntries()->hasEntryWithProductCode($productCode)) { + if ($targetList->getEntries()->hasEntryWithProductCode($productCode)) { + $entriesToRemove[] = $sourceList->getEntries()->getEntryWithProductCode($productCode); + } else { + $entriesToMove[] = $sourceList->getEntries()->getEntryWithProductCode($productCode); + } + } + } + $this->shoppingListService->moveEntries($targetList, $entriesToMove); + $targetList = $this->shoppingListService->getShoppingList($targetList->getIdentifier()); // Refresh local object from persistence + $sourceList = $this->shoppingListService->removeEntries($sourceList, $entriesToRemove); // Refresh local object from persistence even if $entriesToRemove is empty + + $this->displayList($output, $sourceList); + $this->displayList($output, $targetList); + + $this->shoppingListService->deleteShoppingList($sourceList); + $this->shoppingListService->deleteShoppingList($targetList); + + return Command::SUCCESS; + } + + private function displayList(OutputInterface $output, ShoppingListInterface $list): void + { + $output->writeln("{$list->getOwner()->getName()} ({$list->getOwner()->getLogin()})"); + $output->writeln("{$list->getName()} ({$list->getIdentifier()})" . ($list->isDefault() ? ' [default]' : '')); + $entries = $list->getEntries(); + $output->writeln(count($entries) . (count($entries) > 1 ? ' entries' : ' entry')); + foreach ($entries as $entry) { + $output->writeln("- {$entry->getProduct()->getName()} ({$entry->getProduct()->getCode()})"); + } + } +} diff --git a/code_samples/shopping_list/php_api/src/Controller/CartShoppingListTransferController.php b/code_samples/shopping_list/php_api/src/Controller/CartShoppingListTransferController.php new file mode 100644 index 0000000000..ee5b552dc7 --- /dev/null +++ b/code_samples/shopping_list/php_api/src/Controller/CartShoppingListTransferController.php @@ -0,0 +1,94 @@ +userService->loadUser($this->permissionResolver->getCurrentUserReference()->getUserId()); + $name = 'cart-shopping-list-transfer-test'; + + $cartQuery = new CartQuery(); + $cartQuery->setOwnerId($user->getId()); + $cartsList = $this->cartService->findCarts($cartQuery); + $cart = null; + foreach ($cartsList->getCarts() as $cart) { + if ($cart->getName() === $name) { + break; + } + $cart = null; + } + if (null === $cart) { + $cart = $this->cartService->createCart(new CartCreateStruct($name, $this->currencyService->getCurrencyByCode($currency), $user)); + } + + $lists = $this->shoppingListService->findShoppingLists(new ShoppingListQuery(new NameCriterion($name))); + if ($lists->getTotalCount()) { + $list = $lists->getShoppingLists()[0]; + } else { + $list = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($name)); + } + + $this->cartService->emptyCart($cart); + $list = $this->shoppingListService->clearShoppingList($list); + + $list = $this->shoppingListService->addEntries($list, [new ShoppingListEntryAddStruct($productCode)]); + + $cart = $this->cartShoppingListTransferService->addSelectedEntriesToCart($list, [$list->getEntries()->getEntryWithProductCode($productCode)->getIdentifier()], $cart); + + dump( + $list->getEntries()->hasEntryWithProductCode($productCode), // true as the entry is copied and not moved + $cart->getEntries()->hasEntryForProduct($this->productService->getProduct($productCode)) // true + ); + + $list = $this->shoppingListService->clearShoppingList($list); // Empty the list to avoid duplicate and test the move from cart + + $list = $this->cartShoppingListTransferService->moveCartToShoppingList($cart, $list); + $cart = $this->cartService->getCart($cart->getIdentifier()); // Refresh local object from persistence + + dump( + $list->getEntries()->hasEntryWithProductCode($productCode), // true as, after the clear, the entry is moved from cart + $cart->getEntries()->hasEntryForProduct($this->productService->getProduct($productCode)) // false as the entry was moved + ); + + return new Response(''); + } +} diff --git a/composer.json b/composer.json index caf28e4e74..d8f3f28fa2 100644 --- a/composer.json +++ b/composer.json @@ -78,6 +78,7 @@ "ibexa/messenger": "~5.0.x-dev", "ibexa/collaboration": "~5.0.x-dev", "ibexa/share": "~5.0.x-dev", + "ibexa/shopping-list": "~5.0.x-dev", "ibexa/phpstan": "~5.0.-dev", "deptrac/deptrac": "^3.0" }, diff --git a/docs/api/event_reference/shopping_list_events.md b/docs/api/event_reference/shopping_list_events.md new file mode 100644 index 0000000000..dedbc07f96 --- /dev/null +++ b/docs/api/event_reference/shopping_list_events.md @@ -0,0 +1,25 @@ +--- +description: Events that are triggered while managing shopping lists. +page_type: reference +editions: lts-update commerce +month_change: true +--- + +# Shopping list events + +| Event | Dispatched by | Description | +|--------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| [`BeforeCreateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeCreateShoppingListEvent.html) | [`ShoppingListService::createShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_createShoppingList) | Dispatched before a shopping list is created. Allows to modify or prevent creation. | +| [`CreateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-CreateShoppingListEvent.html) | [`ShoppingListService::createShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_createShoppingList) | Dispatched after a shopping list is created. | +| [`BeforeUpdateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeUpdateShoppingListEvent.html) | [`ShoppingListService::updateShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_updateShoppingList) | Dispatched before a shopping list is updated. Allows to modify or prevent update. | +| [`UpdateShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-UpdateShoppingListEvent.html) | [`ShoppingListService::updateShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_updateShoppingList) | Dispatched after a shopping list is updated. | +| [`BeforeDeleteShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeDeleteShoppingListEvent.html) | [`ShoppingListService::deleteShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_deleteShoppingList) | Dispatched before a shopping list is deleted. Allows to prevent deletion. | +| [`DeleteShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-DeleteShoppingListEvent.html) | [`ShoppingListService::deleteShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_deleteShoppingList) | Dispatched after a shopping list is deleted. | +| [`BeforeClearShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeClearShoppingListEvent.html) | [`ShoppingListService::clearShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_clearShoppingList) | Dispatched before a shopping list is cleared. Allows to modify or prevent clearing. | +| [`ClearShoppingListEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ClearShoppingListEvent.html) | [`ShoppingListService::clearShoppingList`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_clearShoppingList) | Dispatched after a shopping list is cleared. | +| [`BeforeAddEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeAddEntriesEvent.html) | [`ShoppingListService::addEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_addEntries) | Dispatched before entries are added to a shopping list. Allows to modify or prevent addition. | +| [`AddEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-AddEntriesEvent.html) | [`ShoppingListService::addEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_addEntries) | Dispatched after entries are added to a shopping list. | +| [`BeforeRemoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeRemoveEntriesEvent.html) | [`ShoppingListService::removeEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_removeEntries) | Dispatched before entries are removed from a shopping list. Allows to modify or prevent removal. | +| [`RemoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-RemoveEntriesEvent.html) | [`ShoppingListService::removeEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_removeEntries) | Dispatched after entries are removed from a shopping list. | +| [`BeforeMoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeMoveEntriesEvent.html) | [`ShoppingListService::moveEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_moveEntries) | Dispatched before entries are moved to another shopping list. Allows to modify or prevent moving. | +| [`MoveEntriesEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-MoveEntriesEvent.html) | [`ShoppingListService::moveEntries`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html#method_moveEntries) | Dispatched after entries are moved to another shopping list. | diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cart-CartShoppingListTransferServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cart-CartShoppingListTransferServiceInterface.html index 5aecc5c532..ecea8475fd 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cart-CartShoppingListTransferServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cart-CartShoppingListTransferServiceInterface.html @@ -280,7 +280,7 @@

-
public addSelectedEntriesToCart(ShoppingListInterface $shoppingList, array<string|int, string> $entryIdentifiers[, CartInterface|null $cart = null ]) : CartInterface
+
public addSelectedEntriesToCart(ShoppingListInterface $shoppingList, array<string|int, string> $entryIdentifiers[, CartInterface|null $cart = null ]) : CartInterface
@@ -305,7 +305,7 @@

Parameters

$shoppingList - ShoppingListInterface + ShoppingListInterface - @@ -373,7 +373,7 @@

-
public addShoppingListToCart(ShoppingListInterface $shoppingList[, CartInterface|null $cart = null ]) : CartInterface
+
public addShoppingListToCart(ShoppingListInterface $shoppingList[, CartInterface|null $cart = null ]) : CartInterface
@@ -398,7 +398,7 @@

Parameters

$shoppingList - ShoppingListInterface + ShoppingListInterface - @@ -452,7 +452,7 @@

-
public moveCartToShoppingList(CartInterface $cart[, ShoppingListInterface|null $shoppingList = null ]) : ShoppingListInterface
+
public moveCartToShoppingList(CartInterface $cart[, ShoppingListInterface|null $shoppingList = null ]) : ShoppingListInterface
@@ -496,7 +496,7 @@

Parameters

$shoppingList - ShoppingListInterface|null + ShoppingListInterface|null null @@ -508,7 +508,7 @@

Parameters

Return values

-

ShoppingListInterface

+

ShoppingListInterface

@@ -536,7 +536,7 @@

-
public moveSelectedCartEntriesToShoppingList(CartInterface $cart, array<string|int, string> $entryIdentifiers[, ShoppingListInterface|null $shoppingList = null ]) : ShoppingListInterface
+
public moveSelectedCartEntriesToShoppingList(CartInterface $cart, array<string|int, string> $entryIdentifiers[, ShoppingListInterface|null $shoppingList = null ]) : ShoppingListInterface
@@ -598,7 +598,7 @@

Parameters

$shoppingList - ShoppingListInterface|null + ShoppingListInterface|null null @@ -610,7 +610,7 @@

Parameters

Return values

-

ShoppingListInterface

+

ShoppingListInterface

diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-AddEntriesEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-AddEntriesEvent.html new file mode 100644 index 0000000000..68f8a03f5f --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-AddEntriesEvent.html @@ -0,0 +1,625 @@ + + + + + AddEntriesEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AddEntriesEvent

+ +
+ AddEntriesEvent.php + : + 15 + +
+
Final
+ +
+ Extends AfterEvent +
+ + +
+

Event emitted after action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ AddEntriesEvent.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList, array<string|int, EntryAddStruct$entryAddStructs, ShoppingListInterface $shoppingListResult)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entryAddStructs + + array<string|int, EntryAddStruct> + + - + + - +
+ $shoppingListResult + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicgetEntryAddStructs() + +

+
+ AddEntriesEvent.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntryAddStructs() : array<string|int, EntryAddStruct>
+
+
+
+
+
+

Return values

+

array<string|int, EntryAddStruct>

+ + +
+

+ publicgetShoppingList() + +

+
+ AddEntriesEvent.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ AddEntriesEvent.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeAddEntriesEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeAddEntriesEvent.html new file mode 100644 index 0000000000..83063bb30a --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeAddEntriesEvent.html @@ -0,0 +1,737 @@ + + + + + BeforeAddEntriesEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BeforeAddEntriesEvent

+ +
+ BeforeAddEntriesEvent.php + : + 16 + +
+
Final
+ +
+ Extends BeforeEvent +
+ + + +
+

Event emitted before action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ BeforeAddEntriesEvent.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList, array<string|int, EntryAddStruct$entryAddStructs[, ShoppingListInterface|null $shoppingListResult = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entryAddStructs + + array<string|int, EntryAddStruct> + + - + + - +
+ $shoppingListResult + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetEntryAddStructs() + +

+
+ BeforeAddEntriesEvent.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntryAddStructs() : array<string|int, EntryAddStruct>
+
+
+
+
+
+

Return values

+

array<string|int, EntryAddStruct>

+ + +
+

+ publicgetShoppingList() + +

+
+ BeforeAddEntriesEvent.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ BeforeAddEntriesEvent.php + : + 40 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publichasShoppingListResult() + +

+
+ BeforeAddEntriesEvent.php + : + 56 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasShoppingListResult() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetShoppingListResult() + +

+
+ BeforeAddEntriesEvent.php + : + 51 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setShoppingListResult(ShoppingListInterface|null $shoppingListResult) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingListResult + + ShoppingListInterface|null + + - + + - +
+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeClearShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeClearShoppingListEvent.html new file mode 100644 index 0000000000..5f6ada268c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeClearShoppingListEvent.html @@ -0,0 +1,681 @@ + + + + + BeforeClearShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BeforeClearShoppingListEvent

+ +
+ BeforeClearShoppingListEvent.php + : + 15 + +
+
Final
+ +
+ Extends BeforeEvent +
+ + + +
+

Event emitted before action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ BeforeClearShoppingListEvent.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList[, ShoppingListInterface|null $shoppingListResult = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $shoppingListResult + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetShoppingList() + +

+
+ BeforeClearShoppingListEvent.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ BeforeClearShoppingListEvent.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publichasShoppingListResult() + +

+
+ BeforeClearShoppingListEvent.php + : + 43 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasShoppingListResult() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetShoppingListResult() + +

+
+ BeforeClearShoppingListEvent.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setShoppingListResult(ShoppingListInterface|null $shoppingListResult) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingListResult + + ShoppingListInterface|null + + - + + - +
+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeCreateShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeCreateShoppingListEvent.html new file mode 100644 index 0000000000..4d7c95f2f7 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeCreateShoppingListEvent.html @@ -0,0 +1,681 @@ + + + + + BeforeCreateShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BeforeCreateShoppingListEvent

+ +
+ BeforeCreateShoppingListEvent.php + : + 16 + +
+
Final
+ +
+ Extends BeforeEvent +
+ + + +
+

Event emitted before action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ BeforeCreateShoppingListEvent.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListCreateStruct $createStruct[, ShoppingListInterface|null $shoppingListResult = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $createStruct + + ShoppingListCreateStruct + + - + + - +
+ $shoppingListResult + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetCreateStruct() + +

+
+ BeforeCreateShoppingListEvent.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getCreateStruct() : ShoppingListCreateStruct
+
+
+
+
+
+

Return values

+

ShoppingListCreateStruct

+ + +
+

+ publicgetShoppingListResult() + +

+
+ BeforeCreateShoppingListEvent.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publichasShoppingListResult() + +

+
+ BeforeCreateShoppingListEvent.php + : + 44 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasShoppingListResult() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetShoppingListResult() + +

+
+ BeforeCreateShoppingListEvent.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setShoppingListResult(ShoppingListInterface|null $shoppingListResult) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingListResult + + ShoppingListInterface|null + + - + + - +
+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeDeleteShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeDeleteShoppingListEvent.html new file mode 100644 index 0000000000..5a9f2f56e4 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeDeleteShoppingListEvent.html @@ -0,0 +1,513 @@ + + + + + BeforeDeleteShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BeforeDeleteShoppingListEvent

+ +
+ BeforeDeleteShoppingListEvent.php + : + 14 + +
+
Final
+ +
+ Extends BeforeEvent +
+ + +
+

Event emitted before action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ BeforeDeleteShoppingListEvent.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicgetShoppingList() + +

+
+ BeforeDeleteShoppingListEvent.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeMoveEntriesEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeMoveEntriesEvent.html new file mode 100644 index 0000000000..a51d355de6 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeMoveEntriesEvent.html @@ -0,0 +1,569 @@ + + + + + BeforeMoveEntriesEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BeforeMoveEntriesEvent

+ +
+ BeforeMoveEntriesEvent.php + : + 15 + +
+
Final
+ +
+ Extends BeforeEvent +
+ + +
+

Event emitted before action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ BeforeMoveEntriesEvent.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $targetShoppingList, array<string|int, ShoppingListEntryInterface$entries)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $targetShoppingList + + ShoppingListInterface + + - + + - +
+ $entries + + array<string|int, ShoppingListEntryInterface> + + - + + - +
+ + +
+

+ publicgetEntries() + +

+
+ BeforeMoveEntriesEvent.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntries() : array<string|int, ShoppingListEntryInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ShoppingListEntryInterface>

+ + +
+

+ publicgetTargetShoppingList() + +

+
+ BeforeMoveEntriesEvent.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTargetShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeRemoveEntriesEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeRemoveEntriesEvent.html new file mode 100644 index 0000000000..a1d293c96b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeRemoveEntriesEvent.html @@ -0,0 +1,737 @@ + + + + + BeforeRemoveEntriesEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BeforeRemoveEntriesEvent

+ +
+ BeforeRemoveEntriesEvent.php + : + 16 + +
+
Final
+ +
+ Extends BeforeEvent +
+ + + +
+

Event emitted before action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ BeforeRemoveEntriesEvent.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList, array<string|int, ShoppingListEntryInterface$entries[, ShoppingListInterface|null $shoppingListResult = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entries + + array<string|int, ShoppingListEntryInterface> + + - + + - +
+ $shoppingListResult + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetEntries() + +

+
+ BeforeRemoveEntriesEvent.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntries() : array<string|int, ShoppingListEntryInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ShoppingListEntryInterface>

+ + +
+

+ publicgetShoppingList() + +

+
+ BeforeRemoveEntriesEvent.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ BeforeRemoveEntriesEvent.php + : + 40 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publichasShoppingListResult() + +

+
+ BeforeRemoveEntriesEvent.php + : + 56 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasShoppingListResult() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetShoppingListResult() + +

+
+ BeforeRemoveEntriesEvent.php + : + 51 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setShoppingListResult(ShoppingListInterface|null $shoppingListResult) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingListResult + + ShoppingListInterface|null + + - + + - +
+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeUpdateShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeUpdateShoppingListEvent.html new file mode 100644 index 0000000000..93a90831cb --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-BeforeUpdateShoppingListEvent.html @@ -0,0 +1,737 @@ + + + + + BeforeUpdateShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ BeforeUpdateShoppingListEvent

+ +
+ BeforeUpdateShoppingListEvent.php + : + 16 + +
+
Final
+ +
+ Extends BeforeEvent +
+ + + +
+

Event emitted before action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ BeforeUpdateShoppingListEvent.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList, ShoppingListUpdateStruct $updateStruct[, ShoppingListInterface|null $shoppingListResult = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $updateStruct + + ShoppingListUpdateStruct + + - + + - +
+ $shoppingListResult + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetShoppingList() + +

+
+ BeforeUpdateShoppingListEvent.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ BeforeUpdateShoppingListEvent.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetUpdateStruct() + +

+
+ BeforeUpdateShoppingListEvent.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getUpdateStruct() : ShoppingListUpdateStruct
+
+
+
+
+
+

Return values

+

ShoppingListUpdateStruct

+ + +
+

+ publichasShoppingListResult() + +

+
+ BeforeUpdateShoppingListEvent.php + : + 50 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasShoppingListResult() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetShoppingListResult() + +

+
+ BeforeUpdateShoppingListEvent.php + : + 45 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setShoppingListResult(ShoppingListInterface|null $shoppingListResult) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingListResult + + ShoppingListInterface|null + + - + + - +
+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ClearShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ClearShoppingListEvent.html new file mode 100644 index 0000000000..1e970e4982 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ClearShoppingListEvent.html @@ -0,0 +1,569 @@ + + + + + ClearShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ClearShoppingListEvent

+ +
+ ClearShoppingListEvent.php + : + 14 + +
+
Final
+ +
+ Extends AfterEvent +
+ + +
+

Event emitted after action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ClearShoppingListEvent.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList, ShoppingListInterface $shoppingListResult)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $shoppingListResult + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicgetShoppingList() + +

+
+ ClearShoppingListEvent.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ ClearShoppingListEvent.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ +
+ +
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-CreateShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-CreateShoppingListEvent.html new file mode 100644 index 0000000000..2e6d4147a2 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-CreateShoppingListEvent.html @@ -0,0 +1,569 @@ + + + + + CreateShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ CreateShoppingListEvent

+ +
+ CreateShoppingListEvent.php + : + 15 + +
+
Final
+ +
+ Extends AfterEvent +
+ + +
+

Event emitted after action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ CreateShoppingListEvent.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListCreateStruct $createStruct, ShoppingListInterface $shoppingListResult)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $createStruct + + ShoppingListCreateStruct + + - + + - +
+ $shoppingListResult + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicgetCreateStruct() + +

+
+ CreateShoppingListEvent.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getCreateStruct() : ShoppingListCreateStruct
+
+
+
+
+
+

Return values

+

ShoppingListCreateStruct

+ + +
+

+ publicgetShoppingListResult() + +

+
+ CreateShoppingListEvent.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ +
+ +
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-DeleteShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-DeleteShoppingListEvent.html new file mode 100644 index 0000000000..1d211e6559 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-DeleteShoppingListEvent.html @@ -0,0 +1,513 @@ + + + + + DeleteShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ DeleteShoppingListEvent

+ +
+ DeleteShoppingListEvent.php + : + 14 + +
+
Final
+ +
+ Extends AfterEvent +
+ + +
+

Event emitted after action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ DeleteShoppingListEvent.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicgetShoppingList() + +

+
+ DeleteShoppingListEvent.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-MoveEntriesEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-MoveEntriesEvent.html new file mode 100644 index 0000000000..a83debe268 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-MoveEntriesEvent.html @@ -0,0 +1,569 @@ + + + + + MoveEntriesEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ MoveEntriesEvent

+ +
+ MoveEntriesEvent.php + : + 15 + +
+
Final
+ +
+ Extends AfterEvent +
+ + +
+

Event emitted after action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ MoveEntriesEvent.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $targetShoppingList, array<string|int, ShoppingListEntryInterface$entries)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $targetShoppingList + + ShoppingListInterface + + - + + - +
+ $entries + + array<string|int, ShoppingListEntryInterface> + + - + + - +
+ + +
+

+ publicgetEntries() + +

+
+ MoveEntriesEvent.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntries() : array<string|int, ShoppingListEntryInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ShoppingListEntryInterface>

+ + +
+

+ publicgetTargetShoppingList() + +

+
+ MoveEntriesEvent.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTargetShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-RemoveEntriesEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-RemoveEntriesEvent.html new file mode 100644 index 0000000000..67cee865d5 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-RemoveEntriesEvent.html @@ -0,0 +1,625 @@ + + + + + RemoveEntriesEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ RemoveEntriesEvent

+ +
+ RemoveEntriesEvent.php + : + 15 + +
+
Final
+ +
+ Extends AfterEvent +
+ + +
+

Event emitted after action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ RemoveEntriesEvent.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList, array<string|int, ShoppingListEntryInterface$entries, ShoppingListInterface $shoppingListResult)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entries + + array<string|int, ShoppingListEntryInterface> + + - + + - +
+ $shoppingListResult + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicgetEntries() + +

+
+ RemoveEntriesEvent.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntries() : array<string|int, ShoppingListEntryInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ShoppingListEntryInterface>

+ + +
+

+ publicgetShoppingList() + +

+
+ RemoveEntriesEvent.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ RemoveEntriesEvent.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ShoppingListResultAwareEventInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ShoppingListResultAwareEventInterface.html new file mode 100644 index 0000000000..ca970f429a --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-ShoppingListResultAwareEventInterface.html @@ -0,0 +1,459 @@ + + + + + ShoppingListResultAwareEventInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListResultAwareEventInterface

+ +
+ ShoppingListResultAwareEventInterface.php + : + 13 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetShoppingListResult() + +

+
+ ShoppingListResultAwareEventInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publichasShoppingListResult() + +

+
+ ShoppingListResultAwareEventInterface.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasShoppingListResult() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicsetShoppingListResult() + +

+
+ ShoppingListResultAwareEventInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setShoppingListResult(ShoppingListInterface|null $shoppingListResult) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingListResult + + ShoppingListInterface|null + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-UpdateShoppingListEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-UpdateShoppingListEvent.html new file mode 100644 index 0000000000..a0519cc896 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Event-UpdateShoppingListEvent.html @@ -0,0 +1,625 @@ + + + + + UpdateShoppingListEvent | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ UpdateShoppingListEvent

+ +
+ UpdateShoppingListEvent.php + : + 15 + +
+
Final
+ +
+ Extends AfterEvent +
+ + +
+

Event emitted after action execution.

+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ UpdateShoppingListEvent.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListInterface $shoppingList, ShoppingListUpdateStruct $updateStruct, ShoppingListInterface $shoppingListResult)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $updateStruct + + ShoppingListUpdateStruct + + - + + - +
+ $shoppingListResult + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicgetShoppingList() + +

+
+ UpdateShoppingListEvent.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetShoppingListResult() + +

+
+ UpdateShoppingListEvent.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingListResult() : ShoppingListInterface
+
+
+
+
+
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicgetUpdateStruct() + +

+
+ UpdateShoppingListEvent.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getUpdateStruct() : ShoppingListUpdateStruct
+
+
+
+
+
+

Return values

+

ShoppingListUpdateStruct

+ + +
+

+ publicisPropagationStopped() + +

+
+ Event.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isPropagationStopped() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+

+ publicstopPropagation() + +

+
+ Event.php + : + 47 + +
+
+

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().

+ +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Exception-ShoppingListEntryLimitExceededException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Exception-ShoppingListEntryLimitExceededException.html new file mode 100644 index 0000000000..47efaeda12 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Exception-ShoppingListEntryLimitExceededException.html @@ -0,0 +1,381 @@ + + + + + ShoppingListEntryLimitExceededException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListEntryLimitExceededException

+ +
+ ShoppingListEntryLimitExceededException.php + : + 13 + +
+
Final
+ +
+ Extends InvalidArgumentException +
+ + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ShoppingListEntryLimitExceededException.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(int $limit)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $limit + + int + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Exception-ShoppingListLimitExceededException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Exception-ShoppingListLimitExceededException.html new file mode 100644 index 0000000000..1ca0b393d1 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Exception-ShoppingListLimitExceededException.html @@ -0,0 +1,381 @@ + + + + + ShoppingListLimitExceededException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListLimitExceededException

+ +
+ ShoppingListLimitExceededException.php + : + 13 + +
+
Final
+ +
+ Extends InvalidArgumentException +
+ + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ShoppingListLimitExceededException.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(int $limit)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $limit + + int + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Form-ShoppingListFormFactoryInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Form-ShoppingListFormFactoryInterface.html new file mode 100644 index 0000000000..2272f8efa0 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Form-ShoppingListFormFactoryInterface.html @@ -0,0 +1,350 @@ + + + + + ShoppingListFormFactoryInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListFormFactoryInterface

+ +
+ ShoppingListFormFactoryInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publiccreateFilterForm() + +

+
+ ShoppingListFormFactoryInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public createFilterForm() : FormInterface<string|int, ShoppingListFilterInterface>
+
+
+
+
+
+

Return values

+

FormInterface<string|int, ShoppingListFilterInterface>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-AbstractShoppingListPolicy.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-AbstractShoppingListPolicy.html new file mode 100644 index 0000000000..9ae113c4ad --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-AbstractShoppingListPolicy.html @@ -0,0 +1,406 @@ + + + + + AbstractShoppingListPolicy | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ AbstractShoppingListPolicy

+ +
+ AbstractShoppingListPolicy.php + : + 13 + +
+
Abstract
+ + +
+ Implements + PolicyInterface
+ +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetModule() + +

+
+ AbstractShoppingListPolicy.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getModule() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetTargets() + +

+
+ AbstractShoppingListPolicy.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTargets() : array<string|int, ValueObject>
+
+
+
+
+
+

Return values

+

array<string|int, ValueObject>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Create.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Create.html new file mode 100644 index 0000000000..179e3147a0 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Create.html @@ -0,0 +1,557 @@ + + + + + Create | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Create

+ +
+ Create.php + : + 13 + +
+
Final
+ + + + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ Create.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([ShoppingListCreateStruct|null $shoppingListCreateStruct = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingListCreateStruct + + ShoppingListCreateStruct|null + + null + + - +
+ + +
+

+ publicgetFunction() + +

+
+ Create.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getFunction() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetModule() + +

+
+ AbstractShoppingListPolicy.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getModule() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetObject() + +

+
+ Create.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getObject() : ShoppingListCreateStruct|null
+
+
+
+
+
+

Return values

+

ShoppingListCreateStruct|null

+ + +
+

+ publicgetTargets() + +

+
+ AbstractShoppingListPolicy.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTargets() : array<string|int, ValueObject>
+
+
+
+
+
+

Return values

+

array<string|int, ValueObject>

+ + +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Delete.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Delete.html new file mode 100644 index 0000000000..6288e790c7 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Delete.html @@ -0,0 +1,557 @@ + + + + + Delete | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Delete

+ +
+ Delete.php + : + 13 + +
+
Final
+ + + + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ Delete.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([ShoppingListInterface|null $shoppingList = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetFunction() + +

+
+ Delete.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getFunction() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetModule() + +

+
+ AbstractShoppingListPolicy.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getModule() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetObject() + +

+
+ Delete.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getObject() : ShoppingListInterface|null
+
+
+
+
+
+

Return values

+

ShoppingListInterface|null

+ + +
+

+ publicgetTargets() + +

+
+ AbstractShoppingListPolicy.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTargets() : array<string|int, ValueObject>
+
+
+
+
+
+

Return values

+

array<string|int, ValueObject>

+ + +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Edit.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Edit.html new file mode 100644 index 0000000000..9d31f48efc --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-Edit.html @@ -0,0 +1,557 @@ + + + + + Edit | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Edit

+ +
+ Edit.php + : + 13 + +
+
Final
+ + + + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ Edit.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([ShoppingListInterface|null $shoppingList = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetFunction() + +

+
+ Edit.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getFunction() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetModule() + +

+
+ AbstractShoppingListPolicy.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getModule() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetObject() + +

+
+ Edit.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getObject() : ShoppingListInterface|null
+
+
+
+
+
+

Return values

+

ShoppingListInterface|null

+ + +
+

+ publicgetTargets() + +

+
+ AbstractShoppingListPolicy.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTargets() : array<string|int, ValueObject>
+
+
+
+
+
+

Return values

+

array<string|int, ValueObject>

+ + +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-View.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-View.html new file mode 100644 index 0000000000..f069494bbc --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Permission-Policy-ShoppingList-View.html @@ -0,0 +1,557 @@ + + + + + View | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ View

+ +
+ View.php + : + 13 + +
+
Final
+ + + + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ View.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([ShoppingListInterface|null $shoppingList = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface|null + + null + + - +
+ + +
+

+ publicgetFunction() + +

+
+ View.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getFunction() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetModule() + +

+
+ AbstractShoppingListPolicy.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getModule() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetObject() + +

+
+ View.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getObject() : ShoppingListInterface|null
+
+
+
+
+
+

Return values

+

ShoppingListInterface|null

+ + +
+

+ publicgetTargets() + +

+
+ AbstractShoppingListPolicy.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTargets() : array<string|int, ValueObject>
+
+
+
+
+
+

Return values

+

array<string|int, ValueObject>

+ + +
+
+
+ +
+
+ +
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Persistence-TransactionExecutorInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Persistence-TransactionExecutorInterface.html new file mode 100644 index 0000000000..276df15c14 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Persistence-TransactionExecutorInterface.html @@ -0,0 +1,409 @@ + + + + + TransactionExecutorInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ TransactionExecutorInterface

+ +
+ TransactionExecutorInterface.php + : + 13 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicexecute() + +

+
+ TransactionExecutorInterface.php + : + 28 + +
+
+

Executes the given operation within a transaction.

+ +
+ + + + + + + +
+
+
+
+
+
+
public execute(callable(): T $operation) : T
+
+
+
+
+
+
+

The transaction is automatically committed on success or rolled back on exception.

+ +
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $operation + + callable(): T + + - + +
+

The operation to execute within the transaction

+ +
+ +
+

Return values

+

T

+
+

The result of the operation

+ +
+ + +
+ Tags + + +
+
+
+ Throws +
+
+ Exception +
+

If the operation fails, the exception is re-thrown after rollback

+ +
+ +
+
+ +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Query-ShoppingListQueryBuilderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Query-ShoppingListQueryBuilderInterface.html new file mode 100644 index 0000000000..11c03eccfa --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Query-ShoppingListQueryBuilderInterface.html @@ -0,0 +1,377 @@ + + + + + ShoppingListQueryBuilderInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListQueryBuilderInterface

+ +
+ ShoppingListQueryBuilderInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicbuildQuery() + +

+
+ ShoppingListQueryBuilderInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public buildQuery(ShoppingListFilterInterface $filter) : ShoppingListQuery
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $filter + + ShoppingListFilterInterface + + - + + - +
+

Return values

+

ShoppingListQuery

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Query-ShoppingListSortClauseBuilderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Query-ShoppingListSortClauseBuilderInterface.html new file mode 100644 index 0000000000..11b109f6dd --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Query-ShoppingListSortClauseBuilderInterface.html @@ -0,0 +1,377 @@ + + + + + ShoppingListSortClauseBuilderInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListSortClauseBuilderInterface

+ +
+ ShoppingListSortClauseBuilderInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicbuildSortClauses() + +

+
+ ShoppingListSortClauseBuilderInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public buildSortClauses(ShoppingListFilterInterface $filter) : array<string|int, FieldValueSortClause>
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $filter + + ShoppingListFilterInterface + + - + + - +
+

Return values

+

array<string|int, FieldValueSortClause>

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceDecorator.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceDecorator.html new file mode 100644 index 0000000000..4df3da580f --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceDecorator.html @@ -0,0 +1,1169 @@ + + + + + ShoppingListServiceDecorator | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListServiceDecorator

+ +
+ ShoppingListServiceDecorator.php + : + 17 + +
+
Abstract
+ + + + +
+ + + + + + + + + + + + + +

+ Properties +

+ +
+

+ protected + $innerService + + +

+
+ ShoppingListServiceDecorator.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
protected ShoppingListServiceInterface $innerService
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ShoppingListServiceDecorator.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(ShoppingListServiceInterface $innerService)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $innerService + + ShoppingListServiceInterface + + - + + - +
+ + +
+

+ publicaddEntries() + +

+
+ ShoppingListServiceDecorator.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public addEntries(ShoppingListInterface $shoppingList, array<string|int, mixed> $entryAddStructs) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entryAddStructs + + array<string|int, mixed> + + - + + - +
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicclearShoppingList() + +

+
+ ShoppingListServiceDecorator.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public clearShoppingList(ShoppingListInterface $shoppingList) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+

Return values

+

ShoppingListInterface

+ + +
+

+ publiccreateShoppingList() + +

+
+ ShoppingListServiceDecorator.php + : + 31 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public createShoppingList(ShoppingListCreateStruct $createStruct) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $createStruct + + ShoppingListCreateStruct + + - + + - +
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicdeleteShoppingList() + +

+
+ ShoppingListServiceDecorator.php + : + 43 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public deleteShoppingList(ShoppingListInterface $shoppingList) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ + +
+

+ publicfindShoppingLists() + +

+
+ ShoppingListServiceDecorator.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public findShoppingLists([ShoppingListQuery|null $query = null ]) : ShoppingListCollectionInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $query + + ShoppingListQuery|null + + null + + - +
+

Return values

+

ShoppingListCollectionInterface

+ + +
+

+ publicgetOrCreateDefaultShoppingList() + +

+
+ ShoppingListServiceDecorator.php + : + 75 + +
+
+

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

+ + +
+

+ publicgetShoppingList() + +

+
+ ShoppingListServiceDecorator.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList(string $identifier) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $identifier + + string + + - + + - +
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicmoveEntries() + +

+
+ ShoppingListServiceDecorator.php + : + 67 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public moveEntries(ShoppingListInterface $targetShoppingList, array<string|int, mixed> $entries[, bool $copy = false ]) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $targetShoppingList + + ShoppingListInterface + + - + + - +
+ $entries + + array<string|int, mixed> + + - + + - +
+ $copy + + bool + + false + +
+

If true, copies entries without deleting from source. If false (default), moves entries (deletes from source).

+ +
+ +
+ + +
+

+ publicremoveEntries() + +

+
+ ShoppingListServiceDecorator.php + : + 60 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public removeEntries(ShoppingListInterface $shoppingList, array<string|int, mixed> $entries) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entries + + array<string|int, mixed> + + - + + - +
+

Return values

+

ShoppingListInterface

+ + +
+

+ publicupdateShoppingList() + +

+
+ ShoppingListServiceDecorator.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public updateShoppingList(ShoppingListInterface $shoppingList, ShoppingListUpdateStruct $updateStruct) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $updateStruct + + ShoppingListUpdateStruct + + - + + - +
+

Return values

+

ShoppingListInterface

+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html new file mode 100644 index 0000000000..afb8d22515 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html @@ -0,0 +1,1311 @@ + + + + + ShoppingListServiceInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListServiceInterface

+ +
+ ShoppingListServiceInterface.php + : + 22 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicaddEntries() + +

+
+ ShoppingListServiceInterface.php + : + 70 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public addEntries(ShoppingListInterface $shoppingList, array<string|int, EntryAddStruct$entryAddStructs) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entryAddStructs + + array<string|int, EntryAddStruct> + + - + + - +
+

Return values

+

ShoppingListInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException + +
+
+ Throws +
+
+ UnauthorizedException + +
+
+ +
+

+ publicclearShoppingList() + +

+
+ ShoppingListServiceInterface.php + : + 62 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public clearShoppingList(ShoppingListInterface $shoppingList) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+

Return values

+

ShoppingListInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ UnauthorizedException + +
+
+ +
+

+ publiccreateShoppingList() + +

+
+ ShoppingListServiceInterface.php + : + 42 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public createShoppingList(ShoppingListCreateStruct $createStruct) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $createStruct + + ShoppingListCreateStruct + + - + + - +
+

Return values

+

ShoppingListInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ UnauthorizedException + +
+
+ Throws +
+
+ InvalidArgumentException + +
+
+ +
+

+ publicdeleteShoppingList() + +

+
+ ShoppingListServiceInterface.php + : + 57 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public deleteShoppingList(ShoppingListInterface $shoppingList) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ +
+ Tags + + +
+
+
+ Throws +
+
+ UnauthorizedException + +
+
+ Throws +
+
+ InvalidArgumentException +
+

if trying to delete the default shopping list

+ +
+ +
+
+ +
+

+ publicfindShoppingLists() + +

+
+ ShoppingListServiceInterface.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public findShoppingLists([ShoppingListQuery|null $query = null ]) : ShoppingListCollectionInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $query + + ShoppingListQuery|null + + null + + - +
+

Return values

+

ShoppingListCollectionInterface

+ + +
+

+ publicgetEntry() + +

+
+ ShoppingListServiceInterface.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntry(string $identifier) : ShoppingListEntryInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $identifier + + string + + - + + - +
+

Return values

+

ShoppingListEntryInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ UnauthorizedException + +
+
+ Throws +
+
+ NotFoundException + +
+
+ +
+

+ publicgetOrCreateDefaultShoppingList() + +

+
+ ShoppingListServiceInterface.php + : + 106 + +
+
+

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 + + +
+
+
+ Throws +
+
+ UnauthorizedException + +
+
+ +
+

+ publicgetShoppingList() + +

+
+ ShoppingListServiceInterface.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingList(string $identifier) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $identifier + + string + + - + + - +
+

Return values

+

ShoppingListInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ UnauthorizedException + +
+
+ Throws +
+
+ NotFoundException + +
+
+ +
+

+ publicmoveEntries() + +

+
+ ShoppingListServiceInterface.php + : + 93 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public moveEntries(ShoppingListInterface $targetShoppingList, array<string|int, ShoppingListEntryInterface$entries[, bool $copy = false ]) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $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 + + +
+
+
+ Throws +
+
+ InvalidArgumentException + +
+
+ Throws +
+
+ UnauthorizedException + +
+
+ +
+

+ publicremoveEntries() + +

+
+ ShoppingListServiceInterface.php + : + 81 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public removeEntries(ShoppingListInterface $shoppingList, array<string|int, ShoppingListEntryInterface$entries) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $entries + + array<string|int, ShoppingListEntryInterface> + + - + + - +
+

Return values

+

ShoppingListInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException + +
+
+ Throws +
+
+ UnauthorizedException + +
+
+ +
+

+ publicupdateShoppingList() + +

+
+ ShoppingListServiceInterface.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public updateShoppingList(ShoppingListInterface $shoppingList, ShoppingListUpdateStruct $updateStruct) : ShoppingListInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $shoppingList + + ShoppingListInterface + + - + + - +
+ $updateStruct + + ShoppingListUpdateStruct + + - + + - +
+

Return values

+

ShoppingListInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ UnauthorizedException + +
+
+ Throws +
+
+ InvalidArgumentException + +
+
+ +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-EntryAddStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-EntryAddStruct.html new file mode 100644 index 0000000000..3a9dbffd9e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-EntryAddStruct.html @@ -0,0 +1,487 @@ + + + + + EntryAddStruct | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ EntryAddStruct

+ +
+ EntryAddStruct.php + : + 13 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ EntryAddStruct.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(string $productCode)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ + +
+

+ publicgetProductCode() + +

+
+ EntryAddStruct.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getProductCode() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicsetProductCode() + +

+
+ EntryAddStruct.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setProductCode(string $productCode) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-CreatedAtCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-CreatedAtCriterion.html new file mode 100644 index 0000000000..d78c863903 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-CreatedAtCriterion.html @@ -0,0 +1,1120 @@ + + + + + CreatedAtCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ CreatedAtCriterion

+ +
+ CreatedAtCriterion.php + : + 15 + +
+
Final
+ +
+ Extends FieldValueCriterion +
+ +
+ Implements + CriterionInterface
+ +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicCOMPARISON_CONTAINS +

+
+ FieldValueCriterion.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_CONTAINS = 'CONTAINS'
+
+
+
+ + +
+

+ publicCOMPARISON_ENDS_WITH +

+
+ FieldValueCriterion.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_ENDS_WITH = 'ENDS_WITH'
+
+
+
+ + +
+

+ publicCOMPARISON_EQ +

+
+ FieldValueCriterion.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_EQ = '='
+
+
+
+ + +
+

+ publicCOMPARISON_GT +

+
+ FieldValueCriterion.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GT = '>'
+
+
+
+ + +
+

+ publicCOMPARISON_GTE +

+
+ FieldValueCriterion.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GTE = '>='
+
+
+
+ + +
+

+ publicCOMPARISON_IN +

+
+ FieldValueCriterion.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_IN = 'IN'
+
+
+
+ + +
+

+ publicCOMPARISON_LT +

+
+ FieldValueCriterion.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LT = '<'
+
+
+
+ + +
+

+ publicCOMPARISON_LTE +

+
+ FieldValueCriterion.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LTE = '<='
+
+
+
+ + +
+

+ publicCOMPARISON_MEMBER_OF +

+
+ FieldValueCriterion.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_MEMBER_OF = 'MEMBER_OF'
+
+
+
+ + +
+

+ publicCOMPARISON_NEQ +

+
+ FieldValueCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NEQ = '<>'
+
+
+
+ + +
+

+ publicCOMPARISON_NIN +

+
+ FieldValueCriterion.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NIN = 'NIN'
+
+
+
+ + +
+

+ publicCOMPARISON_STARTS_WITH +

+
+ FieldValueCriterion.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_STARTS_WITH = 'STARTS_WITH'
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ CreatedAtCriterion.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(DateTimeInterface $value[, string|null $operator = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + DateTimeInterface + + - + + - +
+ $operator + + string|null + + null + + - +
+ + +
+

+ publicgetField() + +

+
+ FieldValueCriterion.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOperator() + +

+
+ FieldValueCriterion.php + : + 68 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOperator() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetValue() + +

+
+ FieldValueCriterion.php + : + 58 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getValue() : mixed
+
+
+
+
+
+ + +
+

+ publicsetOperator() + +

+
+ FieldValueCriterion.php + : + 63 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOperator(string $operator) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $operator + + string + + - + + - +
+ + +
+

+ publicsetValue() + +

+
+ FieldValueCriterion.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setValue(mixed $value) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + mixed + + - + + - +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-IsDefaultCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-IsDefaultCriterion.html new file mode 100644 index 0000000000..98dc76e130 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-IsDefaultCriterion.html @@ -0,0 +1,1106 @@ + + + + + IsDefaultCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ IsDefaultCriterion

+ +
+ IsDefaultCriterion.php + : + 14 + +
+
Final
+ +
+ Extends FieldValueCriterion +
+ +
+ Implements + CriterionInterface
+ +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicCOMPARISON_CONTAINS +

+
+ FieldValueCriterion.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_CONTAINS = 'CONTAINS'
+
+
+
+ + +
+

+ publicCOMPARISON_ENDS_WITH +

+
+ FieldValueCriterion.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_ENDS_WITH = 'ENDS_WITH'
+
+
+
+ + +
+

+ publicCOMPARISON_EQ +

+
+ FieldValueCriterion.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_EQ = '='
+
+
+
+ + +
+

+ publicCOMPARISON_GT +

+
+ FieldValueCriterion.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GT = '>'
+
+
+
+ + +
+

+ publicCOMPARISON_GTE +

+
+ FieldValueCriterion.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GTE = '>='
+
+
+
+ + +
+

+ publicCOMPARISON_IN +

+
+ FieldValueCriterion.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_IN = 'IN'
+
+
+
+ + +
+

+ publicCOMPARISON_LT +

+
+ FieldValueCriterion.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LT = '<'
+
+
+
+ + +
+

+ publicCOMPARISON_LTE +

+
+ FieldValueCriterion.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LTE = '<='
+
+
+
+ + +
+

+ publicCOMPARISON_MEMBER_OF +

+
+ FieldValueCriterion.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_MEMBER_OF = 'MEMBER_OF'
+
+
+
+ + +
+

+ publicCOMPARISON_NEQ +

+
+ FieldValueCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NEQ = '<>'
+
+
+
+ + +
+

+ publicCOMPARISON_NIN +

+
+ FieldValueCriterion.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NIN = 'NIN'
+
+
+
+ + +
+

+ publicCOMPARISON_STARTS_WITH +

+
+ FieldValueCriterion.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_STARTS_WITH = 'STARTS_WITH'
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ IsDefaultCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(bool $value)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + bool + + - + + - +
+ + +
+

+ publicgetField() + +

+
+ FieldValueCriterion.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOperator() + +

+
+ FieldValueCriterion.php + : + 68 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOperator() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetValue() + +

+
+ FieldValueCriterion.php + : + 58 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getValue() : mixed
+
+
+
+
+
+ + +
+

+ publicsetOperator() + +

+
+ FieldValueCriterion.php + : + 63 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOperator(string $operator) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $operator + + string + + - + + - +
+ + +
+

+ publicsetValue() + +

+
+ FieldValueCriterion.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setValue(mixed $value) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + mixed + + - + + - +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-LogicalAnd.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-LogicalAnd.html new file mode 100644 index 0000000000..8a7603ac8d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-LogicalAnd.html @@ -0,0 +1,635 @@ + + + + + LogicalAnd | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ LogicalAnd

+ +
+ LogicalAnd.php + : + 14 + +
+
Final
+ +
+ Extends LogicalAnd +
+ +
+ Implements + CriterionInterface
+ +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ AbstractCompositeCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(CriterionInterface ...$criteria)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + CriterionInterface + + - + + - +
+ + +
+

+ publicadd() + +

+
+ AbstractCompositeCriterion.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public add(CriterionInterface ...$criteria) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + CriterionInterface + + - + + - +
+ + +
+

+ publicgetCriteria() + +

+
+ AbstractCompositeCriterion.php + : + 47 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final getCriteria() : array<string|int, CriterionInterface>
+
+
+
+
+
+

Return values

+

array<string|int, CriterionInterface>

+ + +
+

+ publicremove() + +

+
+ AbstractCompositeCriterion.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public remove(CriterionInterface ...$criteria) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + CriterionInterface + + - + + - +
+ + +
+

+ publicsetCriteria() + +

+
+ AbstractCompositeCriterion.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setCriteria(CriterionInterface ...$criteria) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $criteria + + CriterionInterface + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-NameCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-NameCriterion.html new file mode 100644 index 0000000000..4133b55d40 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-NameCriterion.html @@ -0,0 +1,1106 @@ + + + + + NameCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ NameCriterion

+ +
+ NameCriterion.php + : + 14 + +
+
Final
+ +
+ Extends FieldValueCriterion +
+ +
+ Implements + CriterionInterface
+ +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicCOMPARISON_CONTAINS +

+
+ FieldValueCriterion.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_CONTAINS = 'CONTAINS'
+
+
+
+ + +
+

+ publicCOMPARISON_ENDS_WITH +

+
+ FieldValueCriterion.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_ENDS_WITH = 'ENDS_WITH'
+
+
+
+ + +
+

+ publicCOMPARISON_EQ +

+
+ FieldValueCriterion.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_EQ = '='
+
+
+
+ + +
+

+ publicCOMPARISON_GT +

+
+ FieldValueCriterion.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GT = '>'
+
+
+
+ + +
+

+ publicCOMPARISON_GTE +

+
+ FieldValueCriterion.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GTE = '>='
+
+
+
+ + +
+

+ publicCOMPARISON_IN +

+
+ FieldValueCriterion.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_IN = 'IN'
+
+
+
+ + +
+

+ publicCOMPARISON_LT +

+
+ FieldValueCriterion.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LT = '<'
+
+
+
+ + +
+

+ publicCOMPARISON_LTE +

+
+ FieldValueCriterion.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LTE = '<='
+
+
+
+ + +
+

+ publicCOMPARISON_MEMBER_OF +

+
+ FieldValueCriterion.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_MEMBER_OF = 'MEMBER_OF'
+
+
+
+ + +
+

+ publicCOMPARISON_NEQ +

+
+ FieldValueCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NEQ = '<>'
+
+
+
+ + +
+

+ publicCOMPARISON_NIN +

+
+ FieldValueCriterion.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NIN = 'NIN'
+
+
+
+ + +
+

+ publicCOMPARISON_STARTS_WITH +

+
+ FieldValueCriterion.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_STARTS_WITH = 'STARTS_WITH'
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ NameCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(string $value)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + string + + - + + - +
+ + +
+

+ publicgetField() + +

+
+ FieldValueCriterion.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOperator() + +

+
+ FieldValueCriterion.php + : + 68 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOperator() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetValue() + +

+
+ FieldValueCriterion.php + : + 58 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getValue() : mixed
+
+
+
+
+
+ + +
+

+ publicsetOperator() + +

+
+ FieldValueCriterion.php + : + 63 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOperator(string $operator) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $operator + + string + + - + + - +
+ + +
+

+ publicsetValue() + +

+
+ FieldValueCriterion.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setValue(mixed $value) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + mixed + + - + + - +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-OwnerCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-OwnerCriterion.html new file mode 100644 index 0000000000..b19833b4ed --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-OwnerCriterion.html @@ -0,0 +1,1106 @@ + + + + + OwnerCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ OwnerCriterion

+ +
+ OwnerCriterion.php + : + 16 + +
+
Final
+ +
+ Extends FieldValueCriterion +
+ +
+ Implements + CriterionInterface
+ +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicCOMPARISON_CONTAINS +

+
+ FieldValueCriterion.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_CONTAINS = 'CONTAINS'
+
+
+
+ + +
+

+ publicCOMPARISON_ENDS_WITH +

+
+ FieldValueCriterion.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_ENDS_WITH = 'ENDS_WITH'
+
+
+
+ + +
+

+ publicCOMPARISON_EQ +

+
+ FieldValueCriterion.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_EQ = '='
+
+
+
+ + +
+

+ publicCOMPARISON_GT +

+
+ FieldValueCriterion.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GT = '>'
+
+
+
+ + +
+

+ publicCOMPARISON_GTE +

+
+ FieldValueCriterion.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GTE = '>='
+
+
+
+ + +
+

+ publicCOMPARISON_IN +

+
+ FieldValueCriterion.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_IN = 'IN'
+
+
+
+ + +
+

+ publicCOMPARISON_LT +

+
+ FieldValueCriterion.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LT = '<'
+
+
+
+ + +
+

+ publicCOMPARISON_LTE +

+
+ FieldValueCriterion.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LTE = '<='
+
+
+
+ + +
+

+ publicCOMPARISON_MEMBER_OF +

+
+ FieldValueCriterion.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_MEMBER_OF = 'MEMBER_OF'
+
+
+
+ + +
+

+ publicCOMPARISON_NEQ +

+
+ FieldValueCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NEQ = '<>'
+
+
+
+ + +
+

+ publicCOMPARISON_NIN +

+
+ FieldValueCriterion.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NIN = 'NIN'
+
+
+
+ + +
+

+ publicCOMPARISON_STARTS_WITH +

+
+ FieldValueCriterion.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_STARTS_WITH = 'STARTS_WITH'
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ OwnerCriterion.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(UserReference|array<string|int, UserReference$value)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + UserReference|array<string|int, UserReference> + + - + + - +
+ + +
+

+ publicgetField() + +

+
+ FieldValueCriterion.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOperator() + +

+
+ FieldValueCriterion.php + : + 68 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOperator() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetValue() + +

+
+ FieldValueCriterion.php + : + 58 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getValue() : mixed
+
+
+
+
+
+ + +
+

+ publicsetOperator() + +

+
+ FieldValueCriterion.php + : + 63 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOperator(string $operator) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $operator + + string + + - + + - +
+ + +
+

+ publicsetValue() + +

+
+ FieldValueCriterion.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setValue(mixed $value) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + mixed + + - + + - +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-ProductCodeCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-ProductCodeCriterion.html new file mode 100644 index 0000000000..788c665d7b --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-ProductCodeCriterion.html @@ -0,0 +1,1106 @@ + + + + + ProductCodeCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ProductCodeCriterion

+ +
+ ProductCodeCriterion.php + : + 14 + +
+
Final
+ +
+ Extends FieldValueCriterion +
+ +
+ Implements + CriterionInterface
+ +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicCOMPARISON_CONTAINS +

+
+ FieldValueCriterion.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_CONTAINS = 'CONTAINS'
+
+
+
+ + +
+

+ publicCOMPARISON_ENDS_WITH +

+
+ FieldValueCriterion.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_ENDS_WITH = 'ENDS_WITH'
+
+
+
+ + +
+

+ publicCOMPARISON_EQ +

+
+ FieldValueCriterion.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_EQ = '='
+
+
+
+ + +
+

+ publicCOMPARISON_GT +

+
+ FieldValueCriterion.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GT = '>'
+
+
+
+ + +
+

+ publicCOMPARISON_GTE +

+
+ FieldValueCriterion.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GTE = '>='
+
+
+
+ + +
+

+ publicCOMPARISON_IN +

+
+ FieldValueCriterion.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_IN = 'IN'
+
+
+
+ + +
+

+ publicCOMPARISON_LT +

+
+ FieldValueCriterion.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LT = '<'
+
+
+
+ + +
+

+ publicCOMPARISON_LTE +

+
+ FieldValueCriterion.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LTE = '<='
+
+
+
+ + +
+

+ publicCOMPARISON_MEMBER_OF +

+
+ FieldValueCriterion.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_MEMBER_OF = 'MEMBER_OF'
+
+
+
+ + +
+

+ publicCOMPARISON_NEQ +

+
+ FieldValueCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NEQ = '<>'
+
+
+
+ + +
+

+ publicCOMPARISON_NIN +

+
+ FieldValueCriterion.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NIN = 'NIN'
+
+
+
+ + +
+

+ publicCOMPARISON_STARTS_WITH +

+
+ FieldValueCriterion.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_STARTS_WITH = 'STARTS_WITH'
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ProductCodeCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(string $productCode)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+ + +
+

+ publicgetField() + +

+
+ FieldValueCriterion.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOperator() + +

+
+ FieldValueCriterion.php + : + 68 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOperator() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetValue() + +

+
+ FieldValueCriterion.php + : + 58 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getValue() : mixed
+
+
+
+
+
+ + +
+

+ publicsetOperator() + +

+
+ FieldValueCriterion.php + : + 63 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOperator(string $operator) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $operator + + string + + - + + - +
+ + +
+

+ publicsetValue() + +

+
+ FieldValueCriterion.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setValue(mixed $value) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + mixed + + - + + - +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-UpdatedAtCriterion.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-UpdatedAtCriterion.html new file mode 100644 index 0000000000..f8766c53ca --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Criterion-UpdatedAtCriterion.html @@ -0,0 +1,1120 @@ + + + + + UpdatedAtCriterion | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ UpdatedAtCriterion

+ +
+ UpdatedAtCriterion.php + : + 15 + +
+
Final
+ +
+ Extends FieldValueCriterion +
+ +
+ Implements + CriterionInterface
+ +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicCOMPARISON_CONTAINS +

+
+ FieldValueCriterion.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_CONTAINS = 'CONTAINS'
+
+
+
+ + +
+

+ publicCOMPARISON_ENDS_WITH +

+
+ FieldValueCriterion.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_ENDS_WITH = 'ENDS_WITH'
+
+
+
+ + +
+

+ publicCOMPARISON_EQ +

+
+ FieldValueCriterion.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_EQ = '='
+
+
+
+ + +
+

+ publicCOMPARISON_GT +

+
+ FieldValueCriterion.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GT = '>'
+
+
+
+ + +
+

+ publicCOMPARISON_GTE +

+
+ FieldValueCriterion.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_GTE = '>='
+
+
+
+ + +
+

+ publicCOMPARISON_IN +

+
+ FieldValueCriterion.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_IN = 'IN'
+
+
+
+ + +
+

+ publicCOMPARISON_LT +

+
+ FieldValueCriterion.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LT = '<'
+
+
+
+ + +
+

+ publicCOMPARISON_LTE +

+
+ FieldValueCriterion.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_LTE = '<='
+
+
+
+ + +
+

+ publicCOMPARISON_MEMBER_OF +

+
+ FieldValueCriterion.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_MEMBER_OF = 'MEMBER_OF'
+
+
+
+ + +
+

+ publicCOMPARISON_NEQ +

+
+ FieldValueCriterion.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NEQ = '<>'
+
+
+
+ + +
+

+ publicCOMPARISON_NIN +

+
+ FieldValueCriterion.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_NIN = 'NIN'
+
+
+
+ + +
+

+ publicCOMPARISON_STARTS_WITH +

+
+ FieldValueCriterion.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed COMPARISON_STARTS_WITH = 'STARTS_WITH'
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ UpdatedAtCriterion.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(DateTimeInterface $value[, string|null $operator = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + DateTimeInterface + + - + + - +
+ $operator + + string|null + + null + + - +
+ + +
+

+ publicgetField() + +

+
+ FieldValueCriterion.php + : + 48 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOperator() + +

+
+ FieldValueCriterion.php + : + 68 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOperator() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetValue() + +

+
+ FieldValueCriterion.php + : + 58 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getValue() : mixed
+
+
+
+
+
+ + +
+

+ publicsetOperator() + +

+
+ FieldValueCriterion.php + : + 63 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOperator(string $operator) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $operator + + string + + - + + - +
+ + +
+

+ publicsetValue() + +

+
+ FieldValueCriterion.php + : + 53 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setValue(mixed $value) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $value + + mixed + + - + + - +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-CriterionInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-CriterionInterface.html new file mode 100644 index 0000000000..f103a31720 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-CriterionInterface.html @@ -0,0 +1,300 @@ + + + + + CriterionInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ CriterionInterface

+ +
+ CriterionInterface.php + : + 16 + +
+
Interface
+ +
+ Extends + CriterionInterface
+
+

Marker interface for Criterion classes, used to filter shopping lists.

+ + + + + + + + + + + + + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-DateRangeInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-DateRangeInterface.html new file mode 100644 index 0000000000..c5059610cb --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-DateRangeInterface.html @@ -0,0 +1,442 @@ + + + + + DateRangeInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ DateRangeInterface

+ +
+ DateRangeInterface.php + : + 13 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetMax() + +

+
+ DateRangeInterface.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getMax() : DateTimeInterface|null
+
+
+
+
+
+

Return values

+

DateTimeInterface|null

+ + +
+

+ publicgetMin() + +

+
+ DateRangeInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getMin() : DateTimeInterface|null
+
+
+
+
+
+

Return values

+

DateTimeInterface|null

+ + +
+

+ publicisEmpty() + +

+
+ DateRangeInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isEmpty() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-ShoppingListFilterInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-ShoppingListFilterInterface.html new file mode 100644 index 0000000000..a66b519ecd --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-ShoppingListFilterInterface.html @@ -0,0 +1,913 @@ + + + + + ShoppingListFilterInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListFilterInterface

+ +
+ ShoppingListFilterInterface.php + : + 11 + +
+
Interface
+ +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicIS_DEFAULT_ALL +

+
+ ShoppingListFilterInterface.php + : + 13 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed IS_DEFAULT_ALL = 'all'
+
+
+
+ + +
+

+ publicIS_DEFAULT_FALSE +

+
+ ShoppingListFilterInterface.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed IS_DEFAULT_FALSE = 'false'
+
+
+
+ + +
+

+ publicIS_DEFAULT_TRUE +

+
+ ShoppingListFilterInterface.php + : + 14 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed IS_DEFAULT_TRUE = 'true'
+
+
+
+ + +
+

+ publicSORT_CREATED_AT +

+
+ ShoppingListFilterInterface.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_CREATED_AT = 'created_at'
+
+
+
+ + +
+

+ publicSORT_DIRECTION_ASC +

+
+ ShoppingListFilterInterface.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_DIRECTION_ASC = 'asc'
+
+
+
+ + +
+

+ publicSORT_DIRECTION_DESC +

+
+ ShoppingListFilterInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_DIRECTION_DESC = 'desc'
+
+
+
+ + +
+

+ publicSORT_IS_DEFAULT +

+
+ ShoppingListFilterInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_IS_DEFAULT = 'is_default'
+
+
+
+ + +
+

+ publicSORT_NAME +

+
+ ShoppingListFilterInterface.php + : + 17 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_NAME = 'name'
+
+
+
+ + +
+

+ publicSORT_UPDATED_AT +

+
+ ShoppingListFilterInterface.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_UPDATED_AT = 'updated_at'
+
+
+
+ + + +

+ Methods +

+ +
+

+ publicgetCreatedAt() + +

+
+ ShoppingListFilterInterface.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getCreatedAt() : DateRangeInterface|null
+
+
+
+
+
+

Return values

+

DateRangeInterface|null

+ + +
+

+ publicgetIsDefault() + +

+
+ ShoppingListFilterInterface.php + : + 31 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getIsDefault() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetName() + +

+
+ ShoppingListFilterInterface.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getName() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publicgetSortDirection() + +

+
+ ShoppingListFilterInterface.php + : + 35 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getSortDirection() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetSortField() + +

+
+ ShoppingListFilterInterface.php + : + 33 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getSortField() : string|null
+
+
+
+
+
+

Return values

+

string|null

+ + +
+

+ publicgetUpdatedAt() + +

+
+ ShoppingListFilterInterface.php + : + 29 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getUpdatedAt() : DateRangeInterface|null
+
+
+
+
+
+

Return values

+

DateRangeInterface|null

+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-CreatedAt.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-CreatedAt.html new file mode 100644 index 0000000000..188e7f5e8e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-CreatedAt.html @@ -0,0 +1,703 @@ + + + + + CreatedAt | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ CreatedAt

+ +
+ CreatedAt.php + : + 13 + +
+
Final
+ +
+ Extends FieldValueSortClause +
+ + +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicSORT_ASC +

+
+ AbstractSortClause.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_ASC = SortDirection::ASC
+
+
+
+ + +
+

+ publicSORT_DESC +

+
+ AbstractSortClause.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_DESC = SortDirection::DESC
+
+
+
+ + + +

+ Properties +

+ +
+

+ public + $sortDirection + read-only + +

+
+ AbstractSortClause.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public string $sortDirection = self::SORT_ASC
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ CreatedAt.php + : + 15 + +
+
+

Constructs a new SortClause on $sortTarget in direction $sortDirection.

+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([string $sortDirection = \self::SORT_ASC ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $sortDirection + + string + + CreatedAt::SORT_ASC + +
+

one of SortDirection::ASC or SortDirection::DESC

+ +
+ +
+ + +
+

+ publicgetDirection() + +

+
+ AbstractSortClause.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final getDirection() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetField() + +

+
+ FieldValueSortClause.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicsetDirection() + +

+
+ AbstractSortClause.php + : + 47 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final setDirection(string $direction) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $direction + + string + + - + + - +
+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException +
+

if the given sort direction is invalid

+ +
+ +
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-IsDefault.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-IsDefault.html new file mode 100644 index 0000000000..f1773d3950 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-IsDefault.html @@ -0,0 +1,703 @@ + + + + + IsDefault | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ IsDefault

+ +
+ IsDefault.php + : + 13 + +
+
Final
+ +
+ Extends FieldValueSortClause +
+ + +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicSORT_ASC +

+
+ AbstractSortClause.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_ASC = SortDirection::ASC
+
+
+
+ + +
+

+ publicSORT_DESC +

+
+ AbstractSortClause.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_DESC = SortDirection::DESC
+
+
+
+ + + +

+ Properties +

+ +
+

+ public + $sortDirection + read-only + +

+
+ AbstractSortClause.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public string $sortDirection = self::SORT_ASC
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ IsDefault.php + : + 15 + +
+
+

Constructs a new SortClause on $sortTarget in direction $sortDirection.

+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([string $sortDirection = \self::SORT_ASC ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $sortDirection + + string + + IsDefault::SORT_ASC + +
+

one of SortDirection::ASC or SortDirection::DESC

+ +
+ +
+ + +
+

+ publicgetDirection() + +

+
+ AbstractSortClause.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final getDirection() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetField() + +

+
+ FieldValueSortClause.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicsetDirection() + +

+
+ AbstractSortClause.php + : + 47 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final setDirection(string $direction) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $direction + + string + + - + + - +
+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException +
+

if the given sort direction is invalid

+ +
+ +
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-Name.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-Name.html new file mode 100644 index 0000000000..0c645ea65c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-Name.html @@ -0,0 +1,703 @@ + + + + + Name | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ Name

+ +
+ Name.php + : + 13 + +
+
Final
+ +
+ Extends FieldValueSortClause +
+ + +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicSORT_ASC +

+
+ AbstractSortClause.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_ASC = SortDirection::ASC
+
+
+
+ + +
+

+ publicSORT_DESC +

+
+ AbstractSortClause.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_DESC = SortDirection::DESC
+
+
+
+ + + +

+ Properties +

+ +
+

+ public + $sortDirection + read-only + +

+
+ AbstractSortClause.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public string $sortDirection = self::SORT_ASC
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ Name.php + : + 15 + +
+
+

Constructs a new SortClause on $sortTarget in direction $sortDirection.

+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([string $sortDirection = \self::SORT_ASC ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $sortDirection + + string + + Name::SORT_ASC + +
+

one of SortDirection::ASC or SortDirection::DESC

+ +
+ +
+ + +
+

+ publicgetDirection() + +

+
+ AbstractSortClause.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final getDirection() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetField() + +

+
+ FieldValueSortClause.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicsetDirection() + +

+
+ AbstractSortClause.php + : + 47 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final setDirection(string $direction) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $direction + + string + + - + + - +
+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException +
+

if the given sort direction is invalid

+ +
+ +
+
+ +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-UpdatedAt.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-UpdatedAt.html new file mode 100644 index 0000000000..65f5864f8e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-SortClause-UpdatedAt.html @@ -0,0 +1,703 @@ + + + + + UpdatedAt | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ UpdatedAt

+ +
+ UpdatedAt.php + : + 13 + +
+
Final
+ +
+ Extends FieldValueSortClause +
+ + +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicSORT_ASC +

+
+ AbstractSortClause.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_ASC = SortDirection::ASC
+
+
+
+ + +
+

+ publicSORT_DESC +

+
+ AbstractSortClause.php + : + 19 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed SORT_DESC = SortDirection::DESC
+
+
+
+ + + +

+ Properties +

+ +
+

+ public + $sortDirection + read-only + +

+
+ AbstractSortClause.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public string $sortDirection = self::SORT_ASC
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ UpdatedAt.php + : + 15 + +
+
+

Constructs a new SortClause on $sortTarget in direction $sortDirection.

+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([string $sortDirection = \self::SORT_ASC ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $sortDirection + + string + + UpdatedAt::SORT_ASC + +
+

one of SortDirection::ASC or SortDirection::DESC

+ +
+ +
+ + +
+

+ publicgetDirection() + +

+
+ AbstractSortClause.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final getDirection() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetField() + +

+
+ FieldValueSortClause.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getField() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicsetDirection() + +

+
+ AbstractSortClause.php + : + 47 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public final setDirection(string $direction) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $direction + + string + + - + + - +
+ +
+ Tags + + +
+
+
+ Throws +
+
+ InvalidArgumentException +
+

if the given sort direction is invalid

+ +
+ +
+
+ +
+
+
+ +
+ +
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListCollectionInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListCollectionInterface.html new file mode 100644 index 0000000000..ee0e0202b9 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListCollectionInterface.html @@ -0,0 +1,395 @@ + + + + + ShoppingListCollectionInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListCollectionInterface

+ +
+ ShoppingListCollectionInterface.php + : + 17 + +
+
Interface
+ +
+ Extends + IteratorAggregate, Countable
+
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetShoppingLists() + +

+
+ ShoppingListCollectionInterface.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getShoppingLists() : array<string|int, ShoppingListInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ShoppingListInterface>

+ + +
+

+ publicgetTotalCount() + +

+
+ ShoppingListCollectionInterface.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTotalCount() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListCreateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListCreateStruct.html new file mode 100644 index 0000000000..7a42efba2d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListCreateStruct.html @@ -0,0 +1,610 @@ + + + + + ShoppingListCreateStruct | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListCreateStruct

+ +
+ ShoppingListCreateStruct.php + : + 14 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ShoppingListCreateStruct.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(string $name[, User|null $owner = null ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $name + + string + + - + + - +
+ $owner + + User|null + + null + + - +
+ + +
+

+ publicgetName() + +

+
+ ShoppingListCreateStruct.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getName() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOwner() + +

+
+ ShoppingListCreateStruct.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOwner() : User|null
+
+
+
+
+
+

Return values

+

User|null

+ + +
+

+ publicsetName() + +

+
+ ShoppingListCreateStruct.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setName(string $name) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $name + + string + + - + + - +
+ + +
+

+ publicsetOwner() + +

+
+ ShoppingListCreateStruct.php + : + 37 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOwner(User|null $owner) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $owner + + User|null + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListEntryCollectionInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListEntryCollectionInterface.html new file mode 100644 index 0000000000..aaf3ea2ead --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListEntryCollectionInterface.html @@ -0,0 +1,699 @@ + + + + + ShoppingListEntryCollectionInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListEntryCollectionInterface

+ +
+ ShoppingListEntryCollectionInterface.php + : + 18 + +
+
Interface
+ +
+ Extends + IteratorAggregate, Countable
+
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetEntries() + +

+
+ ShoppingListEntryCollectionInterface.php + : + 23 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntries() : array<string|int, ShoppingListEntryInterface>
+
+
+
+
+
+

Return values

+

array<string|int, ShoppingListEntryInterface>

+ + +
+

+ publicgetEntry() + +

+
+ ShoppingListEntryCollectionInterface.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntry(string $identifier) : ShoppingListEntryInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $identifier + + string + + - + + - +
+

Return values

+

ShoppingListEntryInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ NotFoundException + +
+
+ +
+

+ publicgetEntryWithProductCode() + +

+
+ ShoppingListEntryCollectionInterface.php + : + 39 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntryWithProductCode(string $productCode) : ShoppingListEntryInterface
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+

Return values

+

ShoppingListEntryInterface

+ +
+ Tags + + +
+
+
+ Throws +
+
+ NotFoundException + +
+
+ +
+

+ publicgetTotalCount() + +

+
+ ShoppingListEntryCollectionInterface.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getTotalCount() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publichasEntry() + +

+
+ ShoppingListEntryCollectionInterface.php + : + 27 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasEntry(string $identifier) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $identifier + + string + + - + + - +
+

Return values

+

bool

+ + +
+

+ publichasEntryWithProductCode() + +

+
+ ShoppingListEntryCollectionInterface.php + : + 34 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasEntryWithProductCode(string $productCode) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+

Return values

+

bool

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListEntryInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListEntryInterface.html new file mode 100644 index 0000000000..2de6a66caa --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListEntryInterface.html @@ -0,0 +1,476 @@ + + + + + ShoppingListEntryInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListEntryInterface

+ +
+ ShoppingListEntryInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetAddedAt() + +

+
+ ShoppingListEntryInterface.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getAddedAt() : DateTimeInterface
+
+
+
+
+
+

Return values

+

DateTimeInterface

+ + +
+

+ publicgetId() + +

+
+ ShoppingListEntryInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getId() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetIdentifier() + +

+
+ ShoppingListEntryInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getIdentifier() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetProduct() + +

+
+ ShoppingListEntryInterface.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getProduct() : ProductInterface
+
+
+
+
+
+

Return values

+

ProductInterface

+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListInterface.html new file mode 100644 index 0000000000..be626f174c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListInterface.html @@ -0,0 +1,713 @@ + + + + + ShoppingListInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListInterface

+ +
+ ShoppingListInterface.php + : + 14 + +
+
Interface
+ +
+ + + + + + + + + + + + + +

+ Methods +

+ +
+

+ publicgetCreatedAt() + +

+
+ ShoppingListInterface.php + : + 30 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getCreatedAt() : DateTimeInterface
+
+
+
+
+
+

Return values

+

DateTimeInterface

+ + +
+

+ publicgetEntries() + +

+
+ ShoppingListInterface.php + : + 26 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getEntries() : ShoppingListEntryCollectionInterface
+
+
+
+
+
+

Return values

+

ShoppingListEntryCollectionInterface

+ + +
+

+ publicgetId() + +

+
+ ShoppingListInterface.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getId() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetIdentifier() + +

+
+ ShoppingListInterface.php + : + 18 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getIdentifier() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetName() + +

+
+ ShoppingListInterface.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getName() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicgetOwner() + +

+
+ ShoppingListInterface.php + : + 24 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOwner() : User
+
+
+
+
+
+

Return values

+

User

+ + +
+

+ publicgetUpdatedAt() + +

+
+ ShoppingListInterface.php + : + 32 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getUpdatedAt() : DateTimeInterface
+
+
+
+
+
+

Return values

+

DateTimeInterface

+ + +
+

+ publichasProduct() + +

+
+ ShoppingListInterface.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public hasProduct(string $productCode) : bool
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $productCode + + string + + - + + - +
+

Return values

+

bool

+ + +
+

+ publicisDefault() + +

+
+ ShoppingListInterface.php + : + 22 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public isDefault() : bool
+
+
+
+
+
+

Return values

+

bool

+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListQuery.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListQuery.html new file mode 100644 index 0000000000..d1206a265e --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListQuery.html @@ -0,0 +1,838 @@ + + + + + ShoppingListQuery | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListQuery

+ +
+ ShoppingListQuery.php + : + 14 + +
+
Final
+ + + +
+ + + + + + + + + + + + +

+ Constants +

+
+

+ publicDEFAULT_LIMIT +

+
+ ShoppingListQuery.php + : + 16 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public mixed DEFAULT_LIMIT = 25
+
+
+
+ + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ShoppingListQuery.php + : + 21 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct([CriterionInterface|null $query = null ][, array<string|int, FieldValueSortClause$sortClauses = [] ][, int $offset = 0 ][, int $limit = \self::DEFAULT_LIMIT ])
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $query + + CriterionInterface|null + + null + + - +
+ $sortClauses + + array<string|int, FieldValueSortClause> + + [] + + - +
+ $offset + + int + + 0 + + - +
+ $limit + + int + + ShoppingListQuery::DEFAULT_LIMIT + + - +
+ + +
+

+ publicgetLimit() + +

+
+ ShoppingListQuery.php + : + 59 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getLimit() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetOffset() + +

+
+ ShoppingListQuery.php + : + 49 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getOffset() : int
+
+
+
+
+
+

Return values

+

int

+ + +
+

+ publicgetQuery() + +

+
+ ShoppingListQuery.php + : + 28 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getQuery() : CriterionInterface|null
+
+
+
+
+
+

Return values

+

CriterionInterface|null

+ + +
+

+ publicgetSortClauses() + +

+
+ ShoppingListQuery.php + : + 36 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getSortClauses() : array<string|int, FieldValueSortClause>
+
+
+
+
+
+

Return values

+

array<string|int, FieldValueSortClause>

+ + +
+

+ publicsetLimit() + +

+
+ ShoppingListQuery.php + : + 64 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setLimit(int $limit) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $limit + + int + + - + + - +
+ + +
+

+ publicsetOffset() + +

+
+ ShoppingListQuery.php + : + 54 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setOffset(int $offset) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $offset + + int + + - + + - +
+ + +
+

+ publicsetSortClauses() + +

+
+ ShoppingListQuery.php + : + 44 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setSortClauses(array<string|int, FieldValueSortClause$sortClauses) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $sortClauses + + array<string|int, FieldValueSortClause> + + - + + - +
+ + +
+
+
+ + +
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListUpdateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListUpdateStruct.html new file mode 100644 index 0000000000..f07ae6c98c --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-ShoppingListUpdateStruct.html @@ -0,0 +1,487 @@ + + + + + ShoppingListUpdateStruct | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
Copied!
+ + + +
+ +
+ +
+
+
+ + + + + + + + +
+
+
+ + + +
+
+ + +
+
+

+ ShoppingListUpdateStruct

+ +
+ ShoppingListUpdateStruct.php + : + 13 + +
+
Final
+ + + +
+ + + + + + + + + + + + + + +

+ Methods +

+ +
+

+ public__construct() + +

+
+ ShoppingListUpdateStruct.php + : + 15 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public __construct(string $name)
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $name + + string + + - + + - +
+ + +
+

+ publicgetName() + +

+
+ ShoppingListUpdateStruct.php + : + 20 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public getName() : string
+
+
+
+
+
+

Return values

+

string

+ + +
+

+ publicsetName() + +

+
+ ShoppingListUpdateStruct.php + : + 25 + +
+
+ +
+ + + + + + + +
+
+
+
+
+
+
public setName(string $name) : void
+
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + + + + + +
NameTypeDefault valueDescription
+ $name + + string + + - + + - +
+ + +
+
+
+ +
+
+
+ +
+
+
+
+
+
+ + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/index.html b/docs/api/php_api/php_api_reference/index.html index c3c015bf6b..07ece2d033 100644 --- a/docs/api/php_api/php_api_reference/index.html +++ b/docs/api/php_api/php_api_reference/index.html @@ -3711,6 +3711,17 @@ + +
  • + + +
  • + @@ -3720,6 +3731,41 @@ + +
  • + + + +
  • + @@ -11745,6 +11791,41 @@ + +
  • + + + +
  • + @@ -21288,8 +21369,8 @@ @@ -21299,8 +21380,8 @@ @@ -21309,6 +21390,17 @@
  • +
  • + + +
  • + +
  • - - EmbeddingResolverNotFoundException @@ -42751,6 +42843,906 @@
  • + ShoppingList + + + +
  • + + +
  • + +