LocationInterface.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Model\Shipment;
  6. /**
  7. * Temando Shipment Location Interface.
  8. *
  9. * @package Temando\Shipping\Model
  10. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  11. * @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  12. * @link https://www.temando.com/
  13. */
  14. interface LocationInterface
  15. {
  16. const NAME = 'name';
  17. const COMPANY = 'company';
  18. const PERSON_FIRST_NAME = 'person_first_name';
  19. const PERSON_LAST_NAME = 'person_last_name';
  20. const EMAIL = 'email';
  21. const PHONE_NUMBER = 'phone_number';
  22. const STREET = 'street';
  23. const CITY = 'city';
  24. const POSTAL_CODE = 'postal_code';
  25. const REGION_CODE = 'region_code';
  26. const COUNTRY_CODE = 'country_code';
  27. const TYPE = 'type';
  28. const OPENING_HOURS = 'opening_hours';
  29. /**
  30. * @return string
  31. */
  32. public function getName();
  33. /**
  34. * Get organisation name.
  35. *
  36. * @return string
  37. */
  38. public function getCompany();
  39. /**
  40. * Get contact person's first name.
  41. *
  42. * @return string
  43. */
  44. public function getPersonFirstName();
  45. /**
  46. * Get contact person's last name.
  47. *
  48. * @return string
  49. */
  50. public function getPersonLastName();
  51. /**
  52. * Get contact person's email address.
  53. * @return string
  54. */
  55. public function getEmail();
  56. /**
  57. * Get contact person's telephone number.
  58. *
  59. * @return string
  60. */
  61. public function getPhoneNumber();
  62. /**
  63. * Get address street lines.
  64. *
  65. * @return string[]
  66. */
  67. public function getStreet();
  68. /**
  69. * Get address locality.
  70. *
  71. * @return string
  72. */
  73. public function getCity();
  74. /**
  75. * Get address postal code.
  76. *
  77. * @return string
  78. */
  79. public function getPostalCode();
  80. /**
  81. * Get address administrative area code.
  82. *
  83. * @return string
  84. */
  85. public function getRegionCode();
  86. /**
  87. * Get address country ISO 2 code.
  88. * @return string
  89. */
  90. public function getCountryCode();
  91. /**
  92. * Get address type, e.g. "Store", "Warehouse", etc.
  93. * @return string
  94. */
  95. public function getType();
  96. /**
  97. * Get location opening hours
  98. *
  99. * @return string[][]
  100. */
  101. public function getOpeningHours();
  102. }