diff --git a/code_samples/api/product_catalog/src/Command/ProductVariantCommand.php b/code_samples/api/product_catalog/src/Command/ProductVariantCommand.php index 3b685a7fc4..0a69ab3b9c 100644 --- a/code_samples/api/product_catalog/src/Command/ProductVariantCommand.php +++ b/code_samples/api/product_catalog/src/Command/ProductVariantCommand.php @@ -9,7 +9,9 @@ use Ibexa\Contracts\ProductCatalog\Local\LocalProductServiceInterface; use Ibexa\Contracts\ProductCatalog\Local\Values\Product\ProductVariantCreateStruct; use Ibexa\Contracts\ProductCatalog\ProductServiceInterface; +use Ibexa\Contracts\ProductCatalog\Values\Content\Query\Criterion\ProductCriterionAdapter; use Ibexa\Contracts\ProductCatalog\Values\Product\ProductVariantQuery; +use Ibexa\Contracts\ProductCatalog\Values\Product\Query\Criterion; use Symfony\Component\Console\Attribute\AsCommand; use Symfony\Component\Console\Command\Command; use Symfony\Component\Console\Input\InputArgument; @@ -46,12 +48,24 @@ protected function execute(InputInterface $input, OutputInterface $output): int $productCode = $input->getArgument('productCode'); $product = $this->productService->getProduct($productCode); - // Get variants - $variantQuery = new ProductVariantQuery(0, 5); + // Get variants filtered by variant codes + $codeQuery = new ProductVariantQuery(); + $codeQuery->setVariantCodes(['DESK-red', 'DESK-blue']); + $specificVariants = $this->productService->findProductVariants($product, $codeQuery)->getVariants(); - $variants = $this->productService->findProductVariants($product, $variantQuery)->getVariants(); + // Get variants with specific attributes + $combinedQuery = new ProductVariantQuery(); + $combinedQuery->setAttributesCriterion( + new ProductCriterionAdapter( + new Criterion\LogicalAnd([ + new Criterion\ColorAttribute('color', ['red', 'blue']), + new Criterion\IntegerAttribute('size', 42), + ]) + ) + ); + $filteredVariants = $this->productService->findProductVariants($product, $combinedQuery)->getVariants(); - foreach ($variants as $variant) { + foreach ($specificVariants as $variant) { $output->writeln($variant->getName()); $attributes = $variant->getDiscriminatorAttributes(); foreach ($attributes as $attribute) { @@ -61,12 +75,30 @@ protected function execute(InputInterface $input, OutputInterface $output): int // Create a variant $variantCreateStructs = [ - new ProductVariantCreateStruct(['color' => 'oak', 'frame_color' => 'white'], 'DESK1'), - new ProductVariantCreateStruct(['color' => 'white', 'frame_color' => 'black'], 'DESK2'), + new ProductVariantCreateStruct(['color' => 'oak', 'frame_color' => 'white'], 'DESK-red'), + new ProductVariantCreateStruct(['color' => 'white', 'frame_color' => 'black'], 'DESK-blue'), ]; $this->localProductService->createProductVariants($product, $variantCreateStructs); + // Search variants across all products + $query = new ProductVariantQuery(); + $query->setVariantCodes(['DESK-red', 'DESK-blue']); + $variantList = $this->productService->findVariants($query); + + foreach ($variantList->getVariants() as $variant) { + $output->writeln($variant->getName()); + } + + // Search variants with attribute criterion + $colorQuery = new ProductVariantQuery(); + $colorQuery->setAttributesCriterion( + new ProductCriterionAdapter( + new Criterion\ColorAttribute('color', ['red']) + ) + ); + $redVariants = $this->productService->findVariants($colorQuery); + return self::SUCCESS; } } diff --git a/code_samples/page/pagefield_layout.html.twig b/code_samples/page/pagefield_layout.html.twig new file mode 100644 index 0000000000..0eacab3fc5 --- /dev/null +++ b/code_samples/page/pagefield_layout.html.twig @@ -0,0 +1,22 @@ +
+ {# The required attribute for the displayed zone #} +
+ {# If a zone with [0] index contains any blocks #} + {% if zones[0].blocks %} + {# for each block #} + {% for block in blocks %} + {# create a new layer with appropriate ID #} +
+ {# render the block by using the "Ibexa\\Bundle\\FieldTypePage\\Controller\\BlockController::renderAction" controller #} + {# location.id is the ID of the Location of the current content item, block.id is the ID of the current block #} + {{ render_esi(controller('Ibexa\\Bundle\\FieldTypePage\\Controller\\BlockController::renderAction', { + 'locationId': locationId, + 'blockId': block.id, + 'versionNo': versionInfo.versionNo, + 'languageCode': field.languageCode + }, ibexa_append_cacheable_query_params(block))) }} +
+ {% endfor %} + {% endif %} +
+
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..6a4ee6cde4 --- /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..a6fd4e279e --- /dev/null +++ b/code_samples/shopping_list/add_to_shopping_list/templates/themes/standard/full/product.html.twig @@ -0,0 +1,57 @@ +{% 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..45f5b9bb77 --- /dev/null +++ b/code_samples/shopping_list/add_to_shopping_list/webpack.config.js @@ -0,0 +1,61 @@ +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'), + '@ibexa-admin-ui': path.resolve('./vendor/ibexa/admin-ui'), // @ibexa-admin-ui/…/text.helper dependency + }) + .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/schema.mysql.sql b/code_samples/shopping_list/install/schema.mysql.sql new file mode 100644 index 0000000000..3a26f10d8e --- /dev/null +++ b/code_samples/shopping_list/install/schema.mysql.sql @@ -0,0 +1,32 @@ +CREATE TABLE ibexa_shopping_list ( + id INT AUTO_INCREMENT NOT NULL, + owner_id INT NOT NULL, + identifier CHAR(36) NOT NULL COMMENT '(DC2Type:guid)', + name VARCHAR(190) DEFAULT NULL, + created_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)', + updated_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)', + is_default TINYINT(1) DEFAULT 0 NOT NULL, + UNIQUE INDEX ibexa_shopping_list_identifier_idx (identifier), + INDEX ibexa_shopping_list_owner_idx (owner_id), + INDEX ibexa_shopping_list_default_idx (is_default), + PRIMARY KEY(id) +) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB; +CREATE TABLE ibexa_shopping_list_entry ( + id INT AUTO_INCREMENT NOT NULL, + shopping_list_id INT NOT NULL, + product_code VARCHAR(64) NOT NULL, + identifier CHAR(36) NOT NULL COMMENT '(DC2Type:guid)', + added_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)', + UNIQUE INDEX ibexa_shopping_list_entry_identifier_idx (identifier), + INDEX ibexa_shopping_list_entry_list_idx (shopping_list_id), + INDEX ibexa_shopping_list_entry_product_idx (product_code), + INDEX ibexa_shopping_list_entry_added_at_idx (added_at), + UNIQUE INDEX ibexa_shopping_list_entry_unique (shopping_list_id, product_code), + PRIMARY KEY(id) +) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB; +ALTER TABLE ibexa_shopping_list + ADD CONSTRAINT ibexa_shopping_list_owner_fk FOREIGN KEY (owner_id) REFERENCES ibexa_user (contentobject_id) ON UPDATE CASCADE ON DELETE CASCADE; +ALTER TABLE ibexa_shopping_list_entry + ADD CONSTRAINT ibexa_shopping_list_entry_list_fk FOREIGN KEY (shopping_list_id) REFERENCES ibexa_shopping_list (id) ON UPDATE CASCADE ON DELETE CASCADE; +ALTER TABLE ibexa_shopping_list_entry + ADD CONSTRAINT ibexa_shopping_list_entry_product_fk FOREIGN KEY (product_code) REFERENCES ibexa_product (code) ON UPDATE CASCADE ON DELETE CASCADE; diff --git a/code_samples/shopping_list/install/schema.postgresql.sql b/code_samples/shopping_list/install/schema.postgresql.sql new file mode 100644 index 0000000000..f2c3e8f358 --- /dev/null +++ b/code_samples/shopping_list/install/schema.postgresql.sql @@ -0,0 +1,35 @@ +CREATE TABLE ibexa_shopping_list ( + id SERIAL NOT NULL, + owner_id INT NOT NULL, + identifier UUID NOT NULL, + name VARCHAR(190) DEFAULT NULL, + created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, + updated_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, + is_default BOOLEAN DEFAULT false NOT NULL, + PRIMARY KEY (id) +); +CREATE UNIQUE INDEX ibexa_shopping_list_identifier_idx ON ibexa_shopping_list (identifier); +CREATE INDEX ibexa_shopping_list_owner_idx ON ibexa_shopping_list (owner_id); +CREATE INDEX ibexa_shopping_list_default_idx ON ibexa_shopping_list (is_default); +COMMENT ON COLUMN ibexa_shopping_list.created_at IS '(DC2Type:datetime_immutable)'; +COMMENT ON COLUMN ibexa_shopping_list.updated_at IS '(DC2Type:datetime_immutable)'; +CREATE TABLE ibexa_shopping_list_entry ( + id SERIAL NOT NULL, + shopping_list_id INT NOT NULL, + product_code VARCHAR(64) NOT NULL, + identifier UUID NOT NULL, + added_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL, + PRIMARY KEY (id) +); +CREATE UNIQUE INDEX ibexa_shopping_list_entry_identifier_idx ON ibexa_shopping_list_entry (identifier); +CREATE INDEX ibexa_shopping_list_entry_list_idx ON ibexa_shopping_list_entry (shopping_list_id); +CREATE INDEX ibexa_shopping_list_entry_product_idx ON ibexa_shopping_list_entry (product_code); +CREATE INDEX ibexa_shopping_list_entry_added_at_idx ON ibexa_shopping_list_entry (added_at); +CREATE UNIQUE INDEX ibexa_shopping_list_entry_unique ON ibexa_shopping_list_entry (shopping_list_id, product_code); +COMMENT ON COLUMN ibexa_shopping_list_entry.added_at IS '(DC2Type:datetime_immutable)'; +ALTER TABLE ibexa_shopping_list + ADD CONSTRAINT ibexa_shopping_list_owner_fk FOREIGN KEY (owner_id) REFERENCES ibexa_user (contentobject_id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE; +ALTER TABLE ibexa_shopping_list_entry + ADD CONSTRAINT ibexa_shopping_list_entry_list_fk FOREIGN KEY (shopping_list_id) REFERENCES ibexa_shopping_list (id) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE; +ALTER TABLE ibexa_shopping_list_entry + ADD CONSTRAINT ibexa_shopping_list_entry_product_fk FOREIGN KEY (product_code) REFERENCES ibexa_product (code) ON UPDATE CASCADE ON DELETE CASCADE NOT DEFERRABLE INITIALLY IMMEDIATE; 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/ShoppingListFilterCommand.php b/code_samples/shopping_list/php_api/src/Command/ShoppingListFilterCommand.php new file mode 100644 index 0000000000..9001e099be --- /dev/null +++ b/code_samples/shopping_list/php_api/src/Command/ShoppingListFilterCommand.php @@ -0,0 +1,69 @@ +userService->loadUserByLogin($login); + $this->permissionResolver->setCurrentUserReference($user); + + $list = $this->shoppingListService->createShoppingList(new ShoppingListCreateStruct($name)); + + $list = $this->shoppingListService->addEntries($list, [new EntryAddStruct($desiredProductCodes[1])]); + + $filteredProductCodes = array_filter( + $desiredProductCodes, + static fn ($productCode): bool => !$list->getEntries()->hasEntryWithProductCode($productCode) + ); + $list = $this->shoppingListService->addEntries( + $list, + array_map( + static fn ($productCode): EntryAddStruct => new EntryAddStruct($productCode), + $filteredProductCodes + ) + ); + + $this->displayList($output, $list); + + $this->shoppingListService->deleteShoppingList($list); + + 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/Command/ShoppingListMoveCommand.php b/code_samples/shopping_list/php_api/src/Command/ShoppingListMoveCommand.php new file mode 100644 index 0000000000..8d02d055b5 --- /dev/null +++ b/code_samples/shopping_list/php_api/src/Command/ShoppingListMoveCommand.php @@ -0,0 +1,75 @@ +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])]); + + $entriesToRemove = []; + $entriesToAdd = []; + foreach ($movedProductCodes as $productCode) { + if ($sourceList->getEntries()->hasEntryWithProductCode($productCode)) { + $entriesToRemove[] = $sourceList->getEntries()->getEntryWithProductCode($productCode); + if (!$targetList->getEntries()->hasEntryWithProductCode($productCode)) { + $entriesToAdd[] = new EntryAddStruct($productCode); + } + } + } + $sourceList = $this->shoppingListService->removeEntries($sourceList, $entriesToRemove); + $targetList = $this->shoppingListService->addEntries($targetList, $entriesToAdd); + + $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..e65fce2e1d --- /dev/null +++ b/code_samples/shopping_list/php_api/src/Controller/CartShoppingListTransferController.php @@ -0,0 +1,96 @@ +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 $cartItem) { + if ($cartItem->getName() === $name) { + $cart = $cartItem; + break; + } + } + 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() > 0) { + $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)]); + + $entry = $list->getEntries()->getEntryWithProductCode($productCode)->getIdentifier(); // Get entry's automatically generated identifier + $cart = $this->cartShoppingListTransferService->addSelectedEntriesToCart($list, [$entry], $cart); + $cart = $this->cartShoppingListTransferService->addSelectedEntriesToCart($list, [$entry], $cart); + + dump( + $list->getEntries()->hasEntryWithProductCode($productCode), // true as the entry is copied and not moved + $cart->getEntries()->getEntryForProduct($this->productService->getProduct($productCode))->getQuantity() // 2 as the entry was added twice + ); + + $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/code_samples/shopping_list/search/criteria.php b/code_samples/shopping_list/search/criteria.php new file mode 100644 index 0000000000..18c0ae2429 --- /dev/null +++ b/code_samples/shopping_list/search/criteria.php @@ -0,0 +1,15 @@ +getCurrentUserReference()), + new Query\Criterion\IsDefaultCriterion(false) + ), + [ + new Query\SortClause\Name(), + ] +); diff --git a/code_samples/shopping_list/search/sort_clauses.php b/code_samples/shopping_list/search/sort_clauses.php new file mode 100644 index 0000000000..4927957c09 --- /dev/null +++ b/code_samples/shopping_list/search/sort_clauses.php @@ -0,0 +1,16 @@ +findShoppingLists( + new ShoppingListQuery( + null, + [ + new IsDefault(IsDefault::SORT_DESC), + new Name(), + ] + ) +); diff --git a/code_samples/shopping_list/shopping_list_rest_api.sh b/code_samples/shopping_list/shopping_list_rest_api.sh new file mode 100644 index 0000000000..416487a9e4 --- /dev/null +++ b/code_samples/shopping_list/shopping_list_rest_api.sh @@ -0,0 +1,48 @@ +BASE_URL='TODO' +CUSTOMER_USERNAME='admin' +CUSTOMER_PASSWORD='publish' +PRODUCT_CODE='TODO' + +# Log in and store CSRF Token +csrf_token=`curl -s -c cookie.txt -X 'POST' \ + "$BASE_URL/api/ibexa/v2/user/sessions" \ + -H 'accept: application/vnd.ibexa.api.Session+json' \ + -H 'Content-Type: application/vnd.ibexa.api.SessionInput+json' \ + -d "{ + \"SessionInput\": { + \"login\": \"$CUSTOMER_USERNAME\", + \"password\": \"$CUSTOMER_PASSWORD\" + } +}" | jq -r '.Session.csrfToken'` + +# Get default shopping list identifier if it exists +default_list_identifier=`curl -s -b cookie.txt -X 'GET' \ + "$BASE_URL/api/ibexa/v2/shopping-list?isDefault=true" \ + -H 'accept: application/vnd.ibexa.api.ShoppingListCollection+json' \ + | jq -r '.ShoppingListCollection.ShoppingList[0].identifier'` + +# Clear default shopping list +if [ "" != "$default_list_identifier" ]; then + curl -s -b cookie.txt -X 'POST' \ + "$BASE_URL/api/ibexa/v2/shopping-list/$default_list_identifier/clear" \ + -H 'accept: application/vnd.ibexa.api.ShoppingList+json' \ + -H "X-CSRF-Token: $csrf_token" | jq +fi + +# Add entries to the default shopping list, +# create it if it doesn't exist yet, +# and get the updated data +curl -s -b cookie.txt -X 'POST' \ + "$BASE_URL/api/ibexa/v2/shopping-list/default/entries" \ + -H 'accept: application/vnd.ibexa.api.ShoppingList+json' \ + -H "X-CSRF-Token: $csrf_token" \ + -H 'Content-Type: application/vnd.ibexa.api.ShoppingListEntriesAdd+json' \ + -d "{ + \"ShoppingListEntriesAdd\": { + \"entries\": [ + { + \"productCode\": \"$PRODUCT_CODE\" + } + ] + } +}" | jq diff --git a/composer.json b/composer.json index b6903fbca2..9ca8d6f290 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", "ibexa/cdp": "~5.0.x-dev" diff --git a/deptrac.baseline.yaml b/deptrac.baseline.yaml index 62fe56828f..c1f699e7fa 100644 --- a/deptrac.baseline.yaml +++ b/deptrac.baseline.yaml @@ -63,6 +63,9 @@ deptrac: App\Controller\PaginationController: - Ibexa\Bundle\Core\Controller - Ibexa\Core\Pagination\Pagerfanta\ContentSearchAdapter + App\Controller\ProductViewController: + - Ibexa\Core\MVC\Symfony\View\ContentView + - Ibexa\Core\MVC\Symfony\View\View App\Controller\RelationController: - Ibexa\Core\MVC\Symfony\View\View App\Controller\SvgController: diff --git a/docs/administration/back_office/back_office_configuration.md b/docs/administration/back_office/back_office_configuration.md index 87ad8601ee..b033144554 100644 --- a/docs/administration/back_office/back_office_configuration.md +++ b/docs/administration/back_office/back_office_configuration.md @@ -8,7 +8,7 @@ description: Configure default upload locations, pagination limits, and more set ## Pagination limits Default pagination limits for different sections of the back office can be defined through respective settings in -[`ezplatform_default_settings.yaml`](https://github.com/ibexa/admin-ui/blob/main/src/bundle/Resources/config/ezplatform_default_settings.yaml#L7) +[`ezplatform_default_settings.yaml`](https://github.com/ibexa/admin-ui/blob/main/src/bundle/Resources/config/ezplatform_default_settings.yaml#L7). You can set the pagination limit for user settings under the `ibexa.system..pagination_user` [configuration key](configuration.md#configuration-files): @@ -40,13 +40,49 @@ ibexa: catalogs_limit: 10 ``` -## Copy subtree limit +## Subtree operations + +### Copy subtree limit Copying large subtrees can cause performance issues, so you can limit the number of content items that can be copied at once by setting the `ibexa.system..subtree_operations.copy_subtree.limit` [configuration key](configuration.md#configuration-files). +The limit applies only to the UI of the back office and disables the "Copy subtree" operation. + The default value is `100`. You can set it to `-1` for no limit, or to `0` to completely disable copying subtrees. -You can copy a subtree by calling the following command in CLI: `bin/console ibexa:copy-subtree `. +To copy a subtree regardless of the limit, use the following console command: + +``` bash +php bin/console ibexa:copy-subtree +``` + +### Query subtree limit + +When working with large content trees, counting child items or calculating subtree sizes can cause significant performance degradation due to unbounded database queries. +You can limit these count operations by setting the `ibexa.system..subtree_operations.query_subtree.limit` [configuration key](configuration.md#configuration-files): + +``` yaml +ibexa: + system: + : + subtree_operations: + copy_subtree: + limit: 100 + query_subtree: + limit: 500 +``` + +The default value for `query_subtree.limit` is `500`. +You can set it to `-1` to disable the limit. + +This limit applies in some cases when the back office needs to determine if a location has children or calculate the number of items in a subtree. +The limit does not affect the sub-items list, which still displays all child elements in a paginated way. + +When a limit is set, the query stops after finding the specified number of items instead of performing a full count. +This significantly improves performance on locations with large numbers of children. +The resulting count is displayed with a `+` sign, indicating that the result is not exact. + +![Example of subtree count with exceeded limit](img/query_subtree_limit_locations_tab.png "Example of subtree count with exceeded limit") ## Default locations diff --git a/docs/administration/back_office/back_office_elements/custom_icons.md b/docs/administration/back_office/back_office_elements/custom_icons.md index 09b3836917..10aeb2e0d8 100644 --- a/docs/administration/back_office/back_office_elements/custom_icons.md +++ b/docs/administration/back_office/back_office_elements/custom_icons.md @@ -1,5 +1,5 @@ --- -month_change: true +month_change: false description: Configure custom icons to use for content types. --- diff --git a/docs/administration/back_office/img/query_subtree_limit_locations_tab.png b/docs/administration/back_office/img/query_subtree_limit_locations_tab.png new file mode 100644 index 0000000000..290406ecc8 Binary files /dev/null and b/docs/administration/back_office/img/query_subtree_limit_locations_tab.png differ diff --git a/docs/administration/project_organization/bundles.md b/docs/administration/project_organization/bundles.md index 9f937b035c..be3c393e9a 100644 --- a/docs/administration/project_organization/bundles.md +++ b/docs/administration/project_organization/bundles.md @@ -53,8 +53,9 @@ To remove a bundle (either one you created yourself, or an out-of-the-box one th |[ibexa/graphql](https://github.com/ibexa/graphql)|GraphQL server for [[= product_name =]]| |[ibexa/http-cache](https://github.com/ibexa/http-cache)|[HTTP cache handling](http_cache.md), using multi tagging| |[ibexa/i18n](https://github.com/ibexa/i18n)|Centralized translations to ease synchronization with Crowdin| +|[ibexa/messenger](https://github.com/ibexa/messenger)|[Background and asynchronous task processing](background_tasks.md) using Symfony Messenger| |[ibexa/notifications](https://github.com/ibexa/notifications)| Sending [notifications](notifications.md)| -|[ibexa/post-install](https://github.com/ibexa/post-install)|Post installation tool| +|[ibexa/post-install](https://github.com/ibexa/post-install)|Apache and nginx templates| |[ibexa/rest](https://github.com/ibexa/rest)|REST API| |[ibexa/search](https://github.com/ibexa/search)|Common search functionalities| |[ibexa/solr](https://github.com/ibexa/solr)|[Solr-powered](https://solr.apache.org/) search handler| @@ -131,3 +132,15 @@ To remove a bundle (either one you created yourself, or an out-of-the-box one th |ibexa/payment|Payment handling| |ibexa/shipping|Shipping handling| |ibexa/connector-payum|[Payum integration](payum_integration.md)| + +## Optional packages + +The following packages are optional and can be installed independently. + +|Bundle|Description| +|---------|-----------| +|[ibexa/automated-translation](https://github.com/ibexa/automated-translation)|Automated translation of content using [Google Translate or DeepL](automated_translations.md)| +|ibexa/cdp|Integration with the [Customer Data Platform](cdp.md)| +|[ibexa/cloud](https://github.com/ibexa/cloud)|Integration with [[[= product_name_cloud =]]](/ibexa_cloud/ibexa_cloud.md)| + +In addition, you can extend the capabitilies of your project by installing additional [LTS Updates](editions.md#lts-updates). 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..6385b36e9a --- /dev/null +++ b/docs/api/event_reference/shopping_list_events.md @@ -0,0 +1,23 @@ +--- +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. | 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-Cdp-Value-Webhook-Action-MembershipChange.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChange.html index 4b12975262..b96615826b 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChange.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-Action-MembershipChange.html @@ -244,7 +244,7 @@

