Class ProductWriteService

ProductWriteService implements ProductWriteServiceInterface

Package: Product
Category: System
Located at Services/Core/Product/ProductWriteService.inc.php

Methods summary


				
				 public 
				
				

				__construct( ProductRepositoryInterface $productRepo, AbstractFileStorage $productImageStorage, ProductCategoryLinkerInterface $productLinker, ProductImagePathsSettingsInterface $envProductImagePathsSettings, LanguageProviderInterface $languageProvider, UrlKeywordsRepairerInterface $urlKeywordsRepairer )

ProductWriteService constructor.


				
				 public 
				
				

				createProduct( ProductInterface $product )
				

				: integer

Create Product

Creates a new product and returns the ID of it.

Parameters

$product: The product to create.

Returns

integer
The ID of the created product.

Throws

InvalidArgumentException
Through "linkProduct" method.

Implementation of

ProductWriteServiceInterface::createProduct()


				
				 public 
				
				

				updateProduct( StoredProductInterface $product )
				

				: ProductWriteServiceInterface

Update Product


				
				 public 
				
				

				deleteProductById( IdType $productId )
				

				: ProductWriteServiceInterface

Delete Product


				
				 public 
				
				

				duplicateProduct( IdType $productId, IdType $targetCategoryId, BoolType $duplicateAttributes = null, BoolType $duplicateSpecials = null, BoolType $duplicateCrossSelling = null )
				

				: integer

Duplicate Product

Duplicates a product to a category.

Parameters

$productId: The product ID of the product to duplicate.
$targetCategoryId: The target category ID of the product to be duplicated to.s
$duplicateAttributes: Should the attributes be duplicated also?
$duplicateSpecials: Should the specials be duplicated also?
$duplicateCrossSelling: Should cross selling be duplicated also?

Returns

integer
Returns the ID of the new product.

Throws

InvalidArgumentException
If "$newProductId" is not an integer.

Todo

Implement the last three arguments when finished in UML.

Implementation of

ProductWriteServiceInterface::duplicateProduct()


				
				 public 
				
				

				linkProduct( IdType $productId, IdType $targetCategoryId )
				

				: ProductWriteService

Link Product

Links a product to a category.

Parameters

$productId: The product ID of the product to link.
$targetCategoryId: The target category ID, of the category to be linked to.

Returns

ProductWriteService
Same instance for chained method calls.

Implementation of

ProductWriteServiceInterface::linkProduct()


				
				 public 
				
				

				unlinkProduct( IdType $productId, IdCollection $categoryIds )
				

				: ProductWriteServiceInterface|ProductWriteService

Unlink a product. Deletes the product if all category links are removed.


				
				 public 
				
				

				changeProductLink( IdType $productId, IdType $currentCategoryId, IdType $newCategoryId )
				

				: ProductWriteService

Changes the category link of a product.

Parameters

$productId: The product ID of the product to move.
$currentCategoryId: Old category ID of the product.
$newCategoryId: New category ID of the product.

Returns

ProductWriteService
Same instance for chained method calls.

Implementation of

ProductWriteServiceInterface::changeProductLink()


				
				 public 
				
				

				deleteProductLink( IdType $productId, IdType $categoryId )
				

				: ProductWriteService

Removes a category link from a product by the given product id.

Parameters

$productId: Id of the product.
$categoryId: Id of category from where the product is link is to delete.

Returns

ProductWriteService
Same instance for chained method calls.

Implementation of

ProductWriteServiceInterface::deleteProductLink()


				
				 public 
				
				

				importProductImageFile( ExistingFile $sourceFile, FilenameStringType $preferredFilename )
				

				: string

Import Product Image File

Imports an image for the product.

Parameters

$sourceFile: The existing file to import.
$preferredFilename: The preferred filename.

Returns

string
The new filename.

Throws

InvalidArgumentException
If the provided source file or the preferred filename is not valid.

Implementation of

ProductWriteServiceInterface::importProductImageFile()


				
				 public 
				
				

				renameProductImage( FilenameStringType $oldName, FilenameStringType $newName )
				

				: ProductWriteService

Rename Product Image File

Renames a product image file.

Parameters

$oldName: The old name of the product image file.
$newName: The new name of the product image file.

Returns

ProductWriteService
Same instance for chained method calls.

Throws

InvalidArgumentException
If the provided old name or new name is not valid.

Implementation of

ProductWriteServiceInterface::renameProductImage()


				
				 public 
				
				

				deleteProductImage( FilenameStringType $filename )
				

				: ProductWriteService

Delete Product Image


				
				 public 
				
				

				processProductImage( FilenameStringType $productImage )
				

				: ProductWriteService

Processes an image for the front end.


				
				 public 
				
				

				deleteProductLinks( IdType $productId )
				

				: ProductWriteService

Removes all category links from a product by given product ID.


				
				 protected 
				
				

				duplicateProductImage( ProductImageInterface $sourceProductImage )
				

				: ProductImageInterface

Duplicates a given Product Image and set the properties accordingly to the provided Source Product Image

Properties summary


				
				protected  
				

				
					$productRepo
				

				: ProductRepositoryInterface

The product repository.


				
				protected  
				

				
					$productImageStorage
				

				: AbstractFileStorage

The product image storage.


				
				protected  
				

				
					$productLinker
				

				: ProductCategoryLinkerInterface

The product category linker.


				
				protected  
				

				
					$envProductImagePathsSettings
				

				: ProductImagePathsSettingsInterface

EnvProductImagePathsSettings.


				
				protected  
				

				
					$languageProvider
				

				: LanguageProviderInterface

Used for fetching the language data.


				
				protected  
				

				
					$urlKeywordsRepairer
				

				: UrlKeywordsRepairerInterface

Used for writing and repairing product's url keywords