Table of Contents

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

You might want to read the documentation for the current version, PrestaShop 1.7.

Product domain

Product Commands

BulkDeleteAttributeCommand

PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Attribute\Command\BulkDeleteAttributeCommand Deletes attributes in bulk action

Command details
Constructor parameters
  • $array $attributeIds
Handler class PrestaShop\PrestaShop\Adapter\Attribute\CommandHandler\BulkDeleteAttributeHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Attribute\CommandHandler\BulkDeleteAttributeHandlerInterface
Return type void

DeleteAttributeCommand

PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Attribute\Command\DeleteAttributeCommand Deletes Attribute by provided id

Command details
Constructor parameters
  • $int $attributeId
Handler class PrestaShop\PrestaShop\Adapter\Attribute\CommandHandler\DeleteAttributeHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Attribute\CommandHandler\DeleteAttributeHandlerInterface
Return type void

BulkDeleteAttributeGroupCommand

PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Command\BulkDeleteAttributeGroupCommand Deletes attribute groups in bulk action by provided ids

Command details
Constructor parameters
  • $array $attributeGroupIds
Handler class PrestaShop\PrestaShop\Adapter\Product\AttributeGroup\CommandHandler\BulkDeleteAttributeGroupHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\CommandHandler\BulkDeleteAttributeGroupHandlerInterface
Return type void

DeleteAttributeGroupCommand

PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Command\DeleteAttributeGroupCommand Deletes attribute group by provided id

Command details
Constructor parameters
  • $int $attributeGroupId
Handler class PrestaShop\PrestaShop\Adapter\Product\AttributeGroup\CommandHandler\DeleteAttributeGroupHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\CommandHandler\DeleteAttributeGroupHandlerInterface
Return type void

GenerateProductCombinationsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\GenerateProductCombinationsCommand Generates attribute combinations for product

Command details
Constructor parameters
  • $int $productId
  • $array $groupedAttributeIds
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\GenerateProductCombinationsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\GenerateProductCombinationsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Combination\ValueObject\CombinationId[]

RemoveAllAssociatedCombinationSuppliersCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\RemoveAllAssociatedCombinationSuppliersCommand Removes associated product suppliers related to certain combination

Command details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\RemoveAllAssociatedCombinationSuppliersHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\RemoveAllAssociatedCombinationSuppliersHandlerInterface
Return type void

RemoveAllCombinationImagesCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\RemoveAllCombinationImagesCommand __

Command details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\RemoveAllCombinationImagesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\RemoveAllCombinationImagesHandlerInterface
Return type void

RemoveCombinationCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\RemoveCombinationCommand __

Command details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\RemoveCombinationCommandHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\RemoveCombinationCommandHandlerInterface
Return type void

SetCombinationDefaultSupplierCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\SetCombinationDefaultSupplierCommand __

Command details
Constructor parameters
  • $int $combinationId
  • $int $defaultSupplierId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\SetCombinationDefaultSupplierHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\SetCombinationDefaultSupplierHandlerInterface
Return type void

SetCombinationImagesCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\SetCombinationImagesCommand __

Command details
Constructor parameters
  • $int $combinationId
  • $array $imageIds
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\SetCombinationImagesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\SetCombinationImagesHandlerInterface
Return type void

SetCombinationSuppliersCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\SetCombinationSuppliersCommand Associates supplier with product combination

Command details
Constructor parameters
  • $int $combinationId
  • $array $combinationSuppliers
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\SetCombinationSuppliersHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\SetCombinationSuppliersHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Supplier\ValueObject\ProductSupplierId[]

UpdateCombinationDetailsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\UpdateCombinationDetailsCommand Updates combination details

Command details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\UpdateCombinationDetailsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\UpdateCombinationDetailsHandlerInterface
Return type void

UpdateCombinationFromListingCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\UpdateCombinationFromListingCommand __

Command details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\UpdateCombinationFromListingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\UpdateCombinationFromListingHandlerInterface
Return type void

UpdateCombinationPricesCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\UpdateCombinationPricesCommand __

Command details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\UpdateCombinationPricesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\UpdateCombinationPricesHandlerInterface
Return type void