MembershipChange.php : - 11 + 13
Read-only
@@ -279,7 +279,7 @@

MembershipChange.php : - 13 + 15
@@ -295,7 +295,7 @@

- 
public __construct(string $audienceId, string $personId, bool $membership)
+ 
public __construct(string $audienceId, string $personId, bool $membership[, PersonIdType $personIdType = new \Ibexa\Contracts\Cdp\Value\Webhook\PersonIdType(\Ibexa\Contracts\Cdp\Value\Webhook\PersonIdType::DEFAULT) ])
@@ -356,6 +356,20 @@

Parameters

- + + + + $personIdType + + + PersonIdType + + + new \Ibexa\Contracts\Cdp\Value\Webhook\PersonIdType(\Ibexa\Contracts\Cdp\Value\Webhook\PersonIdType::DEFAULT) + + + - + @@ -369,7 +383,7 @@

MembershipChange.php : - 20 + 23
@@ -406,7 +420,7 @@

MembershipChange.php : - 25 + 28
@@ -435,6 +449,43 @@

Return values

string

+
+

+ publicgetPersonIdType() + +

+
+ MembershipChange.php + : + 38 + +
+
+ +
+ + + + + + + +
+
+
+
+ 		+
+ 
public getPersonIdType() : PersonIdType
+
+
+
+
+
+

