From 6b14f3701fcb235d1f4ff1b31ceccfa1087109c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Tue, 27 May 2025 15:06:52 +0200 Subject: [PATCH 1/2] Added other links to PHP API Reference --- .../order_management/order_management_api.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/commerce/order_management/order_management_api.md b/docs/commerce/order_management/order_management_api.md index 44ba0d6eed..bbfd151621 100644 --- a/docs/commerce/order_management/order_management_api.md +++ b/docs/commerce/order_management/order_management_api.md @@ -9,13 +9,13 @@ edition: commerce To learn how to manage orders with the REST API, see the [REST API reference](../../api/rest_api/rest_api_reference/rest_api_reference.html#orders). -To get orders and manage them, use the `Ibexa\Contracts\OrderManagement\OrderServiceInterface` interface. +To get orders and manage them, use the [`Ibexa\Contracts\OrderManagement\OrderServiceInterface`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html) interface. ## Get single order ### Get single order by identifier -To access a single order by using its string identifier, use the `OrderService::getOrderByIdentifier` method: +To access a single order by using its string identifier, use the [`OrderService::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', 61, 65) =]] @@ -23,7 +23,7 @@ To access a single order by using its string identifier, use the `OrderService:: ### Get single order by ID -To access a single order by using its numerical ID, use the `OrderService::getOrder` method: +To access a single order by using its numerical ID, use the [`OrderService::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', 67, 72) =]] @@ -31,7 +31,7 @@ To access a single order by using its numerical ID, use the `OrderService::getOr ## Get multiple orders -To fetch multiple orders, use the `OrderService::findOrders` method. +To fetch multiple orders, use the [`OrderService::findOrders`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_findOrders) method. It follows the same search query pattern as other APIs: ``` php @@ -43,7 +43,7 @@ It follows the same search query pattern as other APIs: ## Create order -To create an order, use the `OrderService::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. +To create an order, use the [`OrderService::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', 101, 113) =]] @@ -53,7 +53,7 @@ To create an order, use the `OrderService::createOrder` method and provide it wi You can update the order after it's created. You could do it to support a scenario when, for example, the order is processed manually and its status has to be changed in the system. -To update order information, use the `OrderService::updateOrder` method: +To update order information, use the [`OrderService::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', 114, 119) =]] From ef3324de9ae7a469a78ea8f374c5038692078aaf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marek=20Noco=C5=84?= Date: Tue, 27 May 2025 15:32:02 +0200 Subject: [PATCH 2/2] OrderService -> OrderServiceInterface --- docs/commerce/order_management/order_management_api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/commerce/order_management/order_management_api.md b/docs/commerce/order_management/order_management_api.md index bbfd151621..4a875ac97c 100644 --- a/docs/commerce/order_management/order_management_api.md +++ b/docs/commerce/order_management/order_management_api.md @@ -15,7 +15,7 @@ To get orders and manage them, use the [`Ibexa\Contracts\OrderManagement\OrderSe ### Get single order by identifier -To access a single order by using its string identifier, use the [`OrderService::getOrderByIdentifier`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_getOrderByIdentifier) method: +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', 61, 65) =]] @@ -23,7 +23,7 @@ To access a single order by using its string identifier, use the [`OrderService: ### Get single order by ID -To access a single order by using its numerical ID, use the [`OrderService::getOrder`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_getOrder) method: +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', 67, 72) =]] @@ -31,7 +31,7 @@ To access a single order by using its numerical ID, use the [`OrderService::getO ## Get multiple orders -To fetch multiple orders, use the [`OrderService::findOrders`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_findOrders) method. +To fetch multiple orders, use the [`OrderServiceInterface::findOrders`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_findOrders) method. It follows the same search query pattern as other APIs: ``` php @@ -43,7 +43,7 @@ It follows the same search query pattern as other APIs: ## Create order -To create an order, use the [`OrderService::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. +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', 101, 113) =]] @@ -53,7 +53,7 @@ To create an order, use the [`OrderService::createOrder`](/api/php_api/php_api_r You can update the order after it's created. You could do it to support a scenario when, for example, the order is processed manually and its status has to be changed in the system. -To update order information, use the [`OrderService::updateOrder`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-OrderManagement-OrderServiceInterface.html#method_updateOrder) method: +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', 114, 119) =]]