1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
<?php
/* --------------------------------------------------------------
CategoryWriteService.inc.php 2016-06-27
Gambio GmbH
http://www.gambio.de
Copyright (c) 2016 Gambio GmbH
Released under the GNU General Public License (Version 2)
[http://www.gnu.org/licenses/gpl-2.0.html]
--------------------------------------------------------------
*/
/**
* Class CategoryWriteService
*
* This class provides methods for creating, updating and deleting categories data.
*
* @category System
* @package Category
* @implements CategoryWriteServiceInterface
*/
class CategoryWriteService implements CategoryWriteServiceInterface
{
/**
* Category repository.
*
* @var CategoryRepositoryInterface
*/
protected $categoryRepo;
/**
* Category image.
*
* @var AbstractFileStorage
*/
protected $categoryImageStorage;
/**
* Category icon.
*
* @var AbstractFileStorage
*/
protected $categoryIconStorage;
/**
* ProductPermissionSetter
*
* @var ProductPermissionSetterInterface
*/
protected $productPermissionSetter;
/**
* Used for writing and repairing category's url keywords
*
* @var UrlKeywordsRepairerInterface
*/
protected $urlKeywordsRepairer;
/**
* CategoryWriteService constructor.
*
* @param CategoryRepositoryInterface $categoryRepo Category repository.
* @param AbstractFileStorage $categoryImageStorage Category image.
* @param AbstractFileStorage $categoryIconStorage Category icon.
* @param ProductPermissionSetterInterface $productPermissionSetter ProductPermissionSetter.
* @param UrlKeywordsRepairerInterface $urlKeywordsRepairer
*/
public function __construct(CategoryRepositoryInterface $categoryRepo,
AbstractFileStorage $categoryImageStorage,
AbstractFileStorage $categoryIconStorage,
ProductPermissionSetterInterface $productPermissionSetter,
UrlKeywordsRepairerInterface $urlKeywordsRepairer)
{
$this->categoryRepo = $categoryRepo;
$this->categoryImageStorage = $categoryImageStorage;
$this->categoryIconStorage = $categoryIconStorage;
$this->productPermissionSetter = $productPermissionSetter;
$this->urlKeywordsRepairer = $urlKeywordsRepairer;
}
/**
* Stores a category in the database and returns the newly created ID of it.
*
* @param CategoryInterface $category The category to store.
*
* @return int Returns the ID of the new category record.
*/
public function createCategory(CategoryInterface $category)
{
$categoryId = $this->categoryRepo->add($category);
// set url keywords
$this->urlKeywordsRepairer->repair('categories');
return $categoryId;
}
/**
* Updates the provided category and returns itself.
*
* @param StoredCategoryInterface $category The category to update.
*
* @return CategoryWriteService Same instance for chained method calls.
*/
public function updateCategory(StoredCategoryInterface $category)
{
$this->categoryRepo->store($category);
// set url keywords
$this->urlKeywordsRepairer->repair('categories');
return $this;
}
/**
* Deletes a category depending on the provided category ID.
*
* @param IdType $categoryId Category ID of the category to delete.
*
* @return CategoryWriteService Same instance for chained method calls.
*/
public function deleteCategoryById(IdType $categoryId)
{
$category = $this->categoryRepo->getCategoryById($categoryId);
$this->categoryIconStorage->deleteFile(new FilenameStringType($category->getIcon()));
$this->categoryImageStorage->deleteFile(new FilenameStringType($category->getImage()));
$this->categoryRepo->deleteCategoryById($categoryId);
return $this;
}
/**
* 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.
*
* @param IdType $categoryId Category ID of the category to move.
* @param IdType $newParentId The new parent ID.
*
* @return CategoryWriteService Same instance for chained method calls.
*/
public function moveCategory(IdType $categoryId, IdType $newParentId)
{
$storedCategory = $this->categoryRepo->getCategoryById($categoryId);
$storedCategory->setParentId($newParentId);
$this->categoryRepo->store($storedCategory);
return $this;
}
/**
* 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.
*
* @param IdType $categoryId The category ID of the category to duplicate.
* @param IdType $targetParentId The target parent ID of the duplicated category.
* @param BoolType $duplicateProducts Should the products be duplicated?
* @param BoolType $duplicateAttributes Should the attributes be duplicated?
* @param BoolType $duplicateSpecials Should the specials be duplicated?
* @param BoolType $duplicateCrossSelling Should cross selling be duplicated?
*
* @return int Returns the ID of the new category record.
*
* @todo Implement the last four arguments when finished in UML.
*/
public function duplicateCategory(IdType $categoryId,
IdType $targetParentId,
BoolType $duplicateProducts = null,
BoolType $duplicateAttributes = null,
BoolType $duplicateSpecials = null,
BoolType $duplicateCrossSelling = null)
{
$storedCategory = $this->categoryRepo->getCategoryById($categoryId);
$storedCategory->setParentId($targetParentId);
$newCategoryId = $this->categoryRepo->add($storedCategory);
// set url keywords
$this->urlKeywordsRepairer->repair('categories');
return $newCategoryId;
}
/**
* Imports an image file and stores it.
*
* @param ExistingFile $sourceFile The image file to import.
* @param FilenameStringType $saveAsFilename The name under which the image should to be stored.
*
* @return string The new filename.
*/
public function importCategoryImageFile(ExistingFile $sourceFile, FilenameStringType $saveAsFilename)
{
return $this->categoryImageStorage->importFile($sourceFile, $saveAsFilename);
}
/**
* Imports an icon file and stores it.
*
* @param ExistingFile $sourceFile The icon file to import.
* @param FilenameStringType $saveAsFilename The name under which the icon should be stored.
*
* @return string The new filename.
*/
public function importCategoryIconFile(ExistingFile $sourceFile, FilenameStringType $saveAsFilename)
{
return $this->categoryIconStorage->importFile($sourceFile, $saveAsFilename);
}
/**
* Renames a category image file.
*
* @param FilenameStringType $oldName Old file name.
* @param FilenameStringType $newName New file name.
*
* @return CategoryWriteServiceInterface Same instance for chained method calls.
*/
public function renameCategoryImageFile(FilenameStringType $oldName, FilenameStringType $newName)
{
$this->categoryImageStorage->renameFile($oldName, $newName);
return $this;
}
/**
* Renames a category icon file.
*
* @param FilenameStringType $oldName Old file name.
* @param FilenameStringType $newName New file name.
*
* @return CategoryWriteServiceInterface Same instance for chained method calls.
*/
public function renameCategoryIconFile(FilenameStringType $oldName, FilenameStringType $newName)
{
$this->categoryIconStorage->renameFile($oldName, $newName);
return $this;
}
/**
* Deletes a category image file.
*
* @param FilenameStringType $filename Category image file name.
*
* @return CategoryWriteServiceInterface Same instance for chained method calls.
*/
public function deleteCategoryImageFile(FilenameStringType $filename)
{
$this->categoryImageStorage->deleteFile($filename);
return $this;
}
/**
* Deletes a category icon file.
*
* @param FilenameStringType $filename Category icon file name.
*
* @return CategoryWriteServiceInterface Same instance for chained method calls.
*/
public function deleteCategoryIconFile(FilenameStringType $filename)
{
$this->categoryIconStorage->deleteFile($filename);
return $this;
}
/**
* Activates a specific category and its subcategories if desired.
*
* @param IdType $categoryId Category ID of the category to activate.
* @param BoolType $includeSubcategories Shall the subcategories be activated also?
*
* @return CategoryWriteServiceInterface Same instance for chained method calls.
*/
public function activateCategory(IdType $categoryId, BoolType $includeSubcategories)
{
$storedCategory = $this->categoryRepo->getCategoryById($categoryId);
$storedCategory->setActive(new BoolType(true));
$this->categoryRepo->store($storedCategory);
if($includeSubcategories->asBool())
{
foreach($this->categoryRepo->getCategoryIdsByParentId($categoryId)->getArray() as $subCategoryId)
{
$this->activateCategory($subCategoryId, $includeSubcategories);
}
}
return $this;
}
/**
* Deactivates a specific category and its subcategories if desired.
*
* @param IdType $categoryId Category ID of the category to deactivate.
* @param BoolType $includeSubcategories Shall the subcategories be deactivated also?
*
* @return CategoryWriteServiceInterface Same instance for chained method calls.
*/
public function deactivateCategory(IdType $categoryId, BoolType $includeSubcategories)
{
$storedCategory = $this->categoryRepo->getCategoryById($categoryId);
$storedCategory->setActive(new BoolType(false));
$this->categoryRepo->store($storedCategory);
if($includeSubcategories->asBool())
{
foreach($this->categoryRepo->getCategoryIdsByParentId($categoryId)->getArray() as $subCategoryId)
{
$this->deactivateCategory($subCategoryId, $includeSubcategories);
}
}
return $this;
}
/**
* 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.
*
* @param IdType $categoryId Category ID.
* @param IdType $customerStatusId Customer status ID.
* @param BoolType $permitted Grant permission?
* @param BoolType $includeSubcategoriesAndProducts Grant permission including subcategories?
*
* @return CategoryWriteServiceInterface Same instance for chained method calls.
*/
public function setCustomerStatusPermission(IdType $categoryId,
IdType $customerStatusId,
BoolType $permitted,
BoolType $includeSubcategoriesAndProducts)
{
$storedCategory = $this->categoryRepo->getCategoryById($categoryId);
$storedCategorySettings = $storedCategory->getSettings();
$storedCategorySettings->setPermittedCustomerStatus($customerStatusId, $permitted);
$this->categoryRepo->store($storedCategory);
if($includeSubcategoriesAndProducts->asBool())
{
$this->productPermissionSetter->setProductsPermissionByCategoryId($categoryId, $customerStatusId,
$permitted);
foreach($this->categoryRepo->getCategoryIdsByParentId($categoryId)->getArray() as $subCategoryId)
{
$this->setCustomerStatusPermission($subCategoryId, $customerStatusId, $permitted,
$includeSubcategoriesAndProducts);
}
}
return $this;
}
}