ProductWriteService
in package
implements
ProductWriteServiceInterface
Class ProductWriteService
Tags
Interfaces, Classes and Traits
- ProductWriteServiceInterface
- Interface ProductWriteServiceInterface
Table of Contents
- $deleteHistoryService : DeleteHistoryWriteService
- $envProductImagePathsSettings : ProductImagePathsSettingsInterface
- EnvProductImagePathsSettings.
- $languageProvider : LanguageProviderInterface
- Used for fetching the language data.
- $productImageStorage : AbstractFileStorage
- The product image storage.
- $productLinker : ProductCategoryLinkerInterface
- The product category linker.
- $productRepo : ProductRepositoryInterface
- The product repository.
- $urlKeywordsRepairer : UrlKeywordsRepairerInterface
- Used for writing and repairing product's url keywords
- __construct() : mixed
- ProductWriteService constructor.
- changeProductLink() : ProductWriteService
- Changes the category link of a product.
- createProduct() : int
- Create Product
- deleteProductById() : ProductWriteServiceInterface
- Delete Product
- deleteProductImage() : ProductWriteService
- Delete Product Image
- deleteProductLink() : ProductWriteService
- Removes a category link from a product by the given product id.
- deleteProductLinks() : ProductWriteService
- Removes all category links from a product by given product ID.
- duplicateProduct() : int
- Duplicate Product
- importProductImageFile() : string
- Import Product Image File
- linkProduct() : ProductWriteService
- Link Product
- processProductImage() : ProductWriteService
- Processes an image for the front end.
- renameProductImage() : ProductWriteService
- Rename Product Image File
- unlinkProduct() : ProductWriteServiceInterface|$this
- Unlink a product.
- updateProduct() : ProductWriteServiceInterface
- Update Product
- duplicateProductImage() : ProductImageInterface
- Duplicates a given Product Image and set the properties accordingly to the provided Source Product Image
- imageCanBeRemoved() : bool
Properties
$deleteHistoryService
protected
DeleteHistoryWriteService
$deleteHistoryService
$envProductImagePathsSettings
EnvProductImagePathsSettings.
protected
ProductImagePathsSettingsInterface
$envProductImagePathsSettings
$languageProvider
Used for fetching the language data.
protected
LanguageProviderInterface
$languageProvider
$productImageStorage
The product image storage.
protected
AbstractFileStorage
$productImageStorage
$productLinker
The product category linker.
protected
ProductCategoryLinkerInterface
$productLinker
$productRepo
The product repository.
protected
ProductRepositoryInterface
$productRepo
$urlKeywordsRepairer
Used for writing and repairing product's url keywords
protected
UrlKeywordsRepairerInterface
$urlKeywordsRepairer
Methods
__construct()
ProductWriteService constructor.
public
__construct(ProductRepositoryInterface $productRepo, AbstractFileStorage $productImageStorage, ProductCategoryLinkerInterface $productLinker, ProductImagePathsSettingsInterface $envProductImagePathsSettings, LanguageProviderInterface $languageProvider, UrlKeywordsRepairerInterface $urlKeywordsRepairer, DeleteHistoryWriteService $deleteHistoryService) : mixed
Parameters
- $productRepo : ProductRepositoryInterface
- $productImageStorage : AbstractFileStorage
- $productLinker : ProductCategoryLinkerInterface
- $envProductImagePathsSettings : ProductImagePathsSettingsInterface
- $languageProvider : LanguageProviderInterface
- $urlKeywordsRepairer : UrlKeywordsRepairerInterface
- $deleteHistoryService : DeleteHistoryWriteService
Return values
mixed —changeProductLink()
Changes the category link of a product.
public
changeProductLink(IdType $productId, IdType $currentCategoryId, IdType $newCategoryId) : ProductWriteService
Parameters
- $productId : IdType
-
The product ID of the product to move.
- $currentCategoryId : IdType
-
Old category ID of the product.
- $newCategoryId : IdType
-
New category ID of the product.
Return values
ProductWriteService —Same instance for chained method calls.
createProduct()
Create Product
public
createProduct(ProductInterface $product) : int
Creates a new product and returns the ID of it.
Parameters
- $product : ProductInterface
-
The product to create.
Tags
Return values
int —The ID of the created product.
deleteProductById()
Delete Product
public
deleteProductById(IdType $productId) : ProductWriteServiceInterface
Deletes a specific product, depending on the provided product ID.
Parameters
- $productId : IdType
-
The product ID of the product to delete.
Return values
ProductWriteServiceInterface —Same instance for chained method calls.
deleteProductImage()
Delete Product Image
public
deleteProductImage(FilenameStringType $filename) : ProductWriteService
Deletes a product image.
Parameters
- $filename : FilenameStringType
-
The filename of the product image to delete.
Return values
ProductWriteService —Same instance for chained method calls.
deleteProductLink()
Removes a category link from a product by the given product id.
public
deleteProductLink(IdType $productId, IdType $categoryId) : ProductWriteService
Parameters
- $productId : IdType
-
Id of the product.
- $categoryId : IdType
-
Id of category from where the product is link is to delete.
Return values
ProductWriteService —Same instance for chained method calls.
deleteProductLinks()
Removes all category links from a product by given product ID.
public
deleteProductLinks(IdType $productId) : ProductWriteService
Parameters
- $productId : IdType
-
ID of product.
Return values
ProductWriteService —Same instance for chained method calls.
duplicateProduct()
Duplicate Product
public
duplicateProduct(IdType $productId, IdType $targetCategoryId[, BoolType $duplicateAttributes = null ][, BoolType $duplicateSpecials = null ][, BoolType $duplicateCrossSelling = null ]) : int
Duplicates a product to a category.
Parameters
- $productId : IdType
-
The product ID of the product to duplicate.
- $targetCategoryId : IdType
-
The target category ID of the product to be duplicated to.s
- $duplicateAttributes : BoolType = null
-
Should the attributes be duplicated also?
- $duplicateSpecials : BoolType = null
-
Should the specials be duplicated also?
- $duplicateCrossSelling : BoolType = null
-
Should cross selling be duplicated also?
Tags
Return values
int —Returns the ID of the new product.
importProductImageFile()
Import Product Image File
public
importProductImageFile(ExistingFile $sourceFile, FilenameStringType $preferredFilename) : string
Imports an image for the product.
Parameters
- $sourceFile : ExistingFile
-
The existing file to import.
- $preferredFilename : FilenameStringType
-
The preferred filename.
Tags
Return values
string —The new filename.
linkProduct()
Link Product
public
linkProduct(IdType $productId, IdType $targetCategoryId) : ProductWriteService
Links a product to a category.
Parameters
- $productId : IdType
-
The product ID of the product to link.
- $targetCategoryId : IdType
-
The target category ID, of the category to be linked to.
Return values
ProductWriteService —Same instance for chained method calls.
processProductImage()
Processes an image for the front end.
public
processProductImage(FilenameStringType $productImage) : ProductWriteService
Parameters
- $productImage : FilenameStringType
Return values
ProductWriteService —Same instance for chained method calls.
renameProductImage()
Rename Product Image File
public
renameProductImage(FilenameStringType $oldName, FilenameStringType $newName) : ProductWriteService
Renames a product image file.
Parameters
- $oldName : FilenameStringType
-
The old name of the product image file.
- $newName : FilenameStringType
-
The new name of the product image file.
Tags
Return values
ProductWriteService —Same instance for chained method calls.
unlinkProduct()
Unlink a product.
public
unlinkProduct(IdType $productId, IdCollection $categoryIds) : ProductWriteServiceInterface|$this
Deletes the product if all category links are removed.
Parameters
- $productId : IdType
-
Id of product to be unlinked.
- $categoryIds : IdCollection
-
Ids of categories to be unlinked.
Return values
ProductWriteServiceInterface|$this —Same instance for chained method calls.
updateProduct()
Update Product
public
updateProduct(StoredProductInterface $product[, stdClass $rawProduct = null ]) : ProductWriteServiceInterface
Updates a stored product.
Parameters
- $product : StoredProductInterface
-
The product to update.
- $rawProduct : stdClass = null
Return values
ProductWriteServiceInterface —Same instance for chained method calls.
duplicateProductImage()
Duplicates a given Product Image and set the properties accordingly to the provided Source Product Image
protected
duplicateProductImage(ProductImageInterface $sourceProductImage) : ProductImageInterface
Parameters
- $sourceProductImage : ProductImageInterface
-
The Product Image to duplicate.
Return values
ProductImageInterface —The duplicated Product Image.
imageCanBeRemoved()
private
imageCanBeRemoved(ProductImageInterface $image) : bool
Parameters
- $image : ProductImageInterface