UpdateCombinationStockCommand

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Command\UpdateCombinationStockCommand Updates combination stock information

Command details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\CommandHandler\UpdateCombinationStockHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\CommandHandler\UpdateCombinationStockHandlerInterface
Return type void

AddProductCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\AddProductCommand Command for creating product with basic information

Command details
Constructor parameters
  • $array $localizedNames
  • $string $productType
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\AddProductHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\AddProductHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\ValueObject\ProductId

AssignProductToCategoryCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\AssignProductToCategoryCommand Class AssignProductToCategoryCommand adds a product to a category.

Command details
Constructor parameters
  • $int $categoryId
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\AssignProductToCategoryHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\AssignProductToCategoryHandlerInterface
Return type void

AssociateProductAttachmentCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\AssociateProductAttachmentCommand Associates product with attachment

Command details
Constructor parameters
  • $int $productId
  • $int $attachmentId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\AssociateProductAttachmentHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\AssociateProductAttachmentHandlerInterface
Return type void

BulkDeleteProductCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\BulkDeleteProductCommand Deletes multiple products

Command details
Constructor parameters
  • $array $productIds
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\BulkDeleteProductHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\BulkDeleteProductHandlerInterface
Return type void

DeleteProductCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\DeleteProductCommand Deletes product

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\DeleteProductHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\DeleteProductHandlerInterface
Return type void

DuplicateProductCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\DuplicateProductCommand Duplicates product

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\DuplicateProductHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\DuplicateProductHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\ValueObject\ProductId

RemoveAllAssociatedProductAttachmentsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\RemoveAllAssociatedProductAttachmentsCommand Removes all product-attachment associations for provided product

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\RemoveAllAssociatedProductAttachmentsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\RemoveAllAssociatedProductAttachmentsHandlerInterface
Return type void

RemoveAllAssociatedProductCategoriesCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\RemoveAllAssociatedProductCategoriesCommand Removes all product-category associations

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\RemoveAllAssociatedProductCategoriesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\RemoveAllAssociatedProductCategoriesHandlerInterface
Return type void

RemoveAllProductTagsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\RemoveAllProductTagsCommand Removes all Tags for product

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\RemoveAllProductTagsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\RemoveAllProductTagsHandlerInterface
Return type void

RemoveAllRelatedProductsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\RemoveAllRelatedProductsCommand Removes all related products from given product

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\RemoveAllRelatedProductsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\RemoveAllRelatedProductsHandlerInterface
Return type void

SetAssociatedProductAttachmentsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\SetAssociatedProductAttachmentsCommand Replaces previous product attachments association with the provided one.

Command details
Constructor parameters
  • $int $productId
  • $array $attachmentIds
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\SetAssociatedProductAttachmentsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\SetAssociatedProductAttachmentsHandlerInterface
Return type void

SetAssociatedProductCategoriesCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\SetAssociatedProductCategoriesCommand Sets new product-category associations

Command details
Constructor parameters
  • $int $productId
  • $int $defaultCategoryId
  • $array $categoryIds
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\SetAssociatedProductCategoriesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\SetAssociatedProductCategoriesHandlerInterface
Return type void

SetProductTagsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\SetProductTagsCommand Updates product tags in provided languages

Command details
Constructor parameters
  • $int $productId
  • $array $localizedTags
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\SetProductTagsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductTagsHandlerInterface
Return type void

SetRelatedProductsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\SetRelatedProductsCommand Sets related products for product

Command details
Constructor parameters
  • $int $productId
  • $array $relatedProductIds
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\SetRelatedProductsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\SetRelatedProductsHandlerInterface
Return type void

UpdateProductBasicInformationCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductBasicInformationCommand Command to update some basic properties of product

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductBasicInformationHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductBasicInformationHandlerInterface
Return type void

UpdateProductDetailsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductDetailsCommand Updates product details

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductDetailsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductDetailsHandlerInterface
Return type void

UpdateProductOptionsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductOptionsCommand __

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductOptionsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductOptionsHandlerInterface
Return type void

UpdateProductPricesCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductPricesCommand Responsible for updating information associated with product price

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductPricesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductPricesHandlerInterface
Return type void

UpdateProductSeoCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductSeoCommand Updates Product SEO options

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductSeoHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductSeoHandlerInterface
Return type void

UpdateProductShippingCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductShippingCommand Updates product shipping options

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductShippingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductShippingHandlerInterface
Return type void

UpdateProductStatusCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductStatusCommand Class UpdateProductStatusCommand update a given product status

Command details
Constructor parameters
  • $int $productId
  • $bool $enable
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductStatusCommandHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductStatusCommandHandlerInterface
Return type void

UpdateProductTypeCommand

PrestaShop\PrestaShop\Core\Domain\Product\Command\UpdateProductTypeCommand __

Command details
Constructor parameters
  • $int $productId
  • $string $productType
Handler class PrestaShop\PrestaShop\Adapter\Product\CommandHandler\UpdateProductTypeHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\CommandHandler\UpdateProductTypeHandlerInterface
Return type void

RemoveAllCustomizationFieldsFromProductCommand

PrestaShop\PrestaShop\Core\Domain\Product\Customization\Command\RemoveAllCustomizationFieldsFromProductCommand Removes all customization fields from product

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\Customization\CommandHandler\RemoveAllCustomizationFieldsFromProductHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Customization\CommandHandler\RemoveAllCustomizationFieldsFromProductHandlerInterface
Return type void

SetProductCustomizationFieldsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Customization\Command\SetProductCustomizationFieldsCommand Sets product customization fields

Command details
Constructor parameters
  • $int $productId
  • $array $customizationFields
Handler class PrestaShop\PrestaShop\Adapter\Product\Customization\CommandHandler\SetProductCustomizationFieldsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Customization\CommandHandler\SetProductCustomizationFieldsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Customization\ValueObject\CustomizationFieldId[]

RemoveAllFeatureValuesFromProductCommand

PrestaShop\PrestaShop\Core\Domain\Product\FeatureValue\Command\RemoveAllFeatureValuesFromProductCommand Removes all product feature values

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\FeatureValue\CommandHandler\RemoveAllFeatureValuesFromProductHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\FeatureValue\CommandHandler\RemoveAllFeatureValuesFromProductHandlerInterface
Return type void

SetProductFeatureValuesCommand

PrestaShop\PrestaShop\Core\Domain\Product\FeatureValue\Command\SetProductFeatureValuesCommand Sets product feature values

Command details
Constructor parameters
  • $int $productId
  • $array $featureValues
Handler class PrestaShop\PrestaShop\Adapter\Product\FeatureValue\CommandHandler\SetProductFeatureValuesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\FeatureValue\CommandHandler\SetProductFeatureValuesHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Feature\ValueObject\FeatureValueId[]

AddProductImageCommand

PrestaShop\PrestaShop\Core\Domain\Product\Image\Command\AddProductImageCommand Adds new product image

Command details
Constructor parameters
  • $int $productId
  • $string $pathName
Handler class PrestaShop\PrestaShop\Adapter\Product\Image\CommandHandler\AddProductImageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Image\CommandHandler\AddProductImageHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Image\ValueObject\ImageId

DeleteProductImageCommand

PrestaShop\PrestaShop\Core\Domain\Product\Image\Command\DeleteProductImageCommand Deletes product image

Command details
Constructor parameters
  • $int $imageId
Handler class PrestaShop\PrestaShop\Adapter\Product\Image\CommandHandler\DeleteProductImageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Image\CommandHandler\DeleteProductImageHandlerInterface
Return type void

UpdateProductImageCommand

PrestaShop\PrestaShop\Core\Domain\Product\Image\Command\UpdateProductImageCommand __

Command details
Constructor parameters
  • $int $imageId
Handler class PrestaShop\PrestaShop\Adapter\Product\Image\CommandHandler\UpdateProductImageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Image\CommandHandler\UpdateProductImageHandlerInterface
Return type void

RemoveAllProductsFromPackCommand

PrestaShop\PrestaShop\Core\Domain\Product\Pack\Command\RemoveAllProductsFromPackCommand Removes all products from provided pack

Command details
Constructor parameters
  • $int $packId
