Class CategoryWriteService

This class provides methods for creating, updating and deleting categories data.

CategoryWriteService implements CategoryWriteServiceInterface

Package: Category
Category: System
Implements: CategoryWriteServiceInterface
Located at Services/Core/Category/CategoryWriteService.inc.php

Methods summary


				
				 public 
				
				

				__construct( CategoryRepositoryInterface $categoryRepo, AbstractFileStorage $categoryImageStorage, AbstractFileStorage $categoryIconStorage, ProductPermissionSetterInterface $productPermissionSetter, UrlKeywordsRepairerInterface $urlKeywordsRepairer, CacheControl $cacheControl )

CategoryWriteService constructor.

Parameters

$categoryRepo: Category repository.
$categoryImageStorage: Category image.
$categoryIconStorage: Category icon.
$productPermissionSetter: ProductPermissionSetter.
$urlKeywordsRepairer: Repairs urls.
$cacheControl: Used to reset category cache.


				
				 public 
				
				

				createCategory( CategoryInterface $category )
				

				: integer

Stores a category in the database and returns the newly created ID of it.

Parameters

$category: The category to store.

Returns

integer
Returns the ID of the new category record.

Implementation of

CategoryWriteServiceInterface::createCategory()


				
				 public 
				
				

				updateCategory( StoredCategoryInterface $category )
				

				: CategoryWriteService

Updates the provided category and returns itself.


				
				 public 
				
				

				deleteCategoryById( IdType $categoryId )
				

				: CategoryWriteService

Deletes a category depending on the provided category ID.


				
				 public 
				
				

				moveCategory( IdType $categoryId, IdType $newParentId )
				

				: CategoryWriteService

Moves a category into another category.

This method moves a category specified by its category ID into another parent category specified by its category ID.

Parameters

$categoryId: Category ID of the category to move.
$newParentId: The new parent ID.

Returns

CategoryWriteService
Same instance for chained method calls.

Implementation of

CategoryWriteServiceInterface::moveCategory()


				
				 public 
				
				

				duplicateCategory( IdType $categoryId, IdType $targetParentId, BoolType $duplicateProducts = null, BoolType $duplicateAttributes = null, BoolType $duplicateSpecials = null, BoolType $duplicateCrossSelling = null )
				

				: integer

Duplicates a category specified by its category ID.

This method duplicates the category which are identified by the provided category ID and links the duplicated category with the provided parent category ID. Containing subcategories and products will also be recursively duplicated with their attributes, specials and cross selling data depending on the last four arguments.

Parameters

$categoryId: The category ID of the category to duplicate.
$targetParentId: The target parent ID of the duplicated category.
$duplicateProducts: Should the products be duplicated?
$duplicateAttributes: Should the attributes be duplicated?
$duplicateSpecials: Should the specials be duplicated?
$duplicateCrossSelling: Should cross selling be duplicated?

Returns

integer
Returns the ID of the new category record.

Todo

Implement the last four arguments when finished in UML.

Implementation of

CategoryWriteServiceInterface::duplicateCategory()


				
				 public 
				
				

				importCategoryImageFile( ExistingFile $sourceFile, FilenameStringType $saveAsFilename )
				

				: string

Imports an image file and stores it.

Parameters

$sourceFile: The image file to import.
$saveAsFilename: The name under which the image should to be stored.

Returns

string
The new filename.

Implementation of

CategoryWriteServiceInterface::importCategoryImageFile()


				
				 public 
				
				

				importCategoryIconFile( ExistingFile $sourceFile, FilenameStringType $saveAsFilename )
				

				: string

Imports an icon file and stores it.

Parameters

$sourceFile: The icon file to import.
$saveAsFilename: The name under which the icon should be stored.

Returns

string
The new filename.

Implementation of

CategoryWriteServiceInterface::importCategoryIconFile()


				
				 public 
				
				

				renameCategoryImageFile( FilenameStringType $oldName, FilenameStringType $newName )
				

				: CategoryWriteServiceInterface

Renames a category image file.


				
				 public 
				
				

				renameCategoryIconFile( FilenameStringType $oldName, FilenameStringType $newName )
				

				: CategoryWriteServiceInterface

Renames a category icon file.


				
				 public 
				
				

				deleteCategoryImageFile( FilenameStringType $filename )
				

				: CategoryWriteServiceInterface

Deletes a category image file.


				
				 public 
				
				

				deleteCategoryIconFile( FilenameStringType $filename )
				

				: CategoryWriteServiceInterface

Deletes a category icon file.


				
				 public 
				
				

				activateCategory( IdType $categoryId, BoolType $includeSubcategories )
				

				: CategoryWriteServiceInterface

Activates a specific category and its subcategories if desired.

Parameters

$categoryId: Category ID of the category to activate.
$includeSubcategories: Shall the subcategories be activated also?

Returns

CategoryWriteServiceInterface
Same instance for chained method calls.

Implementation of

CategoryWriteServiceInterface::activateCategory()


				
				 public 
				
				

				deactivateCategory( IdType $categoryId, BoolType $includeSubcategories )
				

				: CategoryWriteServiceInterface

Deactivates a specific category and its subcategories if desired.

Parameters

$categoryId: Category ID of the category to deactivate.
$includeSubcategories: Shall the subcategories be deactivated also?

Returns

CategoryWriteServiceInterface
Same instance for chained method calls.

Implementation of

CategoryWriteServiceInterface::deactivateCategory()


				
				 public 
				
				

				setCustomerStatusPermission( IdType $categoryId, IdType $customerStatusId, BoolType $permitted, BoolType $includeSubcategoriesAndProducts )
				

				: CategoryWriteServiceInterface

Sets the customer status permissions.

The customer status permissions decides if the category is visible for a specific customer group. The permissions can be applied for subcategories also if desired.

Parameters

$categoryId: Category ID.
$customerStatusId: Customer status ID.
$permitted: Grant permission?
$includeSubcategoriesAndProducts: Grant permission including subcategories?

Returns

CategoryWriteServiceInterface
Same instance for chained method calls.

Implementation of

CategoryWriteServiceInterface::setCustomerStatusPermission()

Properties summary


				
				protected  
				

				
					$categoryRepo
				

				: CategoryRepositoryInterface

Category repository.


				
				protected  
				

				
					$categoryImageStorage
				

				: AbstractFileStorage

Category image.


				
				protected  
				

				
					$categoryIconStorage
				

				: AbstractFileStorage

Category icon.


				
				protected  
				

				
					$productPermissionSetter
				

				: ProductPermissionSetterInterface

ProductPermissionSetter


				
				protected  
				

				
					$urlKeywordsRepairer
				

				: UrlKeywordsRepairerInterface

Used for writing and repairing category's url keywords


				
				protected  
				

				
					$cacheControl
				

				: CacheControl