Interface CategoryWriteServiceInterface

Interface CategoryWriteServiceInterface

This interface defines methods for creating, updating and deleting categories data.

Direct known implementers

CategoryWriteService

Package: Category\Interfaces
Category: System
Located at Services/Core/Category/Entities/Interfaces/CategoryWriteServiceInterface.inc.php

Methods summary

public createCategory( CategoryInterface $category ) : integer

Creates a category and returns the ID of it.

public updateCategory( StoredCategoryInterface $category ) : CategoryWriteServiceInterface

Updates the provided category and returns itself.

public deleteCategoryById( IdType $categoryId ) : CategoryWriteServiceInterface

Deletes a category depending on the provided category ID.

public moveCategory( IdType $categoryId, IdType $newParentId ) : CategoryWriteServiceInterface

Moves a category into another category.

public duplicateCategory( IdType $categoryId, IdType $targetParentId, BoolType $duplicateProducts, BoolType $duplicateAttributes, BoolType $duplicateSpecials, BoolType $duplicateCrossSelling ) : integer

Duplicates a category specified by its category ID.

public importCategoryImageFile( ExistingFile $sourceFile, FilenameStringType $saveAsFilename ) : string

Imports an image file and stores it.

public importCategoryIconFile( ExistingFile $sourceFile, FilenameStringType $saveAsFilename ) : string

Imports an icon file and stores it.

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.

public deactivateCategory( IdType $categoryId, BoolType $includeSubcategories ) : CategoryWriteServiceInterface

Deactivates a specific category and its subcategories if desired.

public setCustomerStatusPermission( IdType $categoryId, IdType $customerStatusId, BoolType $permitted, BoolType $includeSubcategoriesAndProducts ) : CategoryWriteServiceInterface

Sets the customer status permissions.