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 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
<?php
/* --------------------------------------------------------------
ProductListItem.inc.php 2016-09-20
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 ProductListItem
*
* @category System
* @package Product
* @subpackage Entities
*/
class ProductListItem
{
/**
* Product repository.
*
* @var ProductRepositoryInterface
*/
protected $productRepository;
/**
* Product ID
*
* @var int
*/
protected $productId = 0;
/**
* Product Active Status
*
* @var boolean
*/
protected $active = false;
/**
* Sort Order
*
* @var int
*/
protected $sortOrder = 0;
/**
* Added DateTime
*
* @var DateTime
*/
protected $addedDateTime;
/**
* Available DateTime
*
* @var DateTime
*/
protected $availableDateTime;
/**
* Last Modified DateTime
*
* @var DateTime
*/
protected $lastModifiedDateTime;
/**
* Ordered Count
*
* @var int
*/
protected $orderedCount = 0;
/**
* Product Model
*
* @var string
*/
protected $productModel = '';
/**
* EAN
*
* @var string
*/
protected $ean = '';
/**
* Price
*
* @var float
*/
protected $price = 0.00;
/**
* Discount Allowed
*
* @var float
*/
protected $discountAllowed = 0.00;
/**
* Tax Class ID
*
* @var int
*/
protected $taxClassId = 0;
/**
* Quantity
*
* @var float
*/
protected $quantity = 0.00;
/**
* Product Name
*
* @var string
*/
protected $name = '';
/**
* Image
*
* @var string
*/
protected $image = '';
/**
* Image alternative text
*
* @var string
*/
protected $imageAltText = '';
/**
* URL Keywords
*
* @var string
*/
protected $urlKeywords = '';
/**
* Weight
*
* @var float
*/
protected $weight = 0.00;
/**
* Shipping costs
*
* @var float
*/
protected $shippingCosts = 0.00;
/**
* Shipping Time ID
*
* @var int
*/
protected $shippingTimeId = 0;
/**
* Product Type ID
*
* @var int
*/
protected $productTypeId = 0;
/**
* Manufacturer ID
*
* @var int
*/
protected $manufacturerId = 0;
/**
* FSK 18 Status
*
* @var bool
*/
protected $fsk18 = false;
/**
* VPE Active Status
*
* @var bool
*/
protected $vpeActive = false;
/**
* VPE ID
*
* @var int
*/
protected $vpeId = 0;
/**
* VPE Value
*
* @var float
*/
protected $vpeValue = 0.00;
/**
* ProductListItem constructor.
*
* @todo Remove optional methods from this constructor for v3.5.1.0.
*
* Deprecation Notice:
*
* The optional parameters of this constructor are deprecated as of v3.3.1.0 and will be removed in
* v3.5.1.0. Please use the setter methods instead.
*
* @param ProductRepositoryInterface $productRepository Product Repository.
* @param IdType $productId Optional (null), product ID.
* @param BoolType $isActive Optional (null), product active status.
* @param StringType $name Optional (null), product name.
* @param StringType $urlKeywords Optional (null), URL keywords.
* @param StringType $image Optional (null), product image.
* @param StringType $imageAltText Optional (null), product image alternative text.
*/
public function __construct(ProductRepositoryInterface $productRepository,
IdType $productId = null,
BoolType $isActive = null,
StringType $name = null,
StringType $urlKeywords = null,
StringType $image = null,
StringType $imageAltText = null)
{
$this->productRepository = $productRepository;
}
/**
* Returns the product ID.
*
* @return int
*/
public function getProductId()
{
return $this->productId;
}
/**
* Checks if product is active or not.
*
* @return boolean
*/
public function isActive()
{
return $this->active;
}
/**
* Returns the name of the product.
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Returns the URL keywords.
*
* @return string
*/
public function getUrlKeywords()
{
return $this->urlKeywords;
}
/**
* Returns the image.
*
* @return string
*/
public function getImage()
{
return $this->image;
}
/**
* Returns the alternative image text.
*
* @return string
*/
public function getImageAltText()
{
return $this->imageAltText;
}
/**
* Returns the product object.
*
* @throws InvalidArgumentException if the product ID is not valid.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function getProductObject()
{
$id = new IdType($this->getProductId());
return $this->productRepository->getProductById($id);
}
/**
* Get Sort Order
*
* @return int The sort order.
*/
public function getSortOrder()
{
return $this->sortOrder;
}
/**
* Get Available Date Time
*
* @return DateTime The available date time.
*/
public function getAvailableDateTime()
{
return $this->availableDateTime;
}
/**
* Get Added Date Time
*
* @return DateTime The added date time.
*/
public function getAddedDateTime()
{
return $this->addedDateTime;
}
/**
* Get Last Modified Date Time
*
* @return DateTime The last modified date time.
*/
public function getLastModifiedDateTime()
{
return $this->lastModifiedDateTime;
}
/**
* Get Ordered Count
*
* @return int The ordered count.
*/
public function getOrderedCount()
{
return $this->orderedCount;
}
/**
* Get Product Model
*
* @return string The product model.
*/
public function getProductModel()
{
return $this->productModel;
}
/**
* Get EAN
*
* @return string The EAN of the product.
*/
public function getEan()
{
return $this->ean;
}
/**
* Get Price
*
* @return float The price of the product.
*/
public function getPrice()
{
return $this->price;
}
/**
* Get Tax Class ID
*
* @return int The tax class ID.
*/
public function getTaxClassId()
{
return $this->taxClassId;
}
/**
* Get Quantity
*
* @return float The quantity of the product.
*/
public function getQuantity()
{
return $this->quantity;
}
/**
* Get Weight
*
* @return float The weight of the product.
*/
public function getWeight()
{
return $this->weight;
}
/**
* Get Discount Allowed
*
* @return float The allowed discount.
*/
public function getDiscountAllowed()
{
return $this->discountAllowed;
}
/**
* Get Shipping Costs
*
* @return float The shipping costs of the product.
*/
public function getShippingCosts()
{
return $this->shippingCosts;
}
/**
* Get Shipping Time ID
*
* @return int The shipping time ID.
*/
public function getShippingTimeId()
{
return $this->shippingTimeId;
}
/**
* Get Product Type ID.
*
* @return int The product type ID.
*/
public function getProductTypeId()
{
return $this->productTypeId;
}
/**
* Get Manufacturer ID
*
* @return int The manufacturer ID.
*/
public function getManufacturerId()
{
return $this->manufacturerId;
}
/**
* Is FSK 18
*
* @return bool Is the product FSK18?
*/
public function isFsk18()
{
return $this->fsk18;
}
/**
* Is VPE Active
*
* @return bool Is VPE active on the product?
*/
public function isVpeActive()
{
return $this->vpeActive;
}
/**
* Get VPE ID
*
* @return int VPE ID.
*/
public function getVpeId()
{
return $this->vpeId;
}
/**
* Get VPE Value
*
* @return float The VPE value.
*/
public function getVpeValue()
{
return $this->vpeValue;
}
/**
* Set Product ID value.
*
* @param IdType $id
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setProductId(IdType $id)
{
$this->productId = $id->asInt();
return $this;
}
/**
* Set active state value.
*
* @param BoolType $status
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setActive(BoolType $status)
{
$this->active = $status->asBool();
return $this;
}
/**
* Set product name.
*
* @param StringType $name
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setName(StringType $name)
{
$this->name = $name->asString();
return $this;
}
/**
* Set product URL keywords.
*
* @param StringType $urlKeywords
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setUrlKeywords(StringType $urlKeywords)
{
$this->urlKeywords = $urlKeywords->asString();
return $this;
}
/**
* Set product image.
*
* @param StringType $image
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setImage(StringType $image)
{
$this->image = $image->asString();
return $this;
}
/**
* Set image alt text.
*
* @param StringType $imageAltText
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setImageAltText(StringType $imageAltText)
{
$this->imageAltText = $imageAltText->asString();
return $this;
}
/**
* Set Sort Order
*
* @param IntType $sortOrder The sort order.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setSortOrder(IntType $sortOrder)
{
$this->sortOrder = $sortOrder->asInt();
return $this;
}
/**
* Sets the added date time.
*
* @param DateTime $date
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setAddedDateTime(DateTime $date)
{
$this->addedDateTime = $date;
return $this;
}
/**
* Set Available Date Time
*
* @param DateTime $date
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setAvailableDateTime(DateTime $date)
{
$this->availableDateTime = $date;
return $this;
}
/**
* Set Last Modified Date Time
*
* @param DateTime $date The last modified date time.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setLastModifiedDateTime(DateTime $date)
{
$this->lastModifiedDateTime = $date;
return $this;
}
/**
* Set Ordered Count
*
* @param IntType $count The ordered count.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setOrderedCount(IntType $count)
{
$this->orderedCount = $count->asInt();
return $this;
}
/**
* Set Product Model
*
* @param StringType $model The product model.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setProductModel(StringType $model)
{
$this->productModel = $model->asString();
return $this;
}
/**
* Set EAN
*
* @param StringType $ean The EAN to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setEan(StringType $ean)
{
$this->ean = $ean->asString();
return $this;
}
/**
* Set Price
*
* @param DecimalType $price The price to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setPrice(DecimalType $price)
{
$this->price = $price->asDecimal();
return $this;
}
/**
* Set Tax Class ID
*
* @param IdType $id The tax class ID to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setTaxClassId(IdType $id)
{
$this->taxClassId = $id->asInt();
return $this;
}
/**
* Set Quantity
*
* @param DecimalType $quantity The quantity to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setQuantity(DecimalType $quantity)
{
$this->quantity = $quantity->asDecimal();
return $this;
}
/**
* Set Weight
*
* @param DecimalType $weight The weight to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setWeight(DecimalType $weight)
{
$this->weight = $weight->asDecimal();
return $this;
}
/**
* Set Discount Allowed
*
* @param DecimalType $discount The discount to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setDiscountAllowed(DecimalType $discount)
{
$this->discountAllowed = $discount->asDecimal();
return $this;
}
/**
* Set Shipping Costs
*
* @param DecimalType $price The shipping costs to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setShippingCosts(DecimalType $price)
{
$this->shippingCosts = $price->asDecimal();
return $this;
}
/**
* Set Shipping Time ID
*
* @param IdType $id The shipping time ID to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setShippingTimeId(IdType $id)
{
$this->shippingTimeId = $id->asInt();
return $this;
}
/**
* Set Product Type ID.
*
* @param IdType $id Product type ID.
*
* @return ProductListItem
*/
public function setProductTypeId(IdType $id)
{
$this->productTypeId = $id->asInt();
return $this;
}
/**
* Set Manufacturer ID
*
* @param IdType $id The manufacturer ID to set.
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setManufacturerId(IdType $id)
{
$this->manufacturerId = $id->asInt();
return $this;
}
/**
* Set FSK 18
*
* @param BoolType $status
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setFsk18(BoolType $status)
{
$this->fsk18 = $status->asBool();
return $this;
}
/**
* Set VPE Active
*
* @param BoolType $status
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setVpeActive(BoolType $status)
{
$this->vpeActive = $status->asBool();
return $this;
}
/**
* Set VPE ID
*
* @param IdType $id
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setVpeId(IdType $id)
{
$this->vpeId = $id->asInt();
return $this;
}
/**
* Set VPE Value
*
* @param DecimalType $vpeValue
*
* @return ProductListItem Returns same instance for chained calls.
*/
public function setVpeValue(DecimalType $vpeValue)
{
$this->vpeValue = $vpeValue->asDecimal();
return $this;
}
}