Return values

+

PersonIdType

+ +

publicisMembership() @@ -443,7 +494,7 @@

MembershipChange.php : - 30 + 33

@@ -506,6 +557,11 @@

Return values

getPersonId() + +
  • + + getPersonIdType() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-PersonIdType.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-PersonIdType.html new file mode 100644 index 0000000000..65dfe6cb5d --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Value-Webhook-PersonIdType.html @@ -0,0 +1,473 @@ + + + + + PersonIdType | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + PersonIdType

    + +
    + PersonIdType.php + : + 11 + +
    +
    Final
    + + + +
    + + + + + + + + + + + + +

    + Constants +

    +
    +

    + publicDEFAULT +

    +
    + PersonIdType.php + : + 13 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public mixed DEFAULT = 'user-id'
    +
    +
    +
    + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + PersonIdType.php + : + 17 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public __construct(string $value)
    +
    +
    +
    +
    +
    +

    Parameters

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

    + publicgetValue() + +

    +
    + PersonIdType.php + : + 22 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getValue() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Webhook-PersonIdResolverInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Webhook-PersonIdResolverInterface.html new file mode 100644 index 0000000000..2feea0dac3 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Cdp-Webhook-PersonIdResolverInterface.html @@ -0,0 +1,488 @@ + + + + + PersonIdResolverInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + PersonIdResolverInterface

    + +
    + PersonIdResolverInterface.php + : + 14 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicgetType() + +

    +
    + PersonIdResolverInterface.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getType() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicresolve() + +

    +
    + PersonIdResolverInterface.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public resolve(string $personId) : User
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $personId + + string + + - + + - +
    +

    Return values

    +

    User

    + + +
    +

    + publicsupports() + +

    +
    + PersonIdResolverInterface.php + : + 18 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public supports(PersonIdType $type) : bool
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $type + + PersonIdType + + - + + - +
    +

    Return values

    +

    bool

    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html index f820a5404f..c79ba447b9 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Ibexa.html @@ -278,7 +278,7 @@

    - 
    public mixed VERSION = '5.0.5'
    + 
    public mixed VERSION = '5.0.6'
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Content-Location-Handler.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Content-Location-Handler.html index e6a0ecf5b4..3b0f237a38 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Content-Location-Handler.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Content-Location-Handler.html @@ -726,7 +726,7 @@

    - 
    public getSubtreeSize(string $path) : int
    + 
    public getSubtreeSize(string $path[, int|null $limit = null ]) : int
    @@ -759,6 +759,20 @@

    Parameters

    - + + + + $limit + + + int|null + + + null + + + - + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Filter-Query-CountQueryBuilder.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Filter-Query-CountQueryBuilder.html new file mode 100644 index 0000000000..0ad56f5f0a --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Persistence-Filter-Query-CountQueryBuilder.html @@ -0,0 +1,412 @@ + + + + + CountQueryBuilder | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + CountQueryBuilder

    + +
    + CountQueryBuilder.php + : + 13 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicwrap() + +

    +
    + CountQueryBuilder.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public wrap(QueryBuilder $queryBuilder, string $countableField[, int|null $limit = null ]) : QueryBuilder
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $queryBuilder + + QueryBuilder + + - + + - +
    + $countableField + + string + + - + + - +
    + $limit + + int|null + + null + + - +
    +

    Return values

    +

    QueryBuilder

    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html index e4e3874525..7802de4f8c 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-ContentService.html @@ -551,7 +551,7 @@

    ContentService.php : - 534 + 537
    @@ -568,7 +568,7 @@

    - 
    public count(Filter $filter[, array<string|int, mixed>|null $languages = null ]) : int
    + 
    public count(Filter $filter[, array<string|int, mixed>|null $languages = null ][, int|null $limit = null ]) : int
    @@ -619,6 +619,25 @@

    Parameters

    - + + + + $limit + + + int|null + + + null + + +
    +

    If set, the count will be limited to first $limit items found. +In some cases it can significantly speed up a count operation for more complex filters.

    + +
    + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-ContentServiceDecorator.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-ContentServiceDecorator.html index 612345be60..38efb414dd 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-ContentServiceDecorator.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-ContentServiceDecorator.html @@ -590,7 +590,7 @@

    - 
    public count(Filter $filter[, array<string|int, mixed>|null $languages = null ]) : int
    + 
    public count(Filter $filter[, array<string|int, mixed>|null $languages = null ][, int|null $limit = null ]) : int
    @@ -641,6 +641,25 @@

    Parameters

    - + + + + $limit + + + int|null + + + null + + +
    +

    If set, the count will be limited to first $limit items found. +In some cases it can significantly speed up a count operation for more complex filters.

    + +
    + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-LocationServiceDecorator.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-LocationServiceDecorator.html index c61287b8d6..d846f79810 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-LocationServiceDecorator.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Decorator-LocationServiceDecorator.html @@ -491,7 +491,7 @@

    - 
    public count(Filter $filter[, array<string|int, mixed>|null $languages = null ]) : int
    + 
    public count(Filter $filter[, array<string|int, mixed>|null $languages = null ][, int|null $limit = null ]) : int
    @@ -545,6 +545,25 @@

    Parameters

    If skipped, by default, unless SiteAccessAware layer has been disabled, languages set for a SiteAccess in a current context will be used.

    + + + + + + + $limit + + + int|null + + + null + + +
    +

    If set, the count will be limited to first $limit items found. +In some cases it can significantly speed up a count operation for more complex filters.

    +
    @@ -855,7 +874,7 @@

    - 
    public getLocationChildCount(Location $location) : int
    + 
    public getLocationChildCount(Location $location[, int|null $limit = null ]) : int
    @@ -888,6 +907,24 @@

    Parameters

    - + + + + $limit + + + int|null + + + null + + +
    +

    If set, the count will be limited to first $limit items found.

    + +
    + + @@ -920,7 +957,7 @@

    - 
    public getSubtreeSize(Location $location) : int
    + 
    public getSubtreeSize(Location $location[, int|null $limit = null ]) : int
    @@ -957,6 +994,20 @@

    Parameters

    - + + + + $limit + + + int|null + + + null + + + - + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html index f4c5c15b14..08777b7382 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-LocationService.html @@ -403,7 +403,7 @@

    LocationService.php : - 284 + 289
    @@ -420,7 +420,7 @@

    - 
    public count(Filter $filter[, array<int, string>|null $languages = null ]) : int
    + 
    public count(Filter $filter[, array<int, string>|null $languages = null ][, int|null $limit = null ]) : int
    @@ -474,6 +474,25 @@

    Parameters

    If skipped, by default, unless SiteAccessAware layer has been disabled, languages set for a SiteAccess in a current context will be used.

    + + + + + + + $limit + + + int|null + + + null + + +
    +

    If set, the count will be limited to first $limit items found. +In some cases it can significantly speed up a count operation for more complex filters.

    +
    @@ -492,7 +511,7 @@

    LocationService.php : - 151 + 154
    @@ -607,7 +626,7 @@

    LocationService.php : - 225 + 228
    @@ -688,7 +707,7 @@

    LocationService.php : - 271 + 274
    @@ -773,7 +792,7 @@

    LocationService.php : - 250 + 253
    @@ -816,7 +835,7 @@

    LocationService.php : - 129 + 130
    @@ -833,7 +852,7 @@

    - 
    public getLocationChildCount(Location $location) : int
    + 
    public getLocationChildCount(Location $location[, int|null $limit = null ]) : int
    @@ -866,6 +885,24 @@

    Parameters

    - + + + + $limit + + + int|null + + + null + + +
    +

    If set, the count will be limited to first $limit items found.

    + +
    + + @@ -881,7 +918,7 @@

    LocationService.php : - 136 + 139
    @@ -898,7 +935,7 @@

    - 
    public getSubtreeSize(Location $location) : int
    + 
    public getSubtreeSize(Location $location[, int|null $limit = null ]) : int
    @@ -935,6 +972,20 @@

    Parameters

    - + + + + $limit + + + int|null + + + null + + + - + @@ -950,7 +1001,7 @@

    LocationService.php : - 185 + 188
    @@ -1038,7 +1089,7 @@

    LocationService.php : - 260 + 263
    @@ -1820,7 +1871,7 @@

    LocationService.php : - 216 + 219
    @@ -1964,7 +2015,7 @@

    LocationService.php : - 234 + 237
    @@ -2033,7 +2084,7 @@

    LocationService.php : - 241 + 244
    @@ -2071,7 +2122,7 @@

    LocationService.php : - 174 + 177
    @@ -2166,7 +2217,7 @@

    LocationService.php : - 199 + 202
    @@ -2259,7 +2310,7 @@

    LocationService.php : - 164 + 167
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Search-AggregationResultCollection.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Search-AggregationResultCollection.html index e38fe836f8..f047ccab5c 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Search-AggregationResultCollection.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Search-AggregationResultCollection.html @@ -728,7 +728,7 @@

    - 
    public toArray() : array<string|int, FieldDefinition>
    + 
    public toArray() : array<string|int, AggregationResult>
    @@ -738,7 +738,7 @@

    Return values

    -

    array<string|int, FieldDefinition>

    +

    array<string|int, AggregationResult>

    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderExceptionInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderExceptionInterface.html new file mode 100644 index 0000000000..859b8fc1dd --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderExceptionInterface.html @@ -0,0 +1,298 @@ + + + + + EmbeddingProviderExceptionInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + EmbeddingProviderExceptionInterface

    + +
    + EmbeddingProviderExceptionInterface.php + : + 13 + +
    +
    Interface
    + +
    + Extends + Throwable
    +
    + + + + + + + + + + + + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderInterface.html index 4ce3c5987a..2839bf7d14 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderInterface.html @@ -270,7 +270,7 @@

    EmbeddingProviderInterface.php : - 16 + 18
    @@ -352,7 +352,21 @@

    Parameters

    Return values

    array<string|int, float>

    - + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + EmbeddingProviderExceptionInterface + +
    +
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderResolverInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderResolverInterface.html index c73bcc6275..0ef62f309b 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderResolverInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Search-Embedding-EmbeddingProviderResolverInterface.html @@ -302,6 +302,84 @@
    Tags +
    +
    +
    + Throws +
    +
    + EmbeddingResolverNotFoundException + +
    +
    + +
    +

    + publicresolveByModelIdentifier() + +

    +
    + EmbeddingProviderResolverInterface.php + : + 21 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public resolveByModelIdentifier(string $modelIdentifier) : EmbeddingProviderInterface
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $modelIdentifier + + string + + - + + - +
    +

    Return values

    +

    EmbeddingProviderInterface

    + +
    + Tags + +
    @@ -337,6 +415,11 @@
    resolve() +
    • +
  • + + resolveByModelIdentifier() +
    • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeAddress-Event-MapFieldEvent.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeAddress-Event-MapFieldEvent.html index 3ef2d9f5a6..faa9506a32 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeAddress-Event-MapFieldEvent.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeAddress-Event-MapFieldEvent.html @@ -237,7 +237,7 @@

    MapFieldEvent.php : - 13 + 14
    Final
    @@ -282,7 +282,7 @@

    MapFieldEvent.php : - 22 + 24
    @@ -372,7 +372,7 @@

    MapFieldEvent.php : - 34 + 36
    @@ -409,7 +409,7 @@

    MapFieldEvent.php : - 39 + 41
    @@ -446,7 +446,7 @@

    MapFieldEvent.php : - 29 + 31
    @@ -483,7 +483,7 @@

    MapFieldEvent.php : - 54 + 62
    @@ -520,7 +520,7 @@

    MapFieldEvent.php : - 67 + 75
    @@ -557,7 +557,7 @@

    MapFieldEvent.php : - 44 + 49
    @@ -631,7 +631,7 @@

    MapFieldEvent.php : - 59 + 67
    @@ -693,7 +693,7 @@

    MapFieldEvent.php : - 80 + 88
    @@ -769,7 +769,7 @@

    MapFieldEvent.php : - 75 + 83
    @@ -831,7 +831,7 @@

    MapFieldEvent.php : - 49 + 57
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html index ee27d836fa..f96090c711 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-BlockDefinition.html @@ -308,6 +308,41 @@

    +
    +

    + protected + $cacheableQueryParams + + +

    +
    + BlockDefinition.php + : + 38 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    protected array<string|int, string> $cacheableQueryParams = []
    +
    +
    +
    + +

    protected @@ -567,7 +602,7 @@

    BlockDefinition.php : - 109 + 112

    @@ -631,7 +666,7 @@

    BlockDefinition.php : - 96 + 99
    @@ -660,6 +695,43 @@

    Return values

    array<string, BlockAttributeDefinition>

    +
    +

    + publicgetCacheableQueryParams() + +

    +
    + BlockDefinition.php + : + 140 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getCacheableQueryParams() : array<string|int, string>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string|int, string>

    + +

    publicgetCategory() @@ -668,7 +740,7 @@

    BlockDefinition.php : - 57 + 60

    @@ -705,7 +777,7 @@

    BlockDefinition.php : - 114 + 117
    @@ -742,7 +814,7 @@

    BlockDefinition.php : - 37 + 40
    @@ -779,7 +851,7 @@

    BlockDefinition.php : - 47 + 50
    @@ -816,7 +888,7 @@

    BlockDefinition.php : - 67 + 70
    @@ -853,7 +925,7 @@

    BlockDefinition.php : - 80 + 83
    @@ -890,7 +962,7 @@

    BlockDefinition.php : - 124 + 127
    @@ -927,7 +999,7 @@

    BlockDefinition.php : - 104 + 107
    @@ -981,6 +1053,68 @@

    Parameters

    +
    +

    + publicsetCacheableQueryParams() + +

    +
    + BlockDefinition.php + : + 148 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public setCacheableQueryParams(array<string|int, string> $cacheableQueryParams) : void
    +
    +
    +
    +
    +
    +

    Parameters

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

    publicsetCategory() @@ -989,7 +1123,7 @@

    BlockDefinition.php : - 62 + 65

    @@ -1051,7 +1185,7 @@

    BlockDefinition.php : - 119 + 122
    @@ -1113,7 +1247,7 @@

    BlockDefinition.php : - 42 + 45
    @@ -1175,7 +1309,7 @@

    BlockDefinition.php : - 52 + 55
    @@ -1237,7 +1371,7 @@

    BlockDefinition.php : - 72 + 75
    @@ -1299,7 +1433,7 @@

    BlockDefinition.php : - 88 + 91
    @@ -1361,7 +1495,7 @@

    BlockDefinition.php : - 129 + 132
    @@ -1439,6 +1573,11 @@

    Parameters

    attributes + +
  • + + cacheableQueryParams +
  • @@ -1493,6 +1632,11 @@

    Parameters

     getAttributes() +
    • +
  • + + getCacheableQueryParams() +
  • @@ -1533,6 +1677,11 @@

    Parameters

     setAttributes() +
    • +
  • + + setCacheableQueryParams() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html index 02b314280a..966980f97d 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypePage-FieldType-Page-Block-Definition-ReactBlockDefinition.html @@ -312,6 +312,41 @@

    +
    +

    + protected + $cacheableQueryParams + + +

    +
    + BlockDefinition.php + : + 38 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    protected array<string|int, string> $cacheableQueryParams = []
    +
    +
    +
    + +

    protected @@ -606,7 +641,7 @@

    BlockDefinition.php : - 109 + 112

    @@ -670,7 +705,7 @@

    BlockDefinition.php : - 96 + 99
    @@ -699,6 +734,43 @@

    Return values

    array<string, BlockAttributeDefinition>

    +
    +

    + publicgetCacheableQueryParams() + +

    +
    + BlockDefinition.php + : + 140 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getCacheableQueryParams() : array<string|int, string>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string|int, string>

    + +

    publicgetCategory() @@ -707,7 +779,7 @@

    BlockDefinition.php : - 57 + 60

    @@ -781,7 +853,7 @@

    BlockDefinition.php : - 114 + 117
    @@ -818,7 +890,7 @@

    BlockDefinition.php : - 37 + 40
    @@ -855,7 +927,7 @@

    BlockDefinition.php : - 47 + 50
    @@ -892,7 +964,7 @@

    BlockDefinition.php : - 67 + 70
    @@ -929,7 +1001,7 @@

    BlockDefinition.php : - 80 + 83
    @@ -966,7 +1038,7 @@

    BlockDefinition.php : - 124 + 127
    @@ -1003,7 +1075,7 @@

    BlockDefinition.php : - 104 + 107
    @@ -1057,6 +1129,68 @@

    Parameters

    +
    +

    + publicsetCacheableQueryParams() + +

    +
    + BlockDefinition.php + : + 148 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public setCacheableQueryParams(array<string|int, string> $cacheableQueryParams) : void
    +
    +
    +
    +
    +
    +

    Parameters

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

    publicsetCategory() @@ -1065,7 +1199,7 @@

    BlockDefinition.php : - 62 + 65

    @@ -1189,7 +1323,7 @@

    BlockDefinition.php : - 119 + 122
    @@ -1251,7 +1385,7 @@

    BlockDefinition.php : - 42 + 45
    @@ -1313,7 +1447,7 @@

    BlockDefinition.php : - 52 + 55
    @@ -1375,7 +1509,7 @@

    BlockDefinition.php : - 72 + 75
    @@ -1437,7 +1571,7 @@

    BlockDefinition.php : - 88 + 91
    @@ -1499,7 +1633,7 @@

    BlockDefinition.php : - 129 + 132
    @@ -1577,6 +1711,11 @@

    Parameters

    attributes +
    • +
  • + + cacheableQueryParams +
  • @@ -1636,6 +1775,11 @@

    Parameters

     getAttributes() +
    • +
  • + + getCacheableQueryParams() +
  • @@ -1681,6 +1825,11 @@

    Parameters

     setAttributes() +
    • +
  • + + setCacheableQueryParams() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeRichTextRTE-ToS-Status.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeRichTextRTE-ToS-Status.html index 83ea20f8c6..56eb6dee29 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeRichTextRTE-ToS-Status.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-FieldTypeRichTextRTE-ToS-Status.html @@ -270,10 +270,11 @@

    Status.php : - 54 + 48
    +

    Returns the number of days left in the grace period.

    @@ -295,30 +296,27 @@

    -

    Return values

    -

    int|null

    - -
    - Tags - - -
    -
    -
    - Ignore -
    -
    -
    -

    Returns the number of days left in the grace period. -Returns null if ToS is accepted (not in grace period). +

    +

    Returns null if ToS is accepted (not in grace period). Returns 0 if deadline has passed (no days left). Returns positive number if within grace period.

    - -
    -
    +

    Return values

    +

    int|null

    + +
    +
    + Attributes + +
    +
    +
    + #[Ignore] +
    +
    +

    publicgetTos() @@ -327,7 +325,7 @@

    Status.php : - 77 + 72

    @@ -364,7 +362,7 @@

    Status.php : - 27 + 24
    @@ -391,21 +389,19 @@

    Return values

    bool

    - -
    - Tags - - -
    -
    -
    - Ignore -
    -
    - -
    -
    + +
    +
    + Attributes + +
    +
    +
    + #[Ignore] +
    +
    +

    publicisInGracePeriod() @@ -414,7 +410,7 @@

    Status.php : - 35 + 30

    @@ -441,21 +437,19 @@

    Return values

    bool

    - -
    - Tags - - -
    -
    -
    - Ignore -
    -
    - -
    -
    + +
    +
    + Attributes + +
    +
    +
    + #[Ignore] +
    +
    +

    publicsetTos() @@ -464,7 +458,7 @@

    Status.php : - 97 + 92

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

    + ConfigureImageOptimizersEvent

    + +
    + ConfigureImageOptimizersEvent.php + : + 14 + +
    +
    Final
    + +
    + Extends Event +
    + + +
    +

    Event is the base class for classes containing event data.

    + + +
    +

    This class contains no event data. It is used by events that do not pass +state information to an event handler when an event is raised.

    +

    You can call the method stopPropagation() to abort the execution of +further listeners in your event listener.

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

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ConfigureImageOptimizersEvent.php + : + 22 + +
    +
    + +
    +
    + + + + + + +
    +
    +
    +
    +     		+
    + 
    public __construct(array<string|int, Optimizer> $optimizers)
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $optimizers + + array<string|int, Optimizer> + + - + + - +
    + + +
    +

    + publicaddOptimizer() + +

    +
    + ConfigureImageOptimizersEvent.php + : + 43 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public addOptimizer(Optimizer $optimizer) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $optimizer + + Optimizer + + - + + - +
    + + +
    +

    + publicgetOptimizers() + +

    +
    + ConfigureImageOptimizersEvent.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getOptimizers() : array<string|int, Optimizer>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string|int, Optimizer>

    + + +
    +

    + publicisPropagationStopped() + +

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

    Return values

    +

    bool

    + + +
    +

    + publicremoveOptimizer() + +

    +
    + ConfigureImageOptimizersEvent.php + : + 51 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public removeOptimizer(Optimizer> $optimizerClass) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $optimizerClass + + Optimizer> + + - + + - +
    + + +
    +

    + publicsetOptimizers() + +

    +
    + ConfigureImageOptimizersEvent.php + : + 38 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public setOptimizers(array<string|int, Optimizer> $optimizers) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $optimizers + + array<string|int, Optimizer> + + - + + - +
    + + +
    +

    + 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-ProductCatalog-Config-ConfigProviderInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Config-ConfigProviderInterface.html new file mode 100644 index 0000000000..ae55823a6a --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Config-ConfigProviderInterface.html @@ -0,0 +1,503 @@ + + + + + ConfigProviderInterface | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + ConfigProviderInterface

    + +
    + ConfigProviderInterface.php + : + 11 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicgetEngineAlias() + +

    +
    + ConfigProviderInterface.php + : + 16 + +
    +
    +

    Return currently used engine alias.

    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getEngineAlias() : string|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    string|null

    + + +
    +

    + publicgetEngineOption() + +

    +
    + ConfigProviderInterface.php + : + 34 + +
    +
    +

    Returns current engine option name.

    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getEngineOption(string $name[, mixed|null $default = null ]) : mixed
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $name + + string + + - + + - +
    + $default + + mixed|null + + null + + - +
    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + ConfigurationException + +
    +
    + +
    +

    + publicgetEngineType() + +

    +
    + ConfigProviderInterface.php + : + 23 + +
    +
    +

    Returns current engine type e.g. 'local', 'pim'.

    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getEngineType() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + +
    + Tags + + +
    +
    +
    + Throws +
    +
    + ConfigurationException + +
    +
    + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceDecorator.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceDecorator.html index 16d94b1e3d..8a28f6b897 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceDecorator.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceDecorator.html @@ -864,6 +864,84 @@

    Return values

    ProductVariantListInterface

    +
    +

    + publicfindVariants() + +

    +
    + LocalProductServiceDecorator.php + : + 118 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public findVariants(ProductVariantQuery $query[, LanguageSettings|null $languageSettings = null ]) : ProductVariantListInterface
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + ProductVariantQuery + + - + + - +
    + $languageSettings + + LanguageSettings|null + + null + + - +
    +

    Return values

    +

    ProductVariantListInterface

    + +

    publicgetDistinctProductVariantsAttributesValues() @@ -872,7 +950,7 @@

    LocalProductServiceDecorator.php : - 118 + 125

    @@ -1573,6 +1651,11 @@

    Return values

    findProductVariants() +
    • +
  • + + findVariants() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceInterface.html index 0105b726ea..99dfbc7901 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-LocalProductServiceInterface.html @@ -878,6 +878,84 @@

    Return values

    ProductVariantListInterface

    +
    +

    + publicfindVariants() + +

    +
    + ProductServiceInterface.php + : + 44 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public findVariants(ProductVariantQuery $query[, LanguageSettings|null $languageSettings = null ]) : ProductVariantListInterface
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + ProductVariantQuery + + - + + - +
    + $languageSettings + + LanguageSettings|null + + null + + - +
    +

    Return values

    +

    ProductVariantListInterface

    + +

    publicgetDistinctProductVariantsAttributesValues() @@ -1738,6 +1816,11 @@

    findProductVariants() +
    • +
  • + + findVariants() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-Values-ProductType-ProductTypeCreateStruct.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-Values-ProductType-ProductTypeCreateStruct.html index 7e78e52390..d8963a0df2 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-Values-ProductType-ProductTypeCreateStruct.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Local-Values-ProductType-ProductTypeCreateStruct.html @@ -287,7 +287,7 @@

    ProductTypeCreateStruct.php : - 28 + 32
    @@ -304,7 +304,7 @@

    - 
    public __construct(ContentTypeCreateStruct $contentTypeCreateStruct, string $mainLanguageCode[, array<string|int, AssignAttributeDefinitionStruct> $assignedAttributesDefinitions = [] ][, bool $isVirtual = false ])
    + 
    public __construct(ContentTypeCreateStruct $contentTypeCreateStruct, string $mainLanguageCode[, array<string|int, AssignAttributeDefinitionStruct> $assignedAttributesDefinitions = [] ][, bool $isVirtual = false ][, array<string, string> $names = [] ])
    @@ -379,6 +379,20 @@

    Parameters

    - + + + + $names + + + array<string, string> + + + [] + + + - + @@ -392,7 +406,7 @@

    ProductTypeCreateStruct.php : - 55 + 61
    @@ -429,7 +443,7 @@

    ProductTypeCreateStruct.php : - 42 + 48
    @@ -466,7 +480,7 @@

    ProductTypeCreateStruct.php : - 47 + 53
    @@ -495,6 +509,43 @@

    Return values

    string

    +
    +

    + publicgetNames() + +

    +
    + ProductTypeCreateStruct.php + : + 87 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getNames() : array<string, string>
    +
    +
    +
    +
    +
    +

    Return values

    +

    array<string, string>

    + +

    publicisVirtual() @@ -503,7 +554,7 @@

    ProductTypeCreateStruct.php : - 68 + 74

    @@ -540,7 +591,7 @@

    ProductTypeCreateStruct.php : - 63 + 69
    @@ -594,6 +645,68 @@

    Parameters

    +
    +

    + publicsetNames() + +

    +
    + ProductTypeCreateStruct.php + : + 95 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public setNames(array<string, string> $names) : void
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $names + + array<string, string> + + - + + - +
    + +

    publicsetVirtual() @@ -602,7 +715,7 @@

    ProductTypeCreateStruct.php : - 73 + 79

    @@ -779,6 +892,11 @@
    getMainLanguageCode() +
    • +
  • + + getNames() +
  • @@ -789,6 +907,11 @@
    setAssignedAttributesDefinitions() +
    • +
  • + + setNames() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductAvailabilityServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductAvailabilityServiceInterface.html index 00cd33c922..c7125420dc 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductAvailabilityServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductAvailabilityServiceInterface.html @@ -262,7 +262,7 @@

    ProductAvailabilityServiceInterface.php : - 28 + 31
    @@ -326,7 +326,7 @@

    ProductAvailabilityServiceInterface.php : - 47 + 50
    @@ -418,7 +418,7 @@

    ProductAvailabilityServiceInterface.php : - 52 + 55
    @@ -480,7 +480,7 @@

    ProductAvailabilityServiceInterface.php : - 19 + 22
    @@ -548,7 +548,21 @@

    Parameters

    Return values

    AvailabilityInterface

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

    @@ -558,7 +572,7 @@

    ProductAvailabilityServiceInterface.php : - 24 + 27

    @@ -622,7 +636,7 @@

    ProductAvailabilityServiceInterface.php : - 39 + 42
    @@ -714,7 +728,7 @@

    ProductAvailabilityServiceInterface.php : - 32 + 35
    diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductServiceInterface.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductServiceInterface.html index 3c4727bdc5..44189556a2 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductServiceInterface.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-ProductServiceInterface.html @@ -410,6 +410,84 @@

    Return values

    ProductVariantListInterface

    +
    +

    + publicfindVariants() + +

    +
    + ProductServiceInterface.php + : + 44 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public findVariants(ProductVariantQuery $query[, LanguageSettings|null $languageSettings = null ]) : ProductVariantListInterface
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $query + + ProductVariantQuery + + - + + - +
    + $languageSettings + + LanguageSettings|null + + null + + - +
    +

    Return values

    +

    ProductVariantListInterface

    + +

    publicgetProduct() @@ -655,6 +733,11 @@

    findProductVariants() +
    • +
  • + + findVariants() +
  • diff --git a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Values-Product-ProductVariantQuery.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Values-Product-ProductVariantQuery.html index c4b776572c..30b48d2d20 100644 --- a/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Values-Product-ProductVariantQuery.html +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ProductCatalog-Values-Product-ProductVariantQuery.html @@ -403,7 +403,7 @@

    @@ -413,7 +413,7 @@

    Return values

    -

    ProductCriterionAdapter<string|int, CriterionInterface>|null

    +

    ProductCriterionAdapter|null

    @@ -551,7 +551,7 @@

    - 
    public setAttributesCriterion(ProductCriterionAdapter<string|int, CriterionInterface>|null $criterion) : void
    + 
    public setAttributesCriterion(ProductCriterionAdapter|null $criterion) : void
    @@ -576,7 +576,7 @@

    Parameters

    $criterion - ProductCriterionAdapter<string|int, CriterionInterface>|null + ProductCriterionAdapter|null - 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 +
    + +
    + Implements + ShoppingListResultAwareEventInterface
    + +
    +

    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 +
    + +
    + Implements + ShoppingListResultAwareEventInterface
    + +
    +

    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 +
    + +
    + Implements + ShoppingListResultAwareEventInterface
    + +
    +

    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-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 +
    + +
    + Implements + ShoppingListResultAwareEventInterface
    + +
    +

    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 +
    + +
    + Implements + ShoppingListResultAwareEventInterface
    + +
    +

    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-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
    + +
    + Extends AbstractShoppingListPolicy +
    + + +
    + + + + + + + + + + + + + + +

    + 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
    + +
    + Extends AbstractShoppingListPolicy +
    + + +
    + + + + + + + + + + + + + + +

    + 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
    + +
    + Extends AbstractShoppingListPolicy +
    + + +
    + + + + + + + + + + + + + + +

    + 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
    + +
    + Extends AbstractShoppingListPolicy +
    + + +
    + + + + + + + + + + + + + + +

    + 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..2bef3d1ef7 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceDecorator.html @@ -0,0 +1,1070 @@ + + + + + ShoppingListServiceDecorator | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ShoppingListServiceDecorator

    + +
    + ShoppingListServiceDecorator.php + : + 17 + +
    +
    Abstract
    + + +
    + Implements + ShoppingListServiceInterface
    + +
    + + + + + + + + + + + + + +

    + 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 + : + 67 + +
    +
    +

    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

    + + +
    +

    + 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..65df399051 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-ShoppingListServiceInterface.html @@ -0,0 +1,1191 @@ + + + + + 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 + : + 93 + +
    +
    +

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

    + 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..2b6ab1a6e2 --- /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..e2bd237166 --- /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..4a4b8f69ff --- /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..b76516f7bc --- /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..0718c2a79d --- /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-DateRangeFilter.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-DateRangeFilter.html new file mode 100644 index 0000000000..7ab5b8d014 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-DateRangeFilter.html @@ -0,0 +1,530 @@ + + + + + DateRangeFilter | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + DateRangeFilter

    + +
    + DateRangeFilter.php + : + 13 + +
    +
    Read-only
    +
    Final
    + + +
    + Implements + DateRangeFilterInterface
    + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + DateRangeFilter.php + : + 15 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public __construct([DateTimeInterface|null $min = null ][, DateTimeInterface|null $max = null ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $min + + DateTimeInterface|null + + null + + - +
    + $max + + DateTimeInterface|null + + null + + - +
    + + +
    +

    + publicgetMax() + +

    +
    + DateRangeFilter.php + : + 25 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getMax() : DateTimeInterface|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    DateTimeInterface|null

    + + +
    +

    + publicgetMin() + +

    +
    + DateRangeFilter.php + : + 20 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getMin() : DateTimeInterface|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    DateTimeInterface|null

    + + +
    +

    + publicisEmpty() + +

    +
    + DateRangeFilter.php + : + 30 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public isEmpty() : bool
    +
    +
    +
    +
    +
    +

    Return values

    +

    bool

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

    + DateRangeFilterInterface

    + +
    + DateRangeFilterInterface.php + : + 13 + +
    +
    Interface
    + +
    + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicgetMax() + +

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

    Return values

    +

    DateTimeInterface|null

    + + +
    +

    + publicgetMin() + +

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

    Return values

    +

    DateTimeInterface|null

    + + +
    +

    + publicisEmpty() + +

    +
    + DateRangeFilterInterface.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-ShoppingListFilter.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-ShoppingListFilter.html new file mode 100644 index 0000000000..62d50bcdc2 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-ShoppingListFilter.html @@ -0,0 +1,768 @@ + + + + + ShoppingListFilter | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +
    +

    + ShoppingListFilter

    + +
    + ShoppingListFilter.php + : + 11 + +
    +
    Read-only
    +
    Final
    + + +
    + Implements + ShoppingListFilterInterface
    + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + public__construct() + +

    +
    + ShoppingListFilter.php + : + 13 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public __construct([string|null $name = null ][, DateRangeFilterInterface|null $createdAt = null ][, DateRangeFilterInterface|null $updatedAt = null ][, string $isDefault = ShoppingListFilterInterface::IS_DEFAULT_ALL ][, string|null $sortField = null ][, string $sortDirection = ShoppingListFilterInterface::SORT_DIRECTION_ASC ][, int|null $ownerId = null ])
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $name + + string|null + + null + + - +
    + $createdAt + + DateRangeFilterInterface|null + + null + + - +
    + $updatedAt + + DateRangeFilterInterface|null + + null + + - +
    + $isDefault + + string + + ShoppingListFilterInterface::IS_DEFAULT_ALL + + - +
    + $sortField + + string|null + + null + + - +
    + $sortDirection + + string + + ShoppingListFilterInterface::SORT_DIRECTION_ASC + + - +
    + $ownerId + + int|null + + null + + - +
    + + +
    +

    + publicgetCreatedAt() + +

    +
    + ShoppingListFilter.php + : + 28 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getCreatedAt() : DateRangeFilterInterface|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    DateRangeFilterInterface|null

    + + +
    +

    + publicgetIsDefault() + +

    +
    + ShoppingListFilter.php + : + 38 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getIsDefault() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetName() + +

    +
    + ShoppingListFilter.php + : + 23 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getName() : string|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    string|null

    + + +
    +

    + publicgetOwnerId() + +

    +
    + ShoppingListFilter.php + : + 53 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getOwnerId() : int|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    int|null

    + + +
    +

    + publicgetSortDirection() + +

    +
    + ShoppingListFilter.php + : + 48 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getSortDirection() : string
    +
    +
    +
    +
    +
    +

    Return values

    +

    string

    + + +
    +

    + publicgetSortField() + +

    +
    + ShoppingListFilter.php + : + 43 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getSortField() : string|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    string|null

    + + +
    +

    + publicgetUpdatedAt() + +

    +
    + ShoppingListFilter.php + : + 33 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getUpdatedAt() : DateRangeFilterInterface|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    DateRangeFilterInterface|null

    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + 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..5421f28838 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-ShoppingList-Value-Query-Filter-ShoppingListFilterInterface.html @@ -0,0 +1,955 @@ + + + + + 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() : DateRangeFilterInterface|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    DateRangeFilterInterface|null

    + + +
    +

    + publicgetIsDefault() + +

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

    Return values

    +

    string

    + + +
    +

    + publicgetName() + +

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

    Return values

    +

    string|null

    + + +
    +

    + publicgetOwnerId() + +

    +
    + ShoppingListFilterInterface.php + : + 37 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public getOwnerId() : int|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    int|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() : DateRangeFilterInterface|null
    +
    +
    +
    +
    +
    +

    Return values

    +

    DateRangeFilterInterface|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..1356760be9 --- /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/classes/Ibexa-Contracts-Taxonomy-Embedding-Exception-TaxonomyEmbeddingConfigurationException.html b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Taxonomy-Embedding-Exception-TaxonomyEmbeddingConfigurationException.html new file mode 100644 index 0000000000..7773174356 --- /dev/null +++ b/docs/api/php_api/php_api_reference/classes/Ibexa-Contracts-Taxonomy-Embedding-Exception-TaxonomyEmbeddingConfigurationException.html @@ -0,0 +1,400 @@ + + + + + TaxonomyEmbeddingConfigurationException | PHP API Reference (Ibexa Documentation) + + + + + + + + + + + + + + + + +
    Copied!
    + + + +
    + +
    + +
    +
    +
    + + + + + + + + +
    +
    +
    + + + +
    +
    + + +
    +

    + TaxonomyEmbeddingConfigurationException

    + +
    + TaxonomyEmbeddingConfigurationException.php + : + 14 + +
    +
    Final
    + +
    + Extends RuntimeException +
    + + +
    + + + + + + + + + + + + + + +

    + Methods +

    + +
    +

    + publicforModelIdentifier() + +

    +
    + TaxonomyEmbeddingConfigurationException.php + : + 16 + +
    +
    + +
    + + + + + + + +
    +
    +
    +
    +     		+
    + 
    public static forModelIdentifier(string $identifier, Throwable $previous) : self
    +
    +
    +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + + + + + + + + + +
    NameTypeDefault valueDescription
    + $identifier + + string + + - + + - +
    + $previous + + Throwable + + - + + - +
    +

    Return values

    +

    self

    + + +
    +
    +
    + +
    +
    +
    + +
    +
    +
    +
    +
    +
    + + + + + + + + + + + diff --git a/docs/api/php_api/php_api_reference/index.html b/docs/api/php_api/php_api_reference/index.html index c3c015bf6b..3307198794 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 @@ -28573,6 +28665,41 @@
  • + Event + + + +
    • + + +
  • + +