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 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
<?php
/* --------------------------------------------------------------
GxEngineOrder.inc.php 2016-07-11
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('OrderInterface');
MainFactory::load_class('AddonValueContainerInterface');
/**
* Class GXEngineOrder
*
* This class is used for managing order data.
*
* @category System
* @package Order
* @subpackage Entities
*/
class GXEngineOrder implements OrderInterface, AddonValueContainerInterface
{
/**
* Order ID.
*
* @var int
*/
protected $orderId = 0;
/**
* Unique order hash.
*
* @var string
*/
protected $orderHash = '';
/**
* Order Status ID.
*
* @var int
*/
protected $statusId = 0;
/**
* Customer ID.
*
* @var int
*/
protected $customerId = 0;
/**
* Customer email address.
*
* @var string
*/
protected $customerEmail = '';
/**
* Customer telephone number.
*
* @var string
*/
protected $customerTelephone = '';
/**
* Customer number.
*
* @var string
*/
protected $customerNumber = '';
/**
* VAT ID number.
*
* @var string
*/
protected $vatIdNumber = '';
/**
* Customer status information.
*
* @var CustomerStatusInformation
*/
protected $customerStatusInformation;
/**
* Customer address.
*
* @var AddressBlockInterface
*/
protected $customerAddress;
/**
* Billing address.
*
* @var AddressBlockInterface
*/
protected $billingAddress;
/**
* Delivery address.
*
* @var AddressBlockInterface
*/
protected $deliveryAddress;
/**
* Order items.
*
* @var OrderItemCollection
*/
protected $orderItems;
/**
* Order totals.
*
* @var OrderTotalCollection
*/
protected $orderTotals;
/**
* Order shipping type.
*
* @var OrderShippingType
*/
protected $shippingType;
/**
* Order payment type.
*
* @var OrderPaymentType
*/
protected $paymentType;
/**
* Order currency code.
*
* @var CurrencyCode
*/
protected $currencyCode;
/**
* Order language code.
*
* @var LanguageCode
*/
protected $languageCode;
/**
* Order purchase date time.
*
* @var DateTime
*/
protected $purchaseDateTime;
/**
* Order last modified date time
*
* @var DateTime
*/
protected $lastModifiedDateTime;
/**
* Order comment.
*
* @var string
*/
protected $comment = '';
/**
* Order addon collection.
*
* @var EditableKeyValueCollection
*/
protected $addonValues;
/**
* Order status history.
*
* @var OrderStatusHistoryStorage
*/
protected $orderStatusHistoryReader;
/**
* @var float
*/
protected $totalWeight = 0.0;
/**
* GXEngineOrder constructor.
*/
public function __construct()
{
// Set object properties which need a AddressBlock.
$this->_initializeAddressProperties();
// Set object properties which need collections.
$this->_initializeCollectionProperties();
// Set object properties which need a
// type or code object like 'OrderShippingType' or 'CurrencyCode'.
$this->_initializeTypeAndCodeProperties();
// Set $purchaseDateTime and $lastModifiedDateTime to current datetime as default value.
$this->setPurchaseDateTime(new DateTime());
$this->setLastModifiedDateTime(new DateTime());
// Set empty CustomerStatusInformation object
$this->setCustomerStatusInformation(MainFactory::create('CustomerStatusInformation', new IdType(1)));
}
/**
* Initializes default values for AddressBlock properties.
*/
protected function _initializeAddressProperties()
{
// Create value objects.
$gender = MainFactory::create('CustomerGender', '');
$firstName = MainFactory::create('CustomerFirstname', '');
$lastName = MainFactory::create('CustomerLastname', '');
$company = MainFactory::create('CustomerCompany', '');
$B2BStatus = MainFactory::create('CustomerB2BStatus', true);
$street = MainFactory::create('CustomerStreet', '');
$houseNumber = MainFactory::create('CustomerHouseNumber', '');
$additionalAddressInfo = MainFactory::create('CustomerAdditionalAddressInfo', '');
$suburb = MainFactory::create('CustomerSuburb', '');
$postCode = MainFactory::create('CustomerPostcode', '');
$city = MainFactory::create('CustomerCity', '');
$country = MainFactory::create('CustomerCountry', new IdType(123),
MainFactory::create('CustomerCountryName', ''),
MainFactory::create('CustomerCountryIso2', ''),
MainFactory::create('CustomerCountryIso3', ''), new IdType(823), true);
$countryZone = MainFactory::create('CustomerCountryZone', new IdType(123),
MainFactory::create('CustomerCountryZoneName', ''),
MainFactory::create('CustomerCountryZoneIsoCode', ''));
// Set customer address.
$customerAddress = MainFactory::create('AddressBlock', $gender, $firstName, $lastName, $company, $B2BStatus,
$street, $houseNumber, $additionalAddressInfo, $suburb, $postCode, $city,
$country, $countryZone);
$this->setCustomerAddress($customerAddress);
// Set billing address.
$billingAddress = MainFactory::create('AddressBlock', $gender, $firstName, $lastName, $company, $B2BStatus,
$street, $houseNumber, $additionalAddressInfo, $suburb, $postCode, $city,
$country, $countryZone);
$this->setBillingAddress($billingAddress);
// Set delivery address.
$deliveryAddress = MainFactory::create('AddressBlock', $gender, $firstName, $lastName, $company, $B2BStatus,
$street, $houseNumber, $additionalAddressInfo, $suburb, $postCode, $city,
$country, $countryZone);
$this->setDeliveryAddress($deliveryAddress);
}
/**
* Initializes default values for Collection properties.
*/
protected function _initializeCollectionProperties()
{
// Create empty array as collection.
$collection = array();
// Set order items.
$orderItems = MainFactory::create('OrderItemCollection', $collection);
$this->setOrderItems($orderItems);
// Set order totals.
$orderTotals = MainFactory::create('OrderTotalCollection', $collection);
$this->setOrderTotals($orderTotals);
// Set addon values collection.
// Note, that there is no setter method for assign the addonValues collection.
$addonValues = MainFactory::create('EditableKeyValueCollection', $collection);
$this->addonValues = $addonValues;
}
/**
* Initializes default values for type and code properties.
*/
protected function _initializeTypeAndCodeProperties()
{
// Create empty title for type value objects.
$title = new StringType('');
// Create empty module for type value objects.
$module = new StringType('');
// Set type object: shipping type.
$shippingType = MainFactory::create('OrderShippingType', $title, $module);
$this->setShippingType($shippingType);
// Set type object: payment type.
$paymentType = MainFactory::create('OrderPaymentType', $title, $module);
$this->setPaymentType($paymentType);
// Set code object: currency code.
$currencyCode = MainFactory::create('EmptyCurrencyCode');
$this->setCurrencyCode($currencyCode);
// Set code object: language code.
$languageCode = MainFactory::create('EmptyLanguageCode');
$this->setLanguageCode($languageCode);
}
/**
* Sets the order ID.
*
* Note, that the ID will be saved as string to the class property.
*
* @param IdType $id Order ID.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setOrderId(IdType $id)
{
$this->orderId = $id->asInt();
return $this;
}
/**
* Returns the order ID.
*
* @return int Order ID.
*/
public function getOrderId()
{
return $this->orderId;
}
/**
* Sets the unique order hash.
*
* @param NonEmptyStringType $orderHash Unique order hash.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setOrderHash(NonEmptyStringType $orderHash)
{
$this->orderHash = $orderHash->asString();
return $this;
}
/**
* Returns the unique order hash.
*
* @return string Unique order hash.
*/
public function getOrderHash()
{
return $this->orderHash;
}
/**
* Sets the associated customer ID.
*
* @param IdType $id Customer ID.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setCustomerId(IdType $id)
{
$this->customerId = $id->asInt();
return $this;
}
/**
* Returns the associated customer ID.
*
* @return int Associated customer ID.
*/
public function getCustomerId()
{
return $this->customerId;
}
/**
* Sets the customer email address.
*
* @param EmailStringType $email Customer email address.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setCustomerEmail(EmailStringType $email)
{
$this->customerEmail = $email->asString();
return $this;
}
/**
* Returns the associated customer email address.
*
* @return string Associated customer email address.
*/
public function getCustomerEmail()
{
return $this->customerEmail;
}
/**
* Sets the customer telephone number.
*
* @param StringType $telephone Customer telephone number.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setCustomerTelephone(StringType $telephone)
{
$this->customerTelephone = $telephone->asString();
return $this;
}
/**
* Returns the associated customer telephone number.
*
* @return string Associated customer telephone number.
*/
public function getCustomerTelephone()
{
return $this->customerTelephone;
}
/**
* Sets the order status ID.
*
* @param IntType $id Status ID.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setStatusId(IntType $id)
{
$this->statusId = $id->asInt();
return $this;
}
/**
* Returns the order status ID.
*
* @return int Order status ID.
*/
public function getStatusId()
{
return $this->statusId;
}
/**
* Sets customer number of Order
*
* @param StringType $customerNumber Customer number.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setCustomerNumber(StringType $customerNumber)
{
$this->customerNumber = $customerNumber->asString();
}
/**
* Returns the customer number.
*
* @return string Customer number.
*/
public function getCustomerNumber()
{
return $this->customerNumber;
}
/**
* Sets the VAT ID Number.
*
* @param StringType $vatIdNumber VAT ID number.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setVatIdNumber(StringType $vatIdNumber)
{
$this->vatIdNumber = $vatIdNumber->asString();
}
/**
* Returns the VAT ID number.
*
* @return string VAT ID number.
*/
public function getVatIdNumber()
{
return $this->vatIdNumber;
}
/**
* Sets the customer status information.
*
* @param CustomerStatusInformation $customerStatusInformation Customer status information.
*/
public function setCustomerStatusInformation(CustomerStatusInformation $customerStatusInformation)
{
$this->customerStatusInformation = $customerStatusInformation;
}
/**
* Returns the Customer status information.
*
* @return CustomerStatusInformation Customer status information.
*/
public function getCustomerStatusInformation()
{
return $this->customerStatusInformation;
}
/**
* Sets the customer address.
*
* @param AddressBlockInterface $address Customer address.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setCustomerAddress(AddressBlockInterface $address)
{
$this->customerAddress = $address;
return $this;
}
/**
* Returns the customer address.
*
* @return AddressBlockInterface Customer address.
*/
public function getCustomerAddress()
{
return $this->customerAddress;
}
/**
* Sets the billing address.
*
* @param AddressBlockInterface $address Billing address.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setBillingAddress(AddressBlockInterface $address)
{
$this->billingAddress = $address;
return $this;
}
/**
* Returns the billing address.
*
* @return AddressBlockInterface Billing address.
*/
public function getBillingAddress()
{
return $this->billingAddress;
}
/**
* Sets the delivery address.
*
* @param AddressBlockInterface $address Delivery address.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setDeliveryAddress(AddressBlockInterface $address)
{
$this->deliveryAddress = $address;
return $this;
}
/**
* Returns the delivery address.
*
* @return AddressBlockInterface Delivery address.
*/
public function getDeliveryAddress()
{
return $this->deliveryAddress;
}
/**
* Sets the order items collection.
*
* @param OrderItemCollection $collection Items collection.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setOrderItems(OrderItemCollection $collection)
{
$this->orderItems = $collection;
return $this;
}
/**
* Returns the order items collection.
*
* @return OrderItemCollection Order items collection.
*/
public function getOrderItems()
{
return $this->orderItems;
}
/**
* Sets the order total collection.
*
* @param OrderTotalCollection $collection Total collection.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setOrderTotals(OrderTotalCollection $collection)
{
$this->orderTotals = $collection;
return $this;
}
/**
* Returns the order totals collection.
*
* @return OrderTotalCollection Order totals collection.
*/
public function getOrderTotals()
{
return $this->orderTotals;
}
/**
* Sets the order shipping type.
*
* @param OrderShippingType $shippingType Shipping type.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setShippingType(OrderShippingType $shippingType)
{
$this->shippingType = $shippingType;
return $this;
}
/**
* Returns the order shipping type.
*
* @return OrderShippingType Order shipping type.
*/
public function getShippingType()
{
return $this->shippingType;
}
/**
* Sets the order payment type.
*
* @param OrderPaymentType $paymentType Payment type.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setPaymentType(OrderPaymentType $paymentType)
{
$this->paymentType = $paymentType;
return $this;
}
/**
* Returns the order payment type.
*
* @return OrderPaymentType Order payment type.
*/
public function getPaymentType()
{
return $this->paymentType;
}
/**
* Sets the order currency code.
*
* @param CurrencyCode $currencyCode Currency code.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setCurrencyCode(CurrencyCode $currencyCode)
{
$this->currencyCode = $currencyCode;
return $this;
}
/**
* Returns the order currency code.
*
* @return CurrencyCode Order currency code.
*/
public function getCurrencyCode()
{
return $this->currencyCode;
}
/**
* Sets the order language code.
*
* @param LanguageCode $languageCode Language code.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setLanguageCode(LanguageCode $languageCode)
{
$this->languageCode = $languageCode;
return $this;
}
/**
* Returns the order language code.
*
* @return LanguageCode Order language code.
*/
public function getLanguageCode()
{
return $this->languageCode;
}
/**
* Sets the order purchase date time.
*
* @param DateTime $purchaseDateTime Purchase date time.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setPurchaseDateTime(DateTime $purchaseDateTime)
{
$this->purchaseDateTime = $purchaseDateTime;
return $this;
}
/**
* Returns the order purchase datetime.
*
* @return DateTime Order purchase datetime.
*/
public function getPurchaseDateTime()
{
return $this->purchaseDateTime;
}
/**
* Sets the date time of last modification.
*
* @param DateTime $lastModifiedDateTime Last modification date time
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setLastModifiedDateTime(DateTime $lastModifiedDateTime)
{
$this->lastModifiedDateTime = $lastModifiedDateTime;
return $this;
}
/**
* Returns the datetime of last modification.
*
* @return DateTime Datetime of last modification.
*/
public function getLastModifiedDateTime()
{
return $this->lastModifiedDateTime;
}
/**
* Sets order status history storage object.
*
* @param OrderStatusHistoryReaderInterface $orderStatusHistoryReader Order status history storage object.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setOrderStatusHistoryReader(OrderStatusHistoryReaderInterface $orderStatusHistoryReader)
{
$this->orderStatusHistoryReader = $orderStatusHistoryReader;
return $this;
}
/**
* Returns the order status history.
*
* @return OrderStatusHistoryListItemCollection Order status history.
*/
public function getStatusHistory()
{
if(isset($this->orderStatusHistoryReader)
&& $this->orderStatusHistoryReader instanceof OrderStatusHistoryReaderInterface
)
{
return $this->orderStatusHistoryReader->getStatusHistory(new IdType($this->orderId));
}
return MainFactory::create('OrderStatusHistoryListItemCollection', array());
}
/**
* Sets the order comment.
*
* @param StringType $comment Comment.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setComment(StringType $comment)
{
$this->comment = $comment->asString();
return $this;
}
/**
* Returns the order comment.
*
* @return string Order comment.
*/
public function getComment()
{
return $this->comment;
}
/**
* Returns the total weight of the ordered products.
*
* @return double
*/
public function getTotalWeight()
{
return $this->totalWeight;
}
/**
* Sets the total weight of the ordered products.
*
* @param \DecimalType $totalWeight
*
* @return $this|GXEngineOrder Same instance for method chaining.
*/
public function setTotalWeight(DecimalType $totalWeight)
{
$this->totalWeight = $totalWeight->asDecimal();
return $this;
}
/**
* Returns the addon value container ID.
* The addon value container id is equal to the orders id.
*
* @return int Addon value container ID
*/
public function getAddonValueContainerId()
{
return $this->getOrderId();
}
/**
* Returns the order addon value collection.
*
* @return EditableKeyValueCollection Order addon value collection.
*/
public function getAddonValue(StringType $key)
{
return $this->addonValues->getValue($key->asString());
}
/**
* Returns the order addon value collection.
*
* @return EditableKeyValueCollection Order addon value collection.
*/
public function getAddonValues()
{
return $this->addonValues->getClone();
}
/**
* Adds/updates a key value in the addon value collection.
*
* @param StringType $key Addon key.
* @param StringType $value Addon value.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function setAddonValue(StringType $key, StringType $value)
{
$this->addonValues->setValue($key->asString(), $value->asString());
return $this;
}
/**
* Adds an addon collection to the existing one.
*
* @param KeyValueCollection $addonCollection Addon collection.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function addAddonValues(KeyValueCollection $addonCollection)
{
$this->addonValues->addCollection($addonCollection);
return $this;
}
/**
* Removes an addon value from the addon value container by the given key.
*
* @param StringType $key Addon key.
*
* @return GXEngineOrder Same instance for method chaining.
*/
public function deleteAddonValue(StringType $key)
{
$this->addonValues->deleteValue($key->asString());
return $this;
}
}