Handler class PrestaShop\PrestaShop\Adapter\Product\Pack\CommandHandler\RemoveAllProductsFromPackHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Pack\CommandHandler\RemoveAllProductsFromPackHandlerInterface
Return type void

SetPackProductsCommand

PrestaShop\PrestaShop\Core\Domain\Product\Pack\Command\SetPackProductsCommand Sets products of product pack

Command details
Constructor parameters
  • $int $packId
  • $array $products
Handler class PrestaShop\PrestaShop\Adapter\Product\Pack\CommandHandler\SetPackProductsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Pack\CommandHandler\SetPackProductsHandlerInterface
Return type void

AddProductSpecificPriceCommand

PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\Command\AddProductSpecificPriceCommand Add specific price to a Product

Command details
Constructor parameters
  • $int $productId
  • $string $reductionType
  • $float $reductionValue
  • $bool $includeTax
  • $float $price
  • $int $fromQuantity
Handler class PrestaShop\PrestaShop\Adapter\Product\SpecificPrice\CommandHandler\AddProductSpecificPriceHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\CommandHandler\AddProductSpecificPriceHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\SpecificPrice\ValueObject\SpecificPriceId

SetGlobalSpecificPricePriorityCommand

PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\Command\SetGlobalSpecificPricePriorityCommand Sets global priorities for specific price

Command details
Constructor parameters
  • $array $priorityList
Handler class PrestaShop\PrestaShop\Adapter\Product\SpecificPrice\CommandHandler\SetGlobalSpecificPricePriorityHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\CommandHandler\SetGlobalSpecificPricePriorityHandlerInterface
Return type void

SetSpecificPricePriorityForProductCommand

PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\Command\SetSpecificPricePriorityForProductCommand Sets specific price priority for provided product

Command details
Constructor parameters
  • $int $productId
  • $array $priorities
Handler class PrestaShop\PrestaShop\Adapter\Product\SpecificPrice\CommandHandler\SetSpecificPricePriorityForProductHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\CommandHandler\SetSpecificPricePriorityForProductHandlerInterface
Return type void

UpdateProductStockInformationCommand

PrestaShop\PrestaShop\Core\Domain\Product\Stock\Command\UpdateProductStockInformationCommand Class UpdateProductStockInformationCommand update a given product stock

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\Stock\CommandHandler\UpdateProductStockInformationHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Stock\CommandHandler\UpdateProductStockInformationHandlerInterface
Return type void

RemoveAllAssociatedProductSuppliersCommand

PrestaShop\PrestaShop\Core\Domain\Product\Supplier\Command\RemoveAllAssociatedProductSuppliersCommand Removes all product suppliers for specified product without combinations

Command details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\Supplier\CommandHandler\RemoveAllAssociatedProductSuppliersHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Supplier\CommandHandler\RemoveAllAssociatedProductSuppliersHandlerInterface
Return type void

SetProductDefaultSupplierCommand

PrestaShop\PrestaShop\Core\Domain\Product\Supplier\Command\SetProductDefaultSupplierCommand __

Command details
Constructor parameters
  • $int $productId
  • $int $defaultSupplierId
Handler class PrestaShop\PrestaShop\Adapter\Product\Supplier\CommandHandler\SetProductDefaultSupplierHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Supplier\CommandHandler\SetProductDefaultSupplierHandlerInterface
Return type void

SetProductSuppliersCommand

PrestaShop\PrestaShop\Core\Domain\Product\Supplier\Command\SetProductSuppliersCommand Updates product suppliers

Command details
Constructor parameters
  • $int $productId
  • $array $productSuppliers
Handler class PrestaShop\PrestaShop\Adapter\Product\Supplier\CommandHandler\SetProductSuppliersHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Supplier\CommandHandler\SetProductSuppliersHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Supplier\ValueObject\ProductSupplierId[]

AddVirtualProductFileCommand

PrestaShop\PrestaShop\Core\Domain\Product\VirtualProductFile\Command\AddVirtualProductFileCommand Adds downloadable file for virtual product

