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
<?php
/* --------------------------------------------------------------
ProductInterface.inc.php 2016-04-14
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]
--------------------------------------------------------------
*/
/**
* Interface ProductInterface
*
* @category System
* @package Product
* @subpackage Interfaces
*/
interface ProductInterface
{
/**
* Is Active
*
* Checks if a product is active.
*
* @return bool
*/
public function isActive();
/**
* Get Sort Order
*
* Returns an integer which represents a specific sort order.
*
* @return int The sort order.
*/
public function getSortOrder();
/**
* Get Available Date Time
*
* Returns the available date time of the product.
*
* @return DateTime The available date time.
*/
public function getAvailableDateTime();
/**
* Get Added Date Time
*
* Returns the added date time of the product.
*
* @return DateTime The added date time.
*/
public function getAddedDateTime();
/**
* Get Last Modified Date Time
*
* Returns the last modified date time.
*
* @return DateTime The last modified date time.
*/
public function getLastModifiedDateTime();
/**
* Get View Count
*
* Returns the current view count of the product, depending on the provided language code.
*
* @throws InvalidArgumentException
*
* @param LanguageCode $language The language code of the language to be returned.
*
* @return int The current view count.
*/
public function getViewedCount(LanguageCode $language);
/**
* Get Ordered Count
*
* Returns the ordered count of the product.
*
* @return int The ordered count.
*/
public function getOrderedCount();
/**
* Get Product Settings.
*
* Returns the product settings.
*
* @return ProductSettingsInterface
*/
public function getSettings();
/**
* Get Name
*
* Returns the name of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The name of the product.
*/
public function getName(LanguageCode $language);
/**
* Get Description
*
* Returns the description of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The description of the product.
*/
public function getDescription(LanguageCode $language);
/**
* Get Short Description
*
* Returns the short description of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The short description of the product.
*/
public function getShortDescription(LanguageCode $language);
/**
* Get Keywords
*
* Returns the keywords of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The keywords of the product.
*/
public function getKeywords(LanguageCode $language);
/**
* Get Meta Title
*
* Returns the meta title of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The meta title of the product.
*/
public function getMetaTitle(LanguageCode $language);
/**
* Get Meta Description
*
* Returns the meta description of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The meta description of the product.
*/
public function getMetaDescription(LanguageCode $language);
/**
* Get Meta Keywords
*
* Returns the meta keywords of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The meta keywords of the product.
*/
public function getMetaKeywords(LanguageCode $language);
/**
* Get Url
*
* Returns the URL of the product, depending on the provided language code.
*
* @throws InvalidArgumentException
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string Product URL
*/
public function getUrl(LanguageCode $language);
/**
* Get URL Keywords
*
* Returns the URL keywords of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The URL keywords of the product.
*/
public function getUrlKeywords(LanguageCode $language);
/**
* Get URL rewrite
*
* Returns the URL rewrite of the product, 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 product.
*/
public function getUrlRewrite(LanguageCode $language);
/**
* Get URL rewrites
*
* Returns the URL rewrites of the product.
*
* @return UrlRewriteCollection The URL rewrites of the product.
*/
public function getUrlRewrites();
/**
* Get Checkout Information
*
* Returns the checkout information of the product, depending on the provided language code.
*
* @param LanguageCode $language The language code of the language to return.
*
* @return string The checkout information of the product.
*/
public function getCheckoutInformation(LanguageCode $language);
/**
* Get Product Model
*
* Returns the product model.
*
* @return string The product model.
*/
public function getProductModel();
/**
* Get EAN
*
* Returns the EAN of the product.
*
* @return string The EAN of the product.
*/
public function getEan();
/**
* Get Price
*
* Returns the price of a product.
*
* @return float The price of the product.
*/
public function getPrice();
/**
* Get Tax Class ID
*
* Returns the tax class ID of the product.
*
* @return int The tax class ID.
*/
public function getTaxClassId();
/**
* Get Quantity
*
* Returns the quantity of the product.
*
* @return float The quantity of the product.
*/
public function getQuantity();
/**
* Get Weight
*
* Returns the weight of the product.
*
* @return float The weight of the product.
*/
public function getWeight();
/**
* Get Discount Allowed
*
* Returns the allowed discount.
*
* @return float The allowed discount.
*/
public function getDiscountAllowed();
/**
* Get Shipping Costs
*
* Returns the shipping cost of the product.
*
* @return float The shipping costs of the product.
*/
public function getShippingCosts();
/**
* Get Shipping Time ID
*
* Returns the shipping time ID of the product.
*
* @return int The shipping time ID.
*/
public function getShippingTimeId();
/**
* Get Product Type ID.
*
* Returns the product type ID.
*
* @return int The product type ID.
*/
public function getProductTypeId();
/**
* Get Manufacturer ID
*
* Returns the manufacturer ID.
*
* @return int The manufacturer ID.
*/
public function getManufacturerId();
/**
* Is FSK 18
*
* Checks if the product is only available for FSK 18.
*
* @return bool Is the product FSK18?
*/
public function isFsk18();
/**
* Is VPE Active
*
* Checks if VPE is active on the product.
*
* @return bool Is VPE active on the product?
*/
public function isVpeActive();
/**
* Get VPE ID.
*
* Returns the VPE ID.
*
* @return int VPE ID.
*/
public function getVpeId();
/**
* Get VPE Value
*
* Returns the VPE value.
*
* @return float The VPE value.
*/
public function getVpeValue();
/**
* Get Addon Value
*
* Returns the addon value of a product, depending on the provided key.
*
* @param StringType $key The key of the addon value to return.
*
* @return string The addon value.
*/
public function getAddonValue(StringType $key);
/**
* Get Addon Values
*
* Returns a key value collection of the product.
*
* @return KeyValueCollection The key value collection.
*/
public function getAddonValues();
/**
* Set Active
*
* Activates or deactivates a product status.
*
* @param BoolType $status Should the product status be activated?
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setActive(BoolType $status);
/**
* Set Sort Order
*
* Sets the sort order of the product.
*
* @param IntType $sortOrder The sort order.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setSortOrder(IntType $sortOrder);
/**
* Set Available Date Time
*
* Sets an available date time.
*
* @param DateTime $date The date time to add.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setAvailableDateTime(DateTime $date);
/**
* Set Last Modified Date Time
*
* Sets the last modified date time.
*
* @param DateTime $date The last modified date time.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setLastModifiedDateTime(DateTime $date);
/**
* Set Viewed Count
*
* Sets the viewed count of a product.
*
* @param IntType $count The amount of views.
* @param LanguageCode $language The language code for the product name.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setViewedCount(IntType $count, LanguageCode $language);
/**
* Set Ordered Count
*
* Sets the ordered count.
*
* @param IntType $count The ordered count.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setOrderedCount(IntType $count);
/**
* Set Image Container
*
* Sets the image container of a product.
*
* @param ProductImageContainerInterface $images Product image container to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setImageContainer(ProductImageContainerInterface $images);
/**
* Sets the settings of the product.
*
* @param ProductSettingsInterface $productSettings The settings of the product.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setSettings(ProductSettingsInterface $productSettings);
/**
* Set Name
*
* Sets the products name.
*
* @param StringType $text The name of the product.
* @param LanguageCode $language The language code for the product name.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setName(StringType $text, LanguageCode $language);
/**
* Set Description
*
* Sets the products description.
*
* @param StringType $text The description.
* @param LanguageCode $language The language code for the description.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setDescription(StringType $text, LanguageCode $language);
/**
* Set Short Description
*
* Sets the products short description.
*
* @param StringType $text Short description to set.
* @param LanguageCode $language The language code for the short description.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setShortDescription(StringType $text, LanguageCode $language);
/**
* Set Keywords
*
* Sets the products keywords.
*
* @param StringType $text The keywords.
* @param LanguageCode $language The language code for the keywords.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setKeywords(StringType $text, LanguageCode $language);
/**
* Set Meta title.
*
* Sets the meta title.
*
* @param StringType $text Meta title to set.
* @param LanguageCode $language Language code of the meta title.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setMetaTitle(StringType $text, LanguageCode $language);
/**
* Set Meta description.
*
* Sets the products meta description.
*
* @param StringType $text Meta description to set.
* @param LanguageCode $language Language code for the meta description.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setMetaDescription(StringType $text, LanguageCode $language);
/**
* Set Meta Keywords
*
* Sets the products meta keywords.
*
* @param StringType $text The meta keywords.
* @param LanguageCode $language The language code for the meta keywords.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setMetaKeywords(StringType $text, LanguageCode $language);
/**
* Set URL
*
* Sets the products URL.
*
* @param StringType $url The URL to set.
* @param LanguageCode $language The language code for the URL keywords.
*
* @return GXEngineProduct Same instance for chained method calls.
*/
public function setUrl(StringType $url, LanguageCode $language);
/**
* Set URL Keywords
*
* Sets the products URL Keywords.
*
* @param StringType $text The URL.
* @param LanguageCode $language The language code for the URL keywords.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setUrlKeywords(StringType $text, LanguageCode $language);
/**
* Set URL rewrite
*
* Sets the products URL rewrite for the provided language code.
*
* @param UrlRewrite $urlRewrite The URL rewrite instance.
* @param LanguageCode $language The language code for the URL keywords.
*
* @return GXEngineProduct Same instance for chained method calls.
*/
public function setUrlRewrite(UrlRewrite $urlRewrite, LanguageCode $language);
/**
* Set URL rewrites
*
* Sets the products URL rewrites.
*
* @param UrlRewriteCollection $urlRewrites The URL rewrites.
*
* @return GXEngineProduct Same instance for chained method calls.
*/
public function setUrlRewrites(UrlRewriteCollection $urlRewrites);
/**
* Set Checkout Information
*
* Sets the checkout information.
*
* @param StringType $text The checkout information.
* @param LanguageCode $language The language code for the checkout information.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setCheckoutInformation(StringType $text, LanguageCode $language);
/**
* Set Product Model
*
* Set the product model.
*
* @param StringType $model The product model.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setProductModel(StringType $model);
/**
* Set EAN
*
* Sets a EAN for the product.
*
* @param StringType $ean The EAN to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setEan(StringType $ean);
/**
* Set Price
*
* Sets a price of the product.
*
* @param DecimalType $price The price to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setPrice(DecimalType $price);
/**
* Set Tax Class ID
*
* Sets a tax class ID for the product.
*
* @param IdType $id The tax class ID to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setTaxClassId(IdType $id);
/**
* Set Quantity
*
* Sets a quantity for the product.
*
* @param DecimalType $quantity The quantity to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setQuantity(DecimalType $quantity);
/**
* Set Weight
*
* Sets the weight of a product.
*
* @param DecimalType $weight The weight to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setWeight(DecimalType $weight);
/**
* Set Discount Allowed
*
* Sets the allowed discount of a product.
*
* @param DecimalType $discount The discount to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setDiscountAllowed(DecimalType $discount);
/**
* Set Shipping Costs
*
* Sets the shipping costs of a product.
*
* @param DecimalType $price The shipping costs to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setShippingCosts(DecimalType $price);
/**
* Set Shipping Time ID
*
* Sets the shipping time ID of a product.
*
* @param IdType $id The shipping time ID to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setShippingTimeId(IdType $id);
/**
* Set Product Type ID.
*
* Sets the product type ID of the product.
*
* @param IdType $id Product type ID to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setProductTypeId(IdType $id);
/**
* Set Manufacturer ID
*
* Sets the manufacturer ID of a product.
*
* @param IdType $id The manufacturer ID to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setManufacturerId(IdType $id);
/**
* Set FSK 18
*
* Activates or deactivates FSK18 for a product.
*
* @param BoolType $status Should FSK be activated?
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setFsk18(BoolType $status);
/**
* Set VPE Active
*
* Activates or deactivates VPE for a product.
*
* @param BoolType $status Should VPE be activated?
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setVpeActive(BoolType $status);
/**
* Set VPE ID
*
* Sets the VPE ID of a product.
*
* @param IdType $id The VPE ID to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setVpeId(IdType $id);
/**
* Set VPE Value
*
* Sets the VPE value of a product.
*
* @param DecimalType $vpeValue The VPE value to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setVpeValue(DecimalType $vpeValue);
/**
* Set Addon Value
*
* Sets the addon value of a product.
*
* @param StringType $key The key for the addon value.
* @param StringType $value The value for the addon.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setAddonValue(StringType $key, StringType $value);
/**
* Sets the added date time.
*
* @param DateTime $date Added date time to set.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function setAddedDateTime(DateTime $date);
/**
* Add Addon Values
*
* Adds a key value collection to a product.
*
* @param KeyValueCollection $keyValueCollection The key value collection to add.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function addAddonValues(KeyValueCollection $keyValueCollection);
/**
* Delete Addon Value
*
* Deletes a addon value of a product.
*
* @param StringType $key The key of the addon value to delete.
*
* @return ProductInterface Same instance for chained method calls.
*/
public function deleteAddonValue(StringType $key);
/**
* Returns the image container of the product.
*
* @return ProductImageContainer Product image container.
*/
public function getImageContainer();
/**
* Returns a product's primary image.
*
* @return ProductImage
*/
public function getPrimaryImage();
/**
* Returns a product's additional images.
*
* @return ProductImageCollection
*/
public function getAdditionalImages();
}