Notice: You are browsing the documentation for PrestaShop 9, which is currently in development.

You might want to read the documentation for the current version, PrestaShop 8. Read the current version of this page

OrderReturnState domain

OrderReturnState Commands

AddOrderReturnStateCommand

PrestaShop\PrestaShop\Core\Domain\OrderReturnState\Command\AddOrderReturnStateCommand Adds new order return state with provided data

Command details
Constructor parameters
  • $array $localizedNames
  • $string $color
Handler class PrestaShop\PrestaShop\Adapter\OrderReturnState\CommandHandler\AddOrderReturnStateHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\OrderReturnState\CommandHandler\AddOrderReturnStateHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\OrderReturnState\ValueObject\OrderReturnStateId

BulkDeleteOrderReturnStateCommand

PrestaShop\PrestaShop\Core\Domain\OrderReturnState\Command\BulkDeleteOrderReturnStateCommand Deletes order return statuses in bulk action

Command details
Constructor parameters
  • $array $orderReturnStateIds
Handler class PrestaShop\PrestaShop\Adapter\OrderReturnState\CommandHandler\BulkDeleteOrderReturnStateHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\OrderReturnState\CommandHandler\BulkDeleteOrderReturnStateHandlerInterface
Return type void

DeleteOrderReturnStateCommand

PrestaShop\PrestaShop\Core\Domain\OrderReturnState\Command\DeleteOrderReturnStateCommand Deletes Order Return States

Command details
Constructor parameters
  • $int $orderReturnStateId
Handler class PrestaShop\PrestaShop\Adapter\OrderReturnState\CommandHandler\DeleteOrderReturnStateHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\OrderReturnState\CommandHandler\DeleteOrderReturnStateHandlerInterface
Return type void

EditOrderReturnStateCommand

PrestaShop\PrestaShop\Core\Domain\OrderReturnState\Command\EditOrderReturnStateCommand Edits provided order return state. It can edit either all or partial data. Only not-null values are considered when editing order return state. For example, if the name is null, then the original value is not modified, however, if name is set, then the original value will be overwritten.

Command details
Constructor parameters
  • $int $orderReturnStateId
Handler class PrestaShop\PrestaShop\Adapter\OrderReturnState\CommandHandler\EditOrderReturnStateHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\OrderReturnState\CommandHandler\EditOrderReturnStateHandlerInterface
Return type void

OrderReturnState Queries

GetOrderReturnStateForEditing

PrestaShop\PrestaShop\Core\Domain\OrderReturnState\Query\GetOrderReturnStateForEditing Gets order return state information for editing.

Query details
Constructor parameters
  • $int $orderReturnStateId
Handler class PrestaShop\PrestaShop\Adapter\OrderReturnState\QueryHandler\GetOrderReturnStateForEditingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\OrderReturnState\QueryHandler\GetOrderReturnStateForEditingHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\OrderReturnState\QueryResult\EditableOrderReturnState