Adjusted code sample usage

Author: mnocon

code_samples/api/commerce/src/Command/CartCommand.php

@@ -90,7 +90,7 @@ public function __invoke(OutputInterface $output): int
         $this->cartService->emptyCart($cart);
 
         // Validate a cart
-        $violationList = $this->cartService->validateCart($cart); // Symfony\Component\Validator\ConstraintViolationListInterface
+        $violationList = $this->cartService->validateCart($cart);
 
         // Add product to a cart
         $product = $this->productService->getProduct('desk1');

docs/ai_actions/extend_ai_actions.md

@@ -14,7 +14,7 @@ For example, you can create a handler that connects to a translation model and u
 You can execute AI Actions by using the [ActionServiceInterface](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionServiceInterface.html) service, as in the following example:
 
 ``` php
-[[= include_file('code_samples/ai_actions/src/Command/AddMissingAltTextCommand.php', 86, 105) =]]
+[[= include_file('code_samples/ai_actions/src/Command/AddMissingAltTextCommand.php', 81, 100) =]]
 ```
 
 The `GenerateAltTextAction` is a built-in action that implements the [ActionInterface](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionInterface.html), takes an [Image](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-Action-DataType-Image.html) as an input, and generates the alternative text in the response.
@@ -43,7 +43,7 @@ You can influence the execution of an Action with two events:
 Below you can find the full example of a Symfony Command, together with a matching service definition.
 The command finds the images modified in the last 24 hours, and adds the alternative text to them if it's missing.
 
-``` php hl_lines="72 85-110"
+``` php hl_lines="67 80-105"
 [[= include_file('code_samples/ai_actions/src/Command/AddMissingAltTextCommand.php') =]]
 ```
 
@@ -77,7 +77,7 @@ See [Action Configuration Search Criteria reference](action_configuration_criter
 The following example creates a new Action Configuration:
 
 ``` php hl_lines="3 17"
-[[= include_file('code_samples/ai_actions/src/Command/ActionConfigurationCreateCommand.php', 46, 63) =]]
+[[= include_file('code_samples/ai_actions/src/Command/ActionConfigurationCreateCommand.php', 40, 58) =]]
 ```
 
 Actions Configurations are tied to a specific Action Type and are translatable.
@@ -88,7 +88,7 @@ Reuse existing Action Configurations to simplify the execution of AI Actions.
 You can pass one directly to the `ActionServiceInterface::execute()` method:
 
 ``` php hl_lines="7-8"
-[[= include_file('code_samples/ai_actions/src/Command/ActionConfigurationCreateCommand.php', 64, 72) =]]
+[[= include_file('code_samples/ai_actions/src/Command/ActionConfigurationCreateCommand.php', 59, 67) =]]
 ```
 
 The passed Action Configuration is only taken into account if the Action Context was not passed to the Action directly using the [ActionInterface::setActionContext()](/api/php_api/php_api_reference/classes/Ibexa-Contracts-ConnectorAi-ActionInterface.html#method_hasActionContext) method.

docs/api/php_api/php_api.md

@@ -126,7 +126,7 @@ While [using `sudo()`](#using-sudo) is the recommended option, you can also set
 To identify as a different user, you need to use the `UserService` together with `PermissionResolver` (in the example `admin` is the login of the administrator user):
 
 ``` php
-[[= include_file('code_samples/api/public_php_api/src/Command/CreateContentCommand.php', 40, 41) =]]
+[[= include_file('code_samples/api/public_php_api/src/Command/CreateContentCommand.php', 36, 38) =]]
 ```
 
 !!! tip

docs/commerce/cart/cart_api.md

@@ -23,7 +23,7 @@ From the developer's perspective, carts and entries are referenced with a UUID i
 To access a single cart, use the `CartServiceInterface::getCart` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 63, 66) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 61, 64) =]]
 ```
 
 ## Get multiple carts
@@ -35,7 +35,7 @@ It follows the same search Query pattern as other APIs:
 [[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 10, 11) =]]
 // ...
 
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 49, 57) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 47, 56) =]]
 ```
 
 ## Create cart
@@ -46,7 +46,7 @@ To create a cart, use the `CartServiceInterface::createCart` method and provide
 [[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 8, 9) =]]
 // ...
 
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 70, 78) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 68, 76) =]]
 ```
 
 ## Update cart metadata