Command details
Constructor parameters
  • $int $productId
  • $string $filePath
  • $string $displayName
  • $?int $accessDays = NULL
  • $?int $downloadTimesLimit = NULL
  • $?DateTimeInterface $expirationDate = NULL
Handler class PrestaShop\PrestaShop\Adapter\Product\VirtualProduct\CommandHandler\AddVirtualProductFileHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\VirtualProductFile\CommandHandler\AddVirtualProductFileHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\VirtualProductFile\ValueObject\VirtualProductFileId

DeleteVirtualProductFileCommand

PrestaShop\PrestaShop\Core\Domain\Product\VirtualProductFile\Command\DeleteVirtualProductFileCommand __

Command details
Constructor parameters
  • $int $virtualProductFileId
Handler class PrestaShop\PrestaShop\Adapter\Product\VirtualProduct\CommandHandler\DeleteVirtualProductFileHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\VirtualProductFile\CommandHandler\DeleteVirtualProductFileHandlerInterface
Return type void

UpdateVirtualProductFileCommand

PrestaShop\PrestaShop\Core\Domain\Product\VirtualProductFile\Command\UpdateVirtualProductFileCommand __

Command details
Constructor parameters
  • $int $virtualProductFileId
Handler class PrestaShop\PrestaShop\Adapter\Product\VirtualProduct\CommandHandler\UpdateVirtualProductFileHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\VirtualProductFile\CommandHandler\UpdateVirtualProductFileHandlerInterface
Return type void

Product Queries

GetAttributeGroupList

PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Query\GetAttributeGroupList Get list of Attribute groups in the shop (with or without their associated attributes)

Query details
Constructor parameters
  • $bool $withAttributes
Handler class PrestaShop\PrestaShop\Adapter\Product\AttributeGroup\QueryHandler\GetAttributeGroupListHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\QueryHandler\GetAttributeGroupListHandlerInterface
Return type array

GetProductAttributeGroups

PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\Query\GetProductAttributeGroups Query which provides attributes of a Product by group

Query details
Constructor parameters
  • $int $productId
  • $bool $withAttributes
Handler class PrestaShop\PrestaShop\Adapter\Product\AttributeGroup\QueryHandler\GetProductAttributeGroupsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\QueryHandler\GetProductAttributeGroupsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\AttributeGroup\QueryResult\AttributeGroup[]

GetCombinationForEditing

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Query\GetCombinationForEditing Query which provides combination for editing

Query details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\QueryHandler\GetCombinationForEditingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\QueryHandler\GetCombinationForEditingHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Combination\QueryResult\CombinationForEditing

GetCombinationSuppliers

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Query\GetCombinationSuppliers Retrieves data for product combination supplier

Query details
Constructor parameters
  • $int $combinationId
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\QueryHandler\GetCombinationSuppliersHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\QueryHandler\GetCombinationSuppliersHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Supplier\QueryResult\ProductSupplierInfo[]

GetEditableCombinationsList

PrestaShop\PrestaShop\Core\Domain\Product\Combination\Query\GetEditableCombinationsList Retrieves product combinations

Query details
Constructor parameters
  • $int $productId
  • $int $languageId
  • $?int $limit = NULL
  • $?int $offset = NULL
  • $?string $orderBy = NULL
  • $?string $orderWay = NULL
  • `$array $filters = array (
)`
Handler class PrestaShop\PrestaShop\Adapter\Product\Combination\QueryHandler\GetEditableCombinationsListHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Combination\QueryHandler\GetEditableCombinationsListHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Combination\QueryResult\CombinationListForEditing

GetProductCustomizationFields

PrestaShop\PrestaShop\Core\Domain\Product\Customization\Query\GetProductCustomizationFields Gets product customization fields

Query details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\Customization\QueryHandler\GetProductCustomizationFieldsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Customization\QueryHandler\GetProductCustomizationFieldsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Customization\QueryResult\CustomizationField[]

GetProductFeatureValues

PrestaShop\PrestaShop\Core\Domain\Product\FeatureValue\Query\GetProductFeatureValues Get FeatureValue associated to a Product

Query details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\FeatureValue\QueryHandler\GetProductFeatureValuesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\FeatureValue\QueryHandler\GetProductFeatureValuesHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\FeatureValue\QueryResult\ProductFeatureValue[]

