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
<?php
/* --------------------------------------------------------------
Customer.inc.php 2015-06-27
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('CustomerInterface');
/**
* Class Customer
*
* This class is used for managing customer data
*
* @category System
* @package Customer
* @implements CustomerInterface
*/
class Customer implements CustomerInterface
{
/**
* Customer ID.
* @var int
*/
protected $id;
/**
* Customer number.
* @var CustomerNumberInterface
*/
protected $customerNumber;
/**
* Customer gender.
* @var CustomerGenderInterface
*/
protected $gender;
/**
* Customer first name.
* @var CustomerFirstnameInterface
*/
protected $firstname;
/**
* Customer last name.
* @var CustomerLastnameInterface
*/
protected $lastname;
/**
* Customer date of birth.
* @var DateTime
*/
protected $dateOfBirth;
/**
* Customer VAT number.
* @var CustomerVatNumberInterface
*/
protected $vatNumber;
/**
* Customer VAT number status.
* @var int
*/
protected $vatNumberStatus = 0;
/**
* Customer call number.
* @var CustomerCallNumberInterface
*/
protected $telephoneNumber;
/**
* Customer fax number.
* @var CustomerCallNumberInterface
*/
protected $faxNumber;
/**
* Customer E-Mail address.
* @var CustomerEmailInterface
*/
protected $email;
/**
* Customer password.
* @var CustomerPasswordInterface
*/
protected $password;
/**
* Customer default address.
* @var CustomerAddressInterface
*/
protected $defaultAddress;
/**
* Customer status ID.
* @var int
*/
protected $customerStatusId = 0;
/**
* Customer guest status.
* @var bool
*/
protected $isGuest = false;
/**
* Addons collection.
*
* @var EditableKeyValueCollection
*/
protected $addonValues;
/**
* Constructor of the class Customer
*/
public function __construct()
{
$this->customerNumber = MainFactory::create('CustomerNumber', '');
$this->gender = MainFactory::create('CustomerGender', '');
$this->firstname = MainFactory::create('CustomerFirstname', '');
$this->lastname = MainFactory::create('CustomerLastname', '');
$this->dateOfBirth = MainFactory::create('CustomerDateOfBirth', '1000-01-01 00:00:00');
$this->vatNumber = MainFactory::create('CustomerVatNumber', '');
$this->telephoneNumber = MainFactory::create('CustomerCallNumber', '');
$this->faxNumber = MainFactory::create('CustomerCallNumber', '');
$this->email = MainFactory::create('CustomerEmail', 'temp@example.org');
$this->password = MainFactory::create('CustomerHashedPassword',
new NonEmptyStringType(md5(time() . rand(1, 999000))));
$this->addonValues = MainFactory::create('EditableKeyValueCollection', array());
}
/**
* Returns the customer's ID.
*
* @return int Customer's ID.
*/
public function getId()
{
return $this->id;
}
/**
* Returns the customer ID.
*
* @return int
*/
public function getAddonValueContainerId()
{
return $this->getId();
}
/**
* Returns the customer's number.
*
* @return string customerNumber Customer's number.
*/
public function getCustomerNumber()
{
return $this->customerNumber;
}
/**
* Sets the customer's number.
*
* @param CustomerNumberInterface $customerNumber Customer's number.
*/
public function setCustomerNumber(CustomerNumberInterface $customerNumber)
{
$this->customerNumber = $customerNumber;
}
/**
* Returns the customer's status ID.
*
* @return int customerStatusId Customer's status ID.
*/
public function getStatusId()
{
return $this->customerStatusId;
}
/**
* Sets the customer's status ID.
*
* @param int $p_statusId Customer's status ID.
*
* @throws InvalidArgumentException
*/
public function setStatusId($p_statusId)
{
if(!is_numeric($p_statusId) || ((int)$p_statusId != (double)$p_statusId))
{
throw new InvalidArgumentException('$p_statusId int expected.');
}
$this->customerStatusId = (int)$p_statusId;
}
/**
* Checks if customer is a guest.
*
* @return bool Is customer a guest?
*/
public function isGuest()
{
return $this->isGuest;
}
/**
* Returns the customer's gender.
*
* @return CustomerGenderInterface Customer's gender.
*/
public function getGender()
{
return $this->gender;
}
/**
* Returns the customer's first name.
*
* @return CustomerFirstnameInterface Customer's first name.
*/
public function getFirstname()
{
return $this->firstname;
}
/**
* Returns the customer's last name.
*
* @return CustomerLastnameInterface Customer's last name.
*/
public function getLastname()
{
return $this->lastname;
}
/**
* Returns the customer's date of birth.
*
* @return DateTime date of birth Customer's date of birth.
*/
public function getDateOfBirth()
{
return $this->dateOfBirth;
}
/**
* Returns the customer's VAT number.
*
* @return CustomerVatNumberInterface Customer's VAT number.
*/
public function getVatNumber()
{
return $this->vatNumber;
}
/**
* Returns the customer's VAT number status.
*
* @return int Customer's VAT number status.
*/
public function getVatNumberStatus()
{
return $this->vatNumberStatus;
}
/**
* Returns the customer's telephone number.
*
* @return CustomerCallNumberInterface Customer's telephone number.
*/
public function getTelephoneNumber()
{
return $this->telephoneNumber;
}
/**
* Returns the customer's fax number.
*
* @return CustomerCallNumberInterface Customer's fax number.
*/
public function getFaxNumber()
{
return $this->faxNumber;
}
/**
* Returns the customer's email.
*
* @return CustomerEmailInterface Customer's email.
*/
public function getEmail()
{
return $this->email;
}
/**
* Returns the customer's password.
*
* @return CustomerPasswordInterface Customer's password.
*/
public function getPassword()
{
return $this->password;
}
/**
* Returns the customer's default address.
*
* @return CustomerAddressInterface Customer's default address.
*/
public function getDefaultAddress()
{
return $this->defaultAddress;
}
/**
* Sets the customer's guest status.
*
* @param boolean $p_isPGuest Customer's guest status.
*
* @throws InvalidArgumentException if $p_isGuest is not a boolean value
*/
public function setGuest($p_isPGuest)
{
if(!is_bool($p_isPGuest))
{
throw new InvalidArgumentException('$p_isGuest bool expected.');
}
$this->isGuest = (boolean)$p_isPGuest;
}
/**
* Sets the customer's ID.
*
* @param IdType $id customerId Customer ID.
*
* @throws InvalidArgumentException If $p_id is not an integer or if $p_id is lower than 1.
*/
public function setId(IdType $id)
{
$this->id = (int)(string)$id;
}
/**
* Sets the customer's gender.
*
* @param CustomerGenderInterface $gender Customer's gender.
*/
public function setGender(CustomerGenderInterface $gender)
{
$this->gender = $gender;
}
/**
* Sets the customer's first name.
*
* @param CustomerFirstnameInterface $firstname Customer's first name.
*/
public function setFirstname(CustomerFirstnameInterface $firstname)
{
$this->firstname = $firstname;
}
/**
* Sets the customer's last name.
*
* @param CustomerLastnameInterface $lastname Customer's last name.
*/
public function setLastname(CustomerLastnameInterface $lastname)
{
$this->lastname = $lastname;
}
/**
* Sets the customer's date of birth.
*
* @param DateTime $dateOfBirth date of birth Customer's date of birth.
*/
public function setDateOfBirth(DateTime $dateOfBirth)
{
$this->dateOfBirth = $dateOfBirth;
}
/**
* Sets the customer's VAT number.
*
* @param CustomerVatNumberInterface $vatNumber Customer's VAT number.
*/
public function setVatNumber(CustomerVatNumberInterface $vatNumber)
{
$this->vatNumber = $vatNumber;
}
/**
* Sets the customer's VAT number status.
*
* @param int $p_vatNumberStatus Customer's VAT number status.
*/
public function setVatNumberStatus($p_vatNumberStatus)
{
$this->vatNumberStatus = (int)$p_vatNumberStatus;
}
/**
* Sets the customer's telephone number.
*
* @param CustomerCallNumberInterface $telephoneNumber Customer's telephone number.
*/
public function setTelephoneNumber(CustomerCallNumberInterface $telephoneNumber)
{
$this->telephoneNumber = $telephoneNumber;
}
/**
* Sets the customer's fax number.
*
* @param CustomerCallNumberInterface $faxNumber Customer's fax number.
*/
public function setFaxNumber(CustomerCallNumberInterface $faxNumber)
{
$this->faxNumber = $faxNumber;
}
/**
* Sets the customer's email.
*
* @param CustomerEmailInterface $email Customer's email.
*/
public function setEmail(CustomerEmailInterface $email)
{
$this->email = $email;
}
/**
* Sets the customer's password.
*
* @param CustomerPasswordInterface $password Customer's password.
*/
public function setPassword(CustomerPasswordInterface $password)
{
$this->password = $password;
}
/**
* Sets the customer's default address.
*
* @param CustomerAddressInterface $address Customer's default address.
*/
public function setDefaultAddress(CustomerAddressInterface $address)
{
$this->defaultAddress = $address;
}
/**
* Get Addon Value
*
* Returns the addon value of a product, depending on the provided key.
*
* @throws InvalidArgumentException if the key is not valid.
*
* @param StringType $key The key of the addon value to return.
*
* @return string The addon value.
*/
public function getAddonValue(StringType $key)
{
return $this->addonValues->getValue($key->asString());
}
/**
* Get Addon Values
*
* Returns a key value collection of the product.
*
* @return KeyValueCollection The key value collection.
*/
public function getAddonValues()
{
return $this->addonValues;
}
/**
* 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 GXEngineProduct Same instance for chained method calls.
*/
public function setAddonValue(StringType $key, StringType $value)
{
$this->addonValues->setValue($key->asString(), $value->asString());
return $this;
}
/**
* Add Addon Values
*
* Adds a key value collection to a product.
*
* @param KeyValueCollection $keyValueCollection The key value collection to add.
*
* @return GXEngineProduct Same instance for chained method calls.
*/
public function addAddonValues(KeyValueCollection $keyValueCollection)
{
$this->addonValues->addCollection($keyValueCollection);
return $this;
}
/**
* Delete Addon Value
*
* Deletes an addon value of a product.
*
* @throws InvalidArgumentException if the key is not valid.
*
* @param StringType $key The key of the addon value to delete.
*
* @return GXEngineProduct Same instance for chained method calls.
*/
public function deleteAddonValue(StringType $key)
{
$this->addonValues->deleteValue($key->asString());
return $this;
}
}