FakeAddressInterface.php 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191
  1. <?php
  2. /**
  3. *
  4. * Copyright © Magento, Inc. All rights reserved.
  5. * See COPYING.txt for license details.
  6. */
  7. declare(strict_types=1);
  8. namespace Magento\TestModuleExtensionAttributes\Api\Data;
  9. use Magento\Framework\Api\ExtensibleDataInterface;
  10. /**
  11. * Customer address interface.
  12. */
  13. interface FakeAddressInterface extends ExtensibleDataInterface
  14. {
  15. /**#@+
  16. * Constants for keys of data array
  17. */
  18. const ID = 'id';
  19. const CUSTOMER_ID = 'customer_id';
  20. const REGION = 'region';
  21. const REGIONS = 'regions';
  22. const COUNTRY_ID = 'country_id';
  23. const STREET = 'street';
  24. const COMPANY = 'company';
  25. const TELEPHONE = 'telephone';
  26. const FAX = 'fax';
  27. const POSTCODE = 'postcode';
  28. const CITY = 'city';
  29. const FIRSTNAME = 'firstname';
  30. const LASTNAME = 'lastname';
  31. const MIDDLENAME = 'middlename';
  32. const PREFIX = 'prefix';
  33. const SUFFIX = 'suffix';
  34. const VAT_ID = 'vat_id';
  35. const DEFAULT_BILLING = 'default_billing';
  36. const DEFAULT_SHIPPING = 'default_shipping';
  37. /**#@-*/
  38. /**
  39. * Get ID
  40. *
  41. * @return int|null
  42. */
  43. public function getId();
  44. /**
  45. * Get customer ID
  46. *
  47. * @return int|null
  48. */
  49. public function getCustomerId();
  50. /**
  51. * Get region
  52. *
  53. * @return \Magento\TestModuleExtensionAttributes\Api\Data\FakeRegionInterface|null
  54. */
  55. public function getRegion();
  56. /**
  57. * Get region
  58. *
  59. * @return \Magento\TestModuleExtensionAttributes\Api\Data\FakeRegionInterface[]|null
  60. */
  61. public function getRegions();
  62. /**
  63. * Two-letter country code in ISO_3166-2 format
  64. *
  65. * @return string|null
  66. */
  67. public function getCountryId();
  68. /**
  69. * Get street
  70. *
  71. * @return string[]|null
  72. */
  73. public function getStreet();
  74. /**
  75. * Get company
  76. *
  77. * @return string|null
  78. */
  79. public function getCompany();
  80. /**
  81. * Get telephone number
  82. *
  83. * @return string|null
  84. */
  85. public function getTelephone();
  86. /**
  87. * Get fax number
  88. *
  89. * @return string|null
  90. */
  91. public function getFax();
  92. /**
  93. * Get postcode
  94. *
  95. * @return string|null
  96. */
  97. public function getPostcode();
  98. /**
  99. * Get city name
  100. *
  101. * @return string|null
  102. */
  103. public function getCity();
  104. /**
  105. * Get first name
  106. *
  107. * @return string|null
  108. */
  109. public function getFirstname();
  110. /**
  111. * Get last name
  112. *
  113. * @return string|null
  114. */
  115. public function getLastname();
  116. /**
  117. * Get middle name
  118. *
  119. * @return string|null
  120. */
  121. public function getMiddlename();
  122. /**
  123. * Get prefix
  124. *
  125. * @return string|null
  126. */
  127. public function getPrefix();
  128. /**
  129. * Get suffix
  130. *
  131. * @return string|null
  132. */
  133. public function getSuffix();
  134. /**
  135. * Get Vat id
  136. *
  137. * @return string|null
  138. */
  139. public function getVatId();
  140. /**
  141. * Get if this address is default shipping address.
  142. *
  143. * @return bool|null
  144. */
  145. public function isDefaultShipping();
  146. /**
  147. * Get if this address is default billing address
  148. *
  149. * @return bool|null
  150. */
  151. public function isDefaultBilling();
  152. /**
  153. * Retrieve existing extension attributes object or create a new one.
  154. *
  155. * @return \Magento\TestModuleExtensionAttributes\Api\Data\FakeAddressExtensionInterface|null
  156. */
  157. public function getExtensionAttributes();
  158. /**
  159. * Set an extension attributes object.
  160. *
  161. * @param \Magento\TestModuleExtensionAttributes\Api\Data\FakeAddressExtensionInterface $extensionAttributes
  162. * @return $this
  163. */
  164. public function setExtensionAttributes(
  165. \Magento\TestModuleExtensionAttributes\Api\Data\FakeAddressExtensionInterface $extensionAttributes
  166. );
  167. }