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
<?php
/* --------------------------------------------------------------
CategorySettings.inc.php 2016-02-01
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('CategorySettingsInterface');
/**
* Class CategorySettings
*
* This Class stores some settings regarding display and visibility mode of category related data and is used within a
* CategoryInterface.
*
* @category System
* @package Category
* @subpackage Entities
*/
class CategorySettings implements CategorySettingsInterface
{
/**
* Current template which is used for category listing.
*
* @var string The current category listing template.
*/
protected $categoryListingTemplate = '';
/**
* Current template which is used for product listing.
*
* @var string
*/
protected $productListingTemplate = '';
/**
* Current column by which the products are sorted.
*
* @var string
*/
protected $productSortColumn = '';
/**
* Current direction which the products are sorted in.
*
* @var string
*/
protected $productSortDirection = '';
/**
* Is category/product in the sitemap?
*
* @var bool
*/
protected $sitemapEntry = false;
/**
* Priority of the element in the sitemap.
*
* @var string
*/
protected $sitemapPriority = '';
/**
* Change frequency of the element in the sitemap.
*
* @var string
*/
protected $sitemapChangeFreq = '';
/**
* Should attributes be displayed?
*
* @var bool
*/
protected $attributes = false;
/**
* Should graduated prices be displayed?
*
* @var bool
*/
protected $graduatedPrices = false;
/**
* Should quantities be displayed?
*
* @var bool
*/
protected $quantityInput = false;
/**
* Should quantity info be displayed?
*
* @var bool
*/
protected $stock = false;
/**
* Should subcategories be displayed?
*
* @var bool
*/
protected $subcategories = false;
/**
* Should subcategory images be displayed?
*
* @var bool
*/
protected $subcategoryImages = false;
/**
* Should subcategory names be displayed?
*
* @var bool
*/
protected $subcategoryNames = false;
/**
* Should subcategory products be displayed?
*
* @var bool
*/
protected $subcategoryProducts = false;
/**
* Should default view mode be "tiled"?
*
* @var bool
*/
protected $viewModeTiled = false;
/**
* Array of permitted customer status.
*
* @var array
*/
protected $permittedCustomerStatus = array();
/**
* @var bool
*/
protected $showCategoryFilter = false;
/**
* @var int
*/
protected $filterSelectionMode = 0;
/**
* @var int
*/
protected $filterValueDeactivation = 0;
/**
* Returns the current category listing template.
*
* @return string
*/
public function getCategoryListingTemplate()
{
return $this->categoryListingTemplate;
}
/**
* Sets the current category listing template.
*
* @param StringType $filename Category listing template.
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setCategoryListingTemplate(StringType $filename)
{
$this->categoryListingTemplate = $filename->asString();
return $this;
}
/**
* Returns the current product listing template.
*
* @return string
*/
public function getProductListingTemplate()
{
return $this->productListingTemplate;
}
/**
* Sets the current product listing template.
*
* @param StringType $filename Product listing template.
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setProductListingTemplate(StringType $filename)
{
$this->productListingTemplate = $filename->asString();
return $this;
}
/**
* Returns the column by which the products are currently sorted.
*
* @return string
*/
public function getProductSortColumn()
{
return $this->productSortColumn;
}
/**
* Sets the column by which the products are currently sorted.
*
* @param StringType $column Column by which the products should be sorted.
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setProductSortColumn(StringType $column)
{
$this->productSortColumn = $column->asString();
return $this;
}
/**
* Returns the direction which the products are currently sorted in.
*
* @return string
*/
public function getProductSortDirection()
{
return $this->productSortDirection;
}
/**
* Sets the direction which the products are currently sorted in.
*
* @param StringType $direction Direction which the products should be sorted in.
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setProductSortDirection(StringType $direction)
{
$this->productSortDirection = $direction->asString();
return $this;
}
/**
* Checks if category/product is part of the sitemap.
*
* @return bool
*/
public function isSitemapEntry()
{
return $this->sitemapEntry;
}
/**
* Sets whether the category/product is part of the sitemap.
*
* @param BoolType $status Value whether the category/product is part of the sitemap.
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setSitemapEntry(BoolType $status)
{
$this->sitemapEntry = $status->asBool();
return $this;
}
/**
* Returns the sitemap priority of the element.
*
* @return string
*/
public function getSitemapPriority()
{
return $this->sitemapPriority;
}
/**
* Sets the sitemap priority of the element.
*
* @param StringType $priority Element's sitemap priority.
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setSitemapPriority(StringType $priority)
{
$this->sitemapPriority = $priority->asString();
return $this;
}
/**
* Returns the change frequency of the element.
*
* @return string
*/
public function getSitemapChangeFreq()
{
return $this->sitemapChangeFreq;
}
/**
* Sets the change frequency of the element.
*
* @param StringType $freq Change frequency value.
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setSitemapChangeFreq(StringType $freq)
{
$this->sitemapChangeFreq = $freq->asString();
return $this;
}
/**
* Checks if attributes should be displayed or not.
*
* @return bool
*/
public function showAttributes()
{
return $this->attributes;
}
/**
* Sets whether the attributes should be displayed or not.
*
* @param BoolType $status Should attributes be displayed?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowAttributes(BoolType $status)
{
$this->attributes = $status->asBool();
return $this;
}
/**
* Checks if graduated prices should be displayed or not.
*
* @return bool
*/
public function showGraduatedPrices()
{
return $this->graduatedPrices;
}
/**
* Sets whether graduated prices should be displayed or not.
*
* @param BoolType $status Show graduated prices?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowGraduatedPrices(BoolType $status)
{
$this->graduatedPrices = $status->asBool();
return $this;
}
/**
* Checks if a quantity input should be displayed in product forms or not.
*
* @return bool
*/
public function showQuantityInput()
{
return $this->quantityInput;
}
/**
* Sets whether a quantity input should be displayed in product forms or not.
*
* @param BoolType $status Show quantity input?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowQuantityInput(BoolType $status)
{
$this->quantityInput = $status->asBool();
return $this;
}
/**
* Checks if the stock should be displayed or not.
*
* @return bool
*/
public function showStock()
{
return $this->stock;
}
/**
* Sets whether the stock should be displayed or not.
*
* @param BoolType $status Show quantity info?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowStock(BoolType $status)
{
$this->stock = $status->asBool();
return $this;
}
/**
* Checks if subcategories should be displayed or not.
*
* @return bool
*/
public function showSubcategories()
{
return $this->subcategories;
}
/**
* Sets whether subcategories should be displayed or not.
*
* @param BoolType $status Show subcategories?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowSubcategories(BoolType $status)
{
$this->subcategories = $status->asBool();
return $this;
}
/**
* Checks if subcategory images should be displayed or not.
*
* @return bool
*/
public function showSubcategoryImages()
{
return $this->subcategoryImages;
}
/**
* Sets whether subcategory images should be displayed or not.
*
* @param BoolType $status Show subcategory images?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowSubcategoryImages(BoolType $status)
{
$this->subcategoryImages = $status->asBool();
return $this;
}
/**
* Checks if subcategory names should be displayed or not.
*
* @return bool
*/
public function showSubcategoryNames()
{
return $this->subcategoryNames;
}
/**
* Sets whether subcategory names should be displayed or not.
*
* @param BoolType $status Show subcategory names?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowSubcategoryNames(BoolType $status)
{
$this->subcategoryNames = $status->asBool();
return $this;
}
/**
* Checks if subcategory products should be displayed or not.
*
* @return bool
*/
public function showSubcategoryProducts()
{
return $this->subcategoryProducts;
}
/**
* Sets whether subcategory products should be displayed or not.
*
* @param BoolType $status Show subcategory products?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setShowSubcategoryProducts(BoolType $status)
{
$this->subcategoryProducts = $status->asBool();
return $this;
}
/**
* Checks if default view mode should be tiled or not.
*
* @return bool
*/
public function isDefaultViewModeTiled()
{
return $this->viewModeTiled;
}
/**
* Sets whether default view mode should be tiled or not.
*
* @param BoolType $status Is tiled the default view mode?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setDefaultViewModeTiled(BoolType $status)
{
$this->viewModeTiled = $status->asBool();
return $this;
}
/**
* Checks if it is a permitted customer status or not.
*
* @param IdType $customerStatusId Customer status ID.
*
* @return bool
*/
public function isPermittedCustomerStatus(IdType $customerStatusId)
{
return (array_key_exists($customerStatusId->asInt(),
$this->permittedCustomerStatus)) ? $this->permittedCustomerStatus[$customerStatusId->asInt()] : false;
}
/**
* Sets whether a customer status is permitted or not.
*
* @param IdType $customerStatusId Customer status ID.
* @param BoolType $permitted Is permitted?
*
* @return CategorySettings Same instance for chained method calls.
*/
public function setPermittedCustomerStatus(IdType $customerStatusId, BoolType $permitted)
{
$this->permittedCustomerStatus[$customerStatusId->asInt()] = $permitted->asBool();
return $this;
}
/**
* Sets the show category filter value.
*
* @param BoolType $showCategoryFilter
*
* @return Category Same instance for chained method calls.
*/
public function setShowCategoryFilter(BoolType $showCategoryFilter)
{
$this->showCategoryFilter = $showCategoryFilter->asBool();
}
/**
* Gets the show category filter value.
*
* @return bool
*/
public function showCategoryFilter()
{
return $this->showCategoryFilter;
}
/**
* Sets the filter selection mode value.
*
* @param IntType $filterSelectionMode
*
* @return Category Same instance for chained method calls.
*/
public function setFilterSelectionMode(IntType $filterSelectionMode)
{
$this->filterSelectionMode = $filterSelectionMode->asInt();
}
/**
* Gets the filter selection mode value.
*
* @return int
*/
public function getFilterSelectionMode()
{
return $this->filterSelectionMode;
}
/**
* Sets the filter value deactivation.
*
* @param IntType $filterValueDeactivation
*
* @return Category Same instance for chained method calls.
*/
public function setFilterValueDeactivation(IntType $filterValueDeactivation)
{
$this->filterValueDeactivation = $filterValueDeactivation->asInt();
}
/**
* Gets the filter value deactivation.
*
* @return int
*/
public function getFilterValueDeactivation()
{
return $this->filterValueDeactivation;
}
}