Customer_Address.php
148 lines
| 1 | <?php |
| 2 | /** |
| 3 | * WooCommerce Plugin Framework |
| 4 | * |
| 5 | * This source file is subject to the GNU General Public License v3.0 |
| 6 | * that is bundled with this package in the file license.txt. |
| 7 | * It is also available through the world-wide-web at this URL: |
| 8 | * http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 9 | * If you did not receive a copy of the license and are unable to |
| 10 | * obtain it through the world-wide-web, please send an email |
| 11 | * to license@skyverge.com so we can send you a copy immediately. |
| 12 | * |
| 13 | * @since 3.0.0 |
| 14 | * @author WooCommerce / SkyVerge |
| 15 | * @copyright Copyright (c) 2013-2019, SkyVerge, Inc. |
| 16 | * @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later |
| 17 | * |
| 18 | * Modified by WooCommerce on 01 December 2021. |
| 19 | */ |
| 20 | |
| 21 | namespace WooCommerce\Square\Framework\Addresses; |
| 22 | use WooCommerce\Square\Framework\Compatibility\Order_Compatibility; |
| 23 | |
| 24 | defined( 'ABSPATH' ) or exit; |
| 25 | |
| 26 | /** |
| 27 | * The customer address data class. |
| 28 | * |
| 29 | * Adds customer-specific data to a base address, as used for a billing or shipping address that can include first |
| 30 | * and last name. |
| 31 | * |
| 32 | * @see Address |
| 33 | * |
| 34 | * @since 3.0.0 |
| 35 | */ |
| 36 | class Customer_Address extends Address { |
| 37 | |
| 38 | |
| 39 | /** @var string customer first name */ |
| 40 | protected $first_name = ''; |
| 41 | |
| 42 | /** @var string customer last name */ |
| 43 | protected $last_name = ''; |
| 44 | |
| 45 | |
| 46 | /** Getter Methods ************************************************************************************************/ |
| 47 | |
| 48 | |
| 49 | /** |
| 50 | * Gets the customer first name. |
| 51 | * |
| 52 | * @since 3.0.0 |
| 53 | * |
| 54 | * @return string |
| 55 | */ |
| 56 | public function get_first_name() { |
| 57 | |
| 58 | return $this->first_name; |
| 59 | } |
| 60 | |
| 61 | |
| 62 | /** |
| 63 | * Gets the customer first name. |
| 64 | * |
| 65 | * @since 3.0.0 |
| 66 | * |
| 67 | * @return string |
| 68 | */ |
| 69 | public function get_last_name() { |
| 70 | |
| 71 | return $this->last_name; |
| 72 | } |
| 73 | |
| 74 | |
| 75 | /** |
| 76 | * Gets the data used to generate a hash for the address. |
| 77 | * |
| 78 | * @see Address::get_hash_data() |
| 79 | * |
| 80 | * @since 3.0.0 |
| 81 | * |
| 82 | * @return string[] |
| 83 | */ |
| 84 | protected function get_hash_data() { |
| 85 | |
| 86 | // add the first & last name to data used to generate the hash |
| 87 | $data = array_merge( |
| 88 | array( |
| 89 | $this->get_first_name(), |
| 90 | $this->get_last_name(), |
| 91 | ), |
| 92 | parent::get_hash_data() |
| 93 | ); |
| 94 | |
| 95 | return $data; |
| 96 | } |
| 97 | |
| 98 | |
| 99 | /** Setter Methods ************************************************************************************************/ |
| 100 | |
| 101 | |
| 102 | /** |
| 103 | * Sets the customer first name. |
| 104 | * |
| 105 | * @since 3.0.0 |
| 106 | * |
| 107 | * @param string $value first name value |
| 108 | */ |
| 109 | public function set_first_name( $value ) { |
| 110 | |
| 111 | $this->first_name = $value; |
| 112 | } |
| 113 | |
| 114 | |
| 115 | /** |
| 116 | * Sets the customer last name. |
| 117 | * |
| 118 | * @since 3.0.0 |
| 119 | * |
| 120 | * @param string $value first name value |
| 121 | */ |
| 122 | public function set_last_name( $value ) { |
| 123 | |
| 124 | $this->last_name = $value; |
| 125 | } |
| 126 | |
| 127 | |
| 128 | /** |
| 129 | * Sets the full address based on a WooCommerce order. |
| 130 | * |
| 131 | * @since 3.0.0 |
| 132 | * |
| 133 | * @param \WC_Order $order WooCommerce order object |
| 134 | * @param string $type address type, like billing or shipping |
| 135 | */ |
| 136 | public function set_from_order( \WC_Order $order, $type = 'billing' ) { |
| 137 | |
| 138 | $this->set_first_name( Order_Compatibility::get_prop( $order, "{$type}_first_name" ) ); |
| 139 | $this->set_last_name( Order_Compatibility::get_prop( $order, "{$type}_last_name" ) ); |
| 140 | $this->set_line_1( Order_Compatibility::get_prop( $order, "{$type}_address_1" ) ); |
| 141 | $this->set_line_2( Order_Compatibility::get_prop( $order, "{$type}_address_2" ) ); |
| 142 | $this->set_locality( Order_Compatibility::get_prop( $order, "{$type}_city" ) ); |
| 143 | $this->set_region( Order_Compatibility::get_prop( $order, "{$type}_state" ) ); |
| 144 | $this->set_country( Order_Compatibility::get_prop( $order, "{$type}_country" ) ); |
| 145 | $this->set_postcode( Order_Compatibility::get_prop( $order, "{$type}_postcode" ) ); |
| 146 | } |
| 147 | } |
| 148 |