@@ -59,7 +59,7 @@ To update cart metadata, use the `CartServiceInterface::updateCartMetadata` meth
 [[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 9, 10) =]]
 // ...
 
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 82, 89) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 80, 87) =]]
 ```
 
 You can also use this method to change cart ownership:
@@ -80,17 +80,17 @@ $cart = $cartService->updateCartMetadata($cart, $updateMetadataStruct);
 To delete a cart permanently, use the `CartServiceInterface::deleteCart` method and pass the `CartInterface` object:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 63, 64) =]]
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 124, 125) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 61, 63) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 122, 124) =]]
 ```
 
 ## Empty cart
 
 To remove all products from the cart in a single operation, use the `CartServiceInterface::emptyCart` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 63, 64) =]]
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 91, 92) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 61, 62) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 89, 91) =]]
 ```
 
 ## Check cart validity
@@ -101,8 +101,8 @@ To validate the cart, use the `CartServiceInterface::validateCart` method.
 Validation is done with help from the `symfony/validator` component, and the method returns a `Symfony\Component\Validator\ConstraintViolationListInterface` object.
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 63, 64) =]]
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 94, 95) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 61, 62) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 92, 93) =]]
 ```
 
 ## Add entry to cart
@@ -114,17 +114,17 @@ Then pass it to the `CartServiceInterface::addEntry` method:
 [[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 11, 12) =]]
 // ...
 
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 63, 64) =]]
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 99, 106) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 61, 62) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 97, 104) =]]
 ```
 
 ## Remove entry from cart
 
 To remove an entry from the cart, use the `CartServiceInterface::removeEntry` method.
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 63, 64) =]]
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 109, 112) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 61, 62) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 107, 110) =]]
 ```
 
 ## Update entry metadata
@@ -136,9 +136,9 @@ To change entry metadata, use the `CartServiceInterface::updateEntry` method and
 [[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 12, 13) =]]
 // ...
 
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 63, 64) =]]
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 109, 110) =]]
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 114, 122) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 61, 62) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 107, 109) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 112, 120) =]]
 ```
 
 ## Adding context data
@@ -185,5 +185,5 @@ To combine the contents of multiple shopping carts into a target cart, use the `
 This operation is helpful when you want to consolidate items from a reorder cart and a current cart into a single order.
 
 ```php
-[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 126, 139) =]]
+[[= include_file('code_samples/api/commerce/src/Command/CartCommand.php', 125, 137) =]]
 ```

docs/commerce/order_management/order_management_api.md

@@ -19,15 +19,15 @@ To get orders and manage them, use the [`Ibexa\Contracts\OrderManagement\OrderSe
 To access a single order by using its string identifier, use the [`OrderServiceInterface::getOrderByIdentifier`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_getOrderByIdentifier) method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 51, 55) =]]
+[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 45, 49) =]]
 ```
 
 ### Get single order by ID
 
 To access a single order by using its numerical ID, use the [`OrderServiceInterface::getOrder`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_getOrder) method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 57, 61) =]]
+[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 51, 55) =]]
 ```
 
 ## Get multiple orders
@@ -36,18 +36,18 @@ To fetch multiple orders, use the [`OrderServiceInterface::findOrders`](/api/php
 It follows the same search query pattern as other APIs:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 8, 9) =]][[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 10, 14) =]]
+[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 9, 14) =]]
 
 // ...
-[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 110, 119) =]]
+[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 104, 113) =]]
 ```
 
 ## Create order
 
 To create an order, use the [`OrderServiceInterface::createOrder`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_createOrder) method and provide it with the [`Ibexa\Contracts\OrderManagement\Value\Struct\OrderCreateStruct`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-Value-Struct-OrderCreateStruct.html) object that contains a list of products, purchased quantities, product, total prices, and tax amounts.
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 91, 102) =]]
+[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 85, 96) =]]
 ```
 
 ## Update order
@@ -57,5 +57,5 @@ You could do it to support a scenario when, for example, the order is processed
 To update order information, use the [`OrderServiceInterface::updateOrder`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_updateOrder) method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 104, 108) =]]
+[[= include_file('code_samples/api/commerce/src/Command/OrderCommand.php', 98, 102) =]]
 ```

docs/commerce/payment/extend_payment.md

@@ -94,11 +94,11 @@ When you create a payment, you can attach custom data to it, for example, you ca
 You add custom data by using the `setContext` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 81, 93) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 75, 87) =]]
 ```
 
 Then, you retrieve it with the `getContext` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 54, 58) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 48, 52) =]]
 ```

docs/commerce/payment/payment_api.md

