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 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763
<?php
/* --------------------------------------------------------------
Category.inc.php 2016-06-23
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]
--------------------------------------------------------------
*/
MainFactory::load_class('CategoryInterface');
/**
* Class Category
*
* This class represents a shop category which is not persisted yet.
*
* @category System
* @package Category
* @subpackage Entities
*/
class Category implements CategoryInterface
{
/**
* Contains if category is active or not.
*
* @var bool
*/
protected $active = false;
/**
* Parent ID of the Category.
*
* @var int
*/
protected $parentId = 0;
/**
* Sort order value.
*
* @var int
*/
protected $sortOrder = 0;
/**
* Date time when the category was added.
*
* @var DateTime
*/
protected $dateAdded;
/**
* Date time when the category was modified last.
*
* @var DateTime
*/
protected $lastModified;
/**
* Category settings.
*
* @var CategorySettingsInterface
*/
protected $settings;
/**
* Names of the category.
*
* @var array
*/
protected $names = array();
/**
* Heading Titles of the category.
*
* @var array
*/
protected $headingTitles = array();
/**
* Description of the category.
*
* @var array
*/
protected $descriptions = array();
/**
* Meta title of the category.
*
* @var array
*/
protected $metaTitles = array();
/**
* Meta description of the category.
*
* @var array
*/
protected $metaDescriptions = array();
/**
* Meta keywords of the category.
*
* @var array
*/
protected $metaKeywords = array();
/**
* Url keywords of the category.
*
* @var array
*/
protected $urlKeywords = array();
/**
* URL rewrites.
*
* @var UrlRewriteCollection
*/
protected $urlRewrites;
/**
* Path to an image file.
*
* @var string
*/
protected $image = '';
/**
* Alt texts of the image.
*
* @var array
*/
protected $altTexts = array();
/**
* Path to an icon file.
*
* @var string
*/
protected $icon = '';
/**
* Addon values.
*
* @var EditableKeyValueCollection
*/
protected $addonValues;
/**
* Category constructor.
*
* @param CategorySettingsInterface $settings The category settings.
*/
public function __construct(CategorySettingsInterface $settings)
{
$this->settings = $settings;
$this->dateAdded = new DateTime();
$this->lastModified = new DateTime();
$this->addonValues = MainFactory::create('EditableKeyValueCollection', array());
$this->urlRewrites = MainFactory::create('UrlRewriteCollection', array());
}
/**
* Checks if the category is active or not.
*
* @return bool
*/
public function isActive()
{
return $this->active;
}
/**
* Sets whether category is active or not.
*
* @param BoolType $status Category active or not?
*
* @return Category Same instance for chained method calls.
*/
public function setActive(BoolType $status)
{
$this->active = $status->asBool();
return $this;
}
/**
* Returns the ID of the parent category.
*
* @return int The ID of the parent category
*/
public function getParentId()
{
return $this->parentId;
}
/**
* Sets the parent ID of the category.
*
* @param IdType $categoryId The parent ID.
*
* @return Category Same instance for chained method calls.
*/
public function setParentId(IdType $categoryId)
{
$this->parentId = $categoryId->asInt();
return $this;
}
/**
* Returns the sort order value.
*
* @return int Sort order value.
*/
public function getSortOrder()
{
return $this->sortOrder;
}
/**
* Sets the sort order to the given value.
*
* @param IntType $sortOrder Order value.
*
* @return Category Same instance for chained method calls.
*/
public function setSortOrder(IntType $sortOrder)
{
$this->sortOrder = $sortOrder->asInt();
return $this;
}
/**
* Returns the datetime when the category was added.
*
* @return DateTime
*/
public function getAddedDateTime()
{
return $this->dateAdded;
}
/**
* Sets the datetime when the category was added.
*
* @param DateTime $added Datetime of when the category has been added.
*
* @return Category Same instance for chained method calls.
*/
public function setAddedDateTime(DateTime $added)
{
$this->dateAdded = $added;
return $this;
}
/**
* Returns the datetime when the category was modified last.
*
* @return DateTime
*/
public function getLastModifiedDateTime()
{
return $this->lastModified;
}
/**
* Sets the date time when the category was modified last.
*
* @param DateTime $modified Datetime of when the category has been lastly modified.
*
* @return Category Same instance for chained method calls.
*/
public function setLastModifiedDateTime(DateTime $modified)
{
$this->lastModified = $modified;
return $this;
}
/**
* Returns the settings of the category.
*
* @return CategorySettingsInterface
*/
public function getSettings()
{
return $this->settings;
}
/**
* Returns the name of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getName(LanguageCode $language)
{
return (string)$this->names[(string)$language];
}
/**
* Sets the name of the category for the language with the provided language code.
*
* @param StringType $text Category name.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setName(StringType $text, LanguageCode $language)
{
$this->names[(string)$language] = $text->asString();
return $this;
}
/**
* Returns the heading title of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getHeadingTitle(LanguageCode $language)
{
return (string)$this->headingTitles[(string)$language];
}
/**
* Sets the heading title of the category for the language with the provided language code.
*
* @param StringType $text Heading title of the category.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setHeadingTitle(StringType $text, LanguageCode $language)
{
$this->headingTitles[(string)$language] = $text->asString();
return $this;
}
/**
* Returns the description of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getDescription(LanguageCode $language)
{
return (string)$this->descriptions[(string)$language];
}
/**
* Sets the description of the category for the language with the provided language code.
*
* @param StringType $text Description of the category.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setDescription(StringType $text, LanguageCode $language)
{
$this->descriptions[(string)$language] = $text->asString();
return $this;
}
/**
* Returns the meta title of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getMetaTitle(LanguageCode $language)
{
return (string)$this->metaTitles[(string)$language];
}
/**
* Sets the meta title of the category for the language with the provided language code.
*
* @param StringType $text Meta title for the category.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setMetaTitle(StringType $text, LanguageCode $language)
{
$this->metaTitles[(string)$language] = $text->asString();
return $this;
}
/**
* Returns the meta title of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getMetaDescription(LanguageCode $language)
{
return (string)$this->metaDescriptions[(string)$language];
}
/**
* Sets the meta title of the category for the language with the provided language code.
*
* @param StringType $text Meta title of the category.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setMetaDescription(StringType $text, LanguageCode $language)
{
$this->metaDescriptions[(string)$language] = $text->asString();
return $this;
}
/**
* Returns the meta keywords of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getMetaKeywords(LanguageCode $language)
{
return (string)$this->metaKeywords[(string)$language];
}
/**
* Sets the meta keywords of the category for the language with the provided language code.
*
* @param StringType $text Meta keywords of the category.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setMetaKeywords(StringType $text, LanguageCode $language)
{
$this->metaKeywords[(string)$language] = $text->asString();
return $this;
}
/**
* Returns the url keywords of the category in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getUrlKeywords(LanguageCode $language)
{
return (string)$this->urlKeywords[(string)$language];
}
/**
* Sets the url keywords of the category for the language with the provided language code.
*
* @param StringType $text URL keywords of the category.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setUrlKeywords(StringType $text, LanguageCode $language)
{
$this->urlKeywords[(string)$language] = $text->asString();
return $this;
}
/**
* Get URL rewrite
*
* Returns the URL rewrite of the category, depending on the provided language code.
*
* @throws InvalidArgumentException if the language code is not valid.
*
* @param LanguageCode $language The language code of the URL rewrite to be return.
*
* @return UrlRewrite The URL rewrite of the category.
*/
public function getUrlRewrite(LanguageCode $language)
{
return $this->urlRewrites->getValue($language->asString());
}
/**
* Get URL rewrites
*
* Returns the URL rewrites of the category.
*
* @return UrlRewriteCollection The URL rewrites of the category.
*/
public function getUrlRewrites()
{
return $this->urlRewrites;
}
/**
* Set URL rewrite
*
* Sets the URL rewrite of the category for the provided language code.
*
* @param UrlRewrite $urlRewrite The URL rewrite instance.
* @param LanguageCode $language The language code for the URL keywords.
*
* @return Category Same instance for chained method calls.
*/
public function setUrlRewrite(UrlRewrite $urlRewrite, LanguageCode $language)
{
$this->urlRewrites->setValue($language->asString(), $urlRewrite);
return $this;
}
/**
* Set URL rewrites
*
* Sets the URL rewrites of the category.
*
* @param UrlRewriteCollection $urlRewrites The URL rewrites.
*
* @return Category Same instance for chained method calls.
*/
public function setUrlRewrites(UrlRewriteCollection $urlRewrites)
{
$this->urlRewrites = $urlRewrites;
return $this;
}
/**
* Returns the image filename of the category.
*
* @return string
*/
public function getImage()
{
return $this->image;
}
/**
* Sets the image filename of the category.
*
* @param StringType $imageFile Category image file.
*
* @return Category Same instance for chained method calls.
*/
public function setImage(StringType $imageFile)
{
$this->image = $imageFile->asString();
return $this;
}
/**
* Returns the alternative text of the image in the language with the provided language code.
*
* @param LanguageCode $language Two letter language code.
*
* @return string
*/
public function getImageAltText(LanguageCode $language)
{
return (string)$this->altTexts[(string)$language];
}
/**
* Set the alternative text of the image for the language with the provided language code.
*
* @param StringType $text Alternative text of the category image.
* @param LanguageCode $language Two letter language code.
*
* @return Category Same instance for chained method calls.
*/
public function setImageAltText(StringType $text, LanguageCode $language)
{
$this->altTexts[(string)$language] = $text->asString();
return $this;
}
/**
* Returns the icon filename of the category.
*
* @return string
*/
public function getIcon()
{
return $this->icon;
}
/**
* Sets the icon filename of the category.
*
* @param StringType $iconFile Category icon file.
*
* @return Category Same instance for chained method calls.
*/
public function setIcon(StringType $iconFile)
{
$this->icon = $iconFile->asString();
return $this;
}
/*
* ====================================================
* TODO: Implement getIconWidth() and getIconHeight()
* ====================================================
*/
/**
* Returns an addon value by a given key.
*
* @param StringType $key Identifier key.
*
* @return string
*/
public function getAddonValue(StringType $key)
{
return $this->addonValues->getValue($key->asString());
}
/**
* Sets an addon key and value.
*
* @param StringType $key Identifier key.
* @param StringType $value Value text.
*
* @return Category Same instance for chained method calls.
*/
public function setAddonValue(StringType $key, StringType $value)
{
$this->addonValues->setValue($key->asString(), $value->asString());
return $this;
}
/**
* Returns a KeyValueCollection of addon values.
*
* @return KeyValueCollection
*/
public function getAddonValues()
{
return $this->addonValues;
}
/**
* Adds a KeyValueCollection of addon values.
*
* @param KeyValueCollection $collection Key-Value collection.
*
* @return Category Same instance for chained method calls.
*/
public function addAddonValues(KeyValueCollection $collection)
{
$this->addonValues->addCollection($collection);
return $this;
}
/**
* Deletes an addon value with a given key from the KeyValueCollection.
*
* @param StringType $key Identifier key.
*
* @return Category Same instance for chained method calls.
*/
public function deleteAddonValue(StringType $key)
{
$this->addonValues->deleteValue($key->asString());
return $this;
}
/**
* Sets a category setting object
*
* @param CategorySettingsInterface $settings
*
* @return Category Same instance for chained method calls.
*/
public function setSettings(CategorySettingsInterface $settings)
{
$this->settings = $settings;
return $this;
}
}