GetProductImage

PrestaShop\PrestaShop\Core\Domain\Product\Image\Query\GetProductImage __

Query details
Constructor parameters
  • $int $imageId
Handler class PrestaShop\PrestaShop\Adapter\Product\Image\QueryHandler\GetProductImageHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Image\QueryHandler\GetProductImageHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Image\QueryResult\ProductImage

GetProductImages

PrestaShop\PrestaShop\Core\Domain\Product\Image\Query\GetProductImages Get list of Images associated to a Product

Query details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\Image\QueryHandler\GetProductImagesHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Image\QueryHandler\GetProductImagesHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Image\QueryResult\ProductImage[]

GetPackedProducts

PrestaShop\PrestaShop\Core\Domain\Product\Pack\Query\GetPackedProducts Retrieves product from a pack

Query details
Constructor parameters
  • $int $packId
Handler class PrestaShop\PrestaShop\Adapter\Product\Pack\QueryHandler\GetPackedProductsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Pack\QueryHandler\GetPackedProductsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Pack\QueryResult\PackedProduct[]

GetProductForEditing

PrestaShop\PrestaShop\Core\Domain\Product\Query\GetProductForEditing Get Product data necessary for editing

Query details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\QueryHandler\GetProductForEditingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\QueryHandler\GetProductForEditingHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\QueryResult\ProductForEditing

GetProductIsEnabled

PrestaShop\PrestaShop\Core\Domain\Product\Query\GetProductIsEnabled Get current status (enabled/disabled) for a given product

Query details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\QueryHandler\GetProductIsEnabledHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\QueryHandler\GetProductIsEnabledHandlerInterface
Return type bool

GetProductSupplierOptions

PrestaShop\PrestaShop\Core\Domain\Product\Supplier\Query\GetProductSupplierOptions Provides product supplier options

Query details
Constructor parameters
  • $int $productId
Handler class PrestaShop\PrestaShop\Adapter\Product\QueryHandler\GetProductSupplierOptionsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\Supplier\QueryHandler\GetProductSupplierOptionsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\Supplier\QueryResult\ProductSupplierOptions

GetRelatedProducts

PrestaShop\PrestaShop\Core\Domain\Product\Query\GetRelatedProducts Provides related products for given product

Query details
Constructor parameters
  • $int $productId
  • $int $languageId
Handler class PrestaShop\PrestaShop\Adapter\Product\QueryHandler\GetRelatedProductsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\QueryHandler\GetRelatedProductsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\QueryResult\RelatedProduct[]

SearchProducts

PrestaShop\PrestaShop\Core\Domain\Product\Query\SearchProducts Queries for products by provided search phrase

Query details
Constructor parameters
  • $string $phrase
  • $int $resultsLimit
  • $string $isoCode
  • $?int $orderId = NULL
Handler class PrestaShop\PrestaShop\Adapter\Product\QueryHandler\SearchProductsHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\QueryHandler\SearchProductsHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\QueryResult\FoundProduct[]

GetEditableSpecificPricesList

PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\Query\GetEditableSpecificPricesList Retrieves product specific prices

Query details
Constructor parameters
  • $int $productId
  • $?int $limit = NULL
  • $?int $offset = NULL
  • $?array $filters = NULL
Handler class PrestaShop\PrestaShop\Adapter\Product\SpecificPrice\QueryHandler\GetEditableSpecificPricesListHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\QueryHandler\GetEditableSpecificPricesListHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\QueryResult\SpecificPriceListForEditing

GetSpecificPriceForEditing

PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\Query\GetSpecificPriceForEditing Query which provides specific price for editing

Query details
Constructor parameters
  • $int $specificPriceId
Handler class PrestaShop\PrestaShop\Adapter\Product\SpecificPrice\QueryHandler\GetSpecificPriceForEditingHandler

Implements:

  • PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\QueryHandler\GetSpecificPriceForEditingHandlerInterface
Return type PrestaShop\PrestaShop\Core\Domain\Product\SpecificPrice\QueryResult\SpecificPriceForEditing