@@ -17,15 +17,15 @@ You can change that by providing a custom payment identifier in `Ibexa\Contracts
 To access a single payment by using its numerical ID, use the `PaymentServiceInterface::getPayment` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 48, 52) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 42, 46) =]]
 ```
 
 ### Get single payment by identifier
 
 To access a single payment by using its string identifier, use the `PaymentServiceInterface::getPaymentByIdentifier` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 54, 56) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 48, 50) =]]
 ```
 
 ## Get multiple payments
@@ -34,15 +34,15 @@ To fetch multiple payments, use the `PaymentServiceInterface::findPayments` meth
 It follows the same search query pattern as other APIs:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 63, 79) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 57, 73) =]]
 ```
 
 ## Create payment
 
 To create a payment, use the `PaymentServiceInterface::createPayment` method and provide it with the `Ibexa\Contracts\Payment\Payment\PaymentCreateStruct` object that takes the following arguments: `method`, `order` and `amount`.
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 81, 95) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 75, 89) =]]
 ```
 
 ## Update payment
@@ -53,13 +53,13 @@ The `Ibexa\Contracts\Payment\Payment\PaymentUpdateStruct` object takes the follo
 To update payment information, use the `PaymentServiceInterface::updatePayment` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 97, 103) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 91, 97) =]]
 ```
 
 ## Delete payment
 
 To delete a payment from the system, use the `PaymentServiceInterface::deletePayment` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 105, 106) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentCommand.php', 99, 100) =]]
 ```

docs/commerce/payment/payment_method_api.md

@@ -26,15 +26,15 @@ From the developer's perspective, payment methods are referenced with identifier
 To access a single payment method by using its string identifier, use the `PaymentMethodService::getPaymentMethodByIdentifier` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 46, 50) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 44, 48) =]]
 ```
 
 ### Get single payment method by ID
 
 To access a single payment method by using its numerical ID, use the `PaymentMethodService::getPaymentMethod` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 40, 44) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 38, 42) =]]
 ```
 
 ## Get multiple payment methods
@@ -44,7 +44,7 @@ To fetch multiple payment methods, use the `PaymentMethodService::findPaymentMet
 It follows the same search query pattern as other APIs:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 52, 69) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 50, 68) =]]
 ```
 
 ## Create payment method
@@ -59,7 +59,7 @@ To create a payment method, use the `PaymentMethodService::createPaymentMethod`
 - `options` object.
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 52, 53) =]][[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 71, 81) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 50, 51) =]][[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 70, 79) =]]
 ```
 
 ## Update payment method
@@ -70,20 +70,20 @@ An `Ibexa\Contracts\Payment\PaymentMethod\PaymentMethodUpdateStruct` object can
 To update payment method information, use the `PaymentMethodServiceInterface::updatePaymentMethod` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 83, 93) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 81, 91) =]]
 ```
 
 ## Delete payment method
 
 To delete a payment method from the system, use the `PaymentMethodService::deletePayment` method:
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 95, 101) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 93, 99) =]]
 ```
 
 ## Check whether payment method is used
 
 To check whether a payment method is used, for example, before you delete it, use the `PaymentMethodService::isPaymentMethodUsed` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 103, 116) =]]
+[[= include_file('code_samples/api/commerce/src/Command/PaymentMethodCommand.php', 101, 114) =]]
 ```

docs/commerce/shipping_management/shipment_api.md

@@ -16,15 +16,15 @@ From the developer's perspective, shipments are referenced with a UUID identifie
 To access a single shipment by using its string identifier, use the `ShipmentService::getShipmentByIdentifier` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 57, 66) =]]
+[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 56, 64) =]]
 ```
 
 ### Get single shipment by id
 
 To access a single shipment by using its numerical id, use the `ShipmentService::getShipment` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 45, 55) =]]
+[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 44, 53) =]]
 ```
 
 ## Get multiple shipments
@@ -33,15 +33,15 @@ To fetch multiple shipments, use the `ShipmentService::findShipments` method.
 It follows the same search query pattern as other APIs:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 68, 87) =]]
+[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 66, 85) =]]
 ```
 
 ## Create shipment
 
 To create a shipment, use the `ShipmentService::createShipment` method and provide it with an `Ibexa\Contracts\Shipping\Value\ShipmentCreateStruct` object that takes two parameters, a `shippingMethod` string and a `Money` object.
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 89, 103) =]]
+[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 87, 101) =]]
 ```
 
 ## Update shipment
@@ -51,13 +51,13 @@ You could do it to support a scenario when, for example, the shipment is process
 To update shipment information, use the `ShipmentService::updateShipment` method:
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 105, 116) =]]
+[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 103, 114) =]]
 ```
 ## Delete shipment
 
 To delete a shipment from the system, use the `ShipmentService::deleteShipment` method:
 
 
 ``` php
-[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 118, 119) =]]
+[[= include_file('code_samples/api/commerce/src/Command/ShipmentCommand.php', 116, 117) =]]
 ```