Mindbox-Helpers-OrderHelper.md

Mindbox\Helpers\OrderHelper

Хелпер, являющий обёрткой над универсальным запросом. Содержит методы для отправки запросов, связанных с процессингом заказов.

Class OrderHelper

• Class name: OrderHelper
• Namespace: Mindbox\Helpers
• Parent class: Mindbox\Helpers\AbstractMindboxHelper

Properties

$client

protected \Mindbox\Clients\AbstractMindboxClient $client

• Visibility: protected

Methods

calculateCart

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\OrderHelper::calculateCart(\Mindbox\DTO\V2\Requests\PreorderRequestDTO $order, string $operationName)

Выполняет вызов стандартной операции Website.CalculateCart:

• Visibility: public

Arguments

• $order Mindbox\DTO\V2\Requests\PreorderRequestDTO - <p>Объект, содержащий данные корзины для запроса.</p>
• $operationName string - <p>Название операции.</p>

createOrder

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\OrderHelper::createOrder(\Mindbox\DTO\V2\Requests\OrderCreateRequestDTO $order, string $operationName)

Выполняет вызов стандартной операции Website.CreateOrder:

• Visibility: public

Arguments

• $order Mindbox\DTO\V2\Requests\OrderCreateRequestDTO - <p>Объект, содержащий данные корзины для запроса.</p>
• $operationName string - <p>Название операции.</p>

confirmOrder

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\OrderHelper::confirmOrder(\Mindbox\DTO\V2\Requests\OrderUpdateRequestDTO $order, string $operationName)

Выполняет вызов стандартной операции Website.ConfirmOrder:

• Visibility: public

Arguments

• $order Mindbox\DTO\V2\Requests\OrderUpdateRequestDTO - <p>Объект, содержащий данные корзины для запроса.</p>
• $operationName string - <p>Название операции.</p>

cancelOrder

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\OrderHelper::cancelOrder(\Mindbox\DTO\V2\Requests\OrderUpdateRequestDTO $order, string $operationName)

Выполняет вызов стандартной операции Website.CancelOrder:

• Visibility: public

Arguments

• $order Mindbox\DTO\V2\Requests\OrderUpdateRequestDTO - <p>Объект, содержащий данные корзины для запроса.</p>
• $operationName string - <p>Название операции.</p>

offlineOrder

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\OrderHelper::offlineOrder(\Mindbox\DTO\V2\Requests\OrderUpdateRequestDTO $order, string $operationName)

Выполняет вызов стандартной операции Website.OfflineOrder:

• Visibility: public

Arguments

• $order Mindbox\DTO\V2\Requests\OrderUpdateRequestDTO - <p>Объект, содержащий данные корзины для запроса.</p>
• $operationName string - <p>Название операции.</p>

getOrders

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\OrderHelper::getOrders(integer $countToReturn, string $mindbox, integer $startingIndex, string $operationName)

Выполняет вызов стандартной операции Website.GetCustomerOrders:

• Visibility: public

Arguments

• $countToReturn integer - <p>Максимальное количество заказов для возврата.</p>
• $mindbox string - <p>Идентификатор потребителя.</p>
• $startingIndex integer - <p>Порядковый номер заказа, начиная с которого будет сформирован список заказов.</p>
• $operationName string - <p>Название операции.</p>

__construct

mixed Mindbox\Helpers\AbstractMindboxHelper::__construct(\Mindbox\Clients\AbstractMindboxClient $client)

Конструктор AbstractMindboxHelper.

• Visibility: public
• This method is defined by Mindbox\Helpers\AbstractMindboxHelper

Arguments

• $client Mindbox\Clients\AbstractMindboxClient - <p>Экземпляр клиента Mindbox.</p>

createOperation

\Mindbox\DTO\V3\OperationDTO Mindbox\Helpers\AbstractMindboxHelper::createOperation()

Инициализация объекта OperationDTO.

• Visibility: protected
• This method is defined by Mindbox\Helpers\AbstractMindboxHelper

getLastResponse

\Mindbox\MindboxResponse Mindbox\Helpers\AbstractMindboxHelper::getLastResponse()

Возвращает экземпляр последнего ответа от Mindbox.

• Visibility: public
• This method is defined by Mindbox\Helpers\AbstractMindboxHelper

sendRequest

\Mindbox\MindboxResponse Mindbox\Helpers\AbstractMindboxHelper::sendRequest()

• Visibility: public
• This method is defined by Mindbox\Helpers\AbstractMindboxHelper

getRequest

\Mindbox\MindboxRequest Mindbox\Helpers\AbstractMindboxHelper::getRequest()

• Visibility: public
• This method is defined by Mindbox\Helpers\AbstractMindboxHelper