|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0 |
|
5
|
|
|
* @copyright Metaways Infosystems GmbH, 2013 |
|
6
|
|
|
* @copyright Aimeos (aimeos.org), 2015-2021 |
|
7
|
|
|
* @package Client |
|
8
|
|
|
* @subpackage Html |
|
9
|
|
|
*/ |
|
10
|
|
|
|
|
11
|
|
|
|
|
12
|
|
|
namespace Aimeos\Client\Html\Checkout\Standard\Address; |
|
13
|
|
|
|
|
14
|
|
|
|
|
15
|
|
|
// Strings for translation |
|
16
|
|
|
sprintf( 'address' ); |
|
17
|
|
|
|
|
18
|
|
|
|
|
19
|
|
|
/** |
|
20
|
|
|
* Default implementation of checkout address HTML client. |
|
21
|
|
|
* |
|
22
|
|
|
* @package Client |
|
23
|
|
|
* @subpackage Html |
|
24
|
|
|
*/ |
|
25
|
|
|
class Standard |
|
26
|
|
|
extends \Aimeos\Client\Html\Common\Client\Factory\Base |
|
27
|
|
|
implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
|
28
|
|
|
{ |
|
29
|
|
|
/** client/html/checkout/standard/address/subparts |
|
30
|
|
|
* List of HTML sub-clients rendered within the checkout standard address section |
|
31
|
|
|
* |
|
32
|
|
|
* The output of the frontend is composed of the code generated by the HTML |
|
33
|
|
|
* clients. Each HTML client can consist of serveral (or none) sub-clients |
|
34
|
|
|
* that are responsible for rendering certain sub-parts of the output. The |
|
35
|
|
|
* sub-clients can contain HTML clients themselves and therefore a |
|
36
|
|
|
* hierarchical tree of HTML clients is composed. Each HTML client creates |
|
37
|
|
|
* the output that is placed inside the container of its parent. |
|
38
|
|
|
* |
|
39
|
|
|
* At first, always the HTML code generated by the parent is printed, then |
|
40
|
|
|
* the HTML code of its sub-clients. The order of the HTML sub-clients |
|
41
|
|
|
* determines the order of the output of these sub-clients inside the parent |
|
42
|
|
|
* container. If the configured list of clients is |
|
43
|
|
|
* |
|
44
|
|
|
* array( "subclient1", "subclient2" ) |
|
45
|
|
|
* |
|
46
|
|
|
* you can easily change the order of the output by reordering the subparts: |
|
47
|
|
|
* |
|
48
|
|
|
* client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
|
49
|
|
|
* |
|
50
|
|
|
* You can also remove one or more parts if they shouldn't be rendered: |
|
51
|
|
|
* |
|
52
|
|
|
* client/html/<clients>/subparts = array( "subclient1" ) |
|
53
|
|
|
* |
|
54
|
|
|
* As the clients only generates structural HTML, the layout defined via CSS |
|
55
|
|
|
* should support adding, removing or reordering content by a fluid like |
|
56
|
|
|
* design. |
|
57
|
|
|
* |
|
58
|
|
|
* @param array List of sub-client names |
|
59
|
|
|
* @since 2014.03 |
|
60
|
|
|
* @category Developer |
|
61
|
|
|
*/ |
|
62
|
|
|
private $subPartPath = 'client/html/checkout/standard/address/subparts'; |
|
63
|
|
|
|
|
64
|
|
|
/** client/html/checkout/standard/address/billing/name |
|
65
|
|
|
* Name of the billing part used by the checkout standard address client implementation |
|
66
|
|
|
* |
|
67
|
|
|
* Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Billing\Myname". |
|
68
|
|
|
* The name is case-sensitive and you should avoid camel case names like "MyName". |
|
69
|
|
|
* |
|
70
|
|
|
* @param string Last part of the client class name |
|
71
|
|
|
* @since 2014.03 |
|
72
|
|
|
* @category Developer |
|
73
|
|
|
*/ |
|
74
|
|
|
|
|
75
|
|
|
/** client/html/checkout/standard/address/delivery/name |
|
76
|
|
|
* Name of the delivery part used by the checkout standard address client implementation |
|
77
|
|
|
* |
|
78
|
|
|
* Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Delivery\Myname". |
|
79
|
|
|
* The name is case-sensitive and you should avoid camel case names like "MyName". |
|
80
|
|
|
* |
|
81
|
|
|
* @param string Last part of the client class name |
|
82
|
|
|
* @since 2014.03 |
|
83
|
|
|
* @category Developer |
|
84
|
|
|
*/ |
|
85
|
|
|
private $subPartNames = array( 'billing', 'delivery' ); |
|
86
|
|
|
|
|
87
|
|
|
|
|
88
|
|
|
/** |
|
89
|
|
|
* Returns the HTML code for insertion into the body. |
|
90
|
|
|
* |
|
91
|
|
|
* @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
92
|
|
|
* @return string HTML code |
|
93
|
|
|
*/ |
|
94
|
|
|
public function getBody( string $uid = '' ) : string |
|
95
|
|
|
{ |
|
96
|
|
|
$view = $this->getView(); |
|
97
|
|
|
$step = $view->get( 'standardStepActive', 'address' ); |
|
98
|
|
|
$onepage = $view->config( 'client/html/checkout/standard/onepage', [] ); |
|
99
|
|
|
|
|
100
|
|
|
if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) { |
|
101
|
|
|
return ''; |
|
102
|
|
|
} |
|
103
|
|
|
|
|
104
|
|
|
$html = ''; |
|
105
|
|
|
foreach( $this->getSubClients() as $subclient ) { |
|
106
|
|
|
$html .= $subclient->setView( $view )->getBody( $uid ); |
|
107
|
|
|
} |
|
108
|
|
|
$view->addressBody = $html; |
|
109
|
|
|
|
|
110
|
|
|
/** client/html/checkout/standard/address/template-body |
|
111
|
|
|
* Relative path to the HTML body template of the checkout standard address client. |
|
112
|
|
|
* |
|
113
|
|
|
* The template file contains the HTML code and processing instructions |
|
114
|
|
|
* to generate the result shown in the body of the frontend. The |
|
115
|
|
|
* configuration string is the path to the template file relative |
|
116
|
|
|
* to the templates directory (usually in client/html/templates). |
|
117
|
|
|
* |
|
118
|
|
|
* You can overwrite the template file configuration in extensions and |
|
119
|
|
|
* provide alternative templates. These alternative templates should be |
|
120
|
|
|
* named like the default one but with the string "standard" replaced by |
|
121
|
|
|
* an unique name. You may use the name of your project for this. If |
|
122
|
|
|
* you've implemented an alternative client class as well, "standard" |
|
123
|
|
|
* should be replaced by the name of the new class. |
|
124
|
|
|
* |
|
125
|
|
|
* @param string Relative path to the template creating code for the HTML page body |
|
126
|
|
|
* @since 2014.03 |
|
127
|
|
|
* @category Developer |
|
128
|
|
|
* @see client/html/checkout/standard/address/template-header |
|
129
|
|
|
*/ |
|
130
|
|
|
$tplconf = 'client/html/checkout/standard/address/template-body'; |
|
131
|
|
|
$default = 'checkout/standard/address-body-standard'; |
|
132
|
|
|
|
|
133
|
|
|
return $view->render( $view->config( $tplconf, $default ) ); |
|
134
|
|
|
} |
|
135
|
|
|
|
|
136
|
|
|
|
|
137
|
|
|
/** |
|
138
|
|
|
* Returns the HTML string for insertion into the header. |
|
139
|
|
|
* |
|
140
|
|
|
* @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
|
141
|
|
|
* @return string|null String including HTML tags for the header on error |
|
142
|
|
|
*/ |
|
143
|
|
|
public function getHeader( string $uid = '' ) : ?string |
|
144
|
|
|
{ |
|
145
|
|
|
$view = $this->getView(); |
|
146
|
|
|
$step = $view->get( 'standardStepActive' ); |
|
147
|
|
|
$onepage = $view->config( 'client/html/checkout/standard/onepage', [] ); |
|
148
|
|
|
|
|
149
|
|
|
if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) { |
|
150
|
|
|
return ''; |
|
151
|
|
|
} |
|
152
|
|
|
|
|
153
|
|
|
return parent::getHeader( $uid ); |
|
154
|
|
|
} |
|
155
|
|
|
|
|
156
|
|
|
|
|
157
|
|
|
/** |
|
158
|
|
|
* Returns the sub-client given by its name. |
|
159
|
|
|
* |
|
160
|
|
|
* @param string $type Name of the client type |
|
161
|
|
|
* @param string|null $name Name of the sub-client (Default if null) |
|
162
|
|
|
* @return \Aimeos\Client\Html\Iface Sub-client object |
|
163
|
|
|
*/ |
|
164
|
|
|
public function getSubClient( string $type, string $name = null ) : \Aimeos\Client\Html\Iface |
|
165
|
|
|
{ |
|
166
|
|
|
/** client/html/checkout/standard/address/decorators/excludes |
|
167
|
|
|
* Excludes decorators added by the "common" option from the checkout standard address html client |
|
168
|
|
|
* |
|
169
|
|
|
* Decorators extend the functionality of a class by adding new aspects |
|
170
|
|
|
* (e.g. log what is currently done), executing the methods of the underlying |
|
171
|
|
|
* class only in certain conditions (e.g. only for logged in users) or |
|
172
|
|
|
* modify what is returned to the caller. |
|
173
|
|
|
* |
|
174
|
|
|
* This option allows you to remove a decorator added via |
|
175
|
|
|
* "client/html/common/decorators/default" before they are wrapped |
|
176
|
|
|
* around the html client. |
|
177
|
|
|
* |
|
178
|
|
|
* client/html/checkout/standard/address/decorators/excludes = array( 'decorator1' ) |
|
179
|
|
|
* |
|
180
|
|
|
* This would remove the decorator named "decorator1" from the list of |
|
181
|
|
|
* common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
|
182
|
|
|
* "client/html/common/decorators/default" to the html client. |
|
183
|
|
|
* |
|
184
|
|
|
* @param array List of decorator names |
|
185
|
|
|
* @since 2015.08 |
|
186
|
|
|
* @category Developer |
|
187
|
|
|
* @see client/html/common/decorators/default |
|
188
|
|
|
* @see client/html/checkout/standard/address/decorators/global |
|
189
|
|
|
* @see client/html/checkout/standard/address/decorators/local |
|
190
|
|
|
*/ |
|
191
|
|
|
|
|
192
|
|
|
/** client/html/checkout/standard/address/decorators/global |
|
193
|
|
|
* Adds a list of globally available decorators only to the checkout standard address html client |
|
194
|
|
|
* |
|
195
|
|
|
* Decorators extend the functionality of a class by adding new aspects |
|
196
|
|
|
* (e.g. log what is currently done), executing the methods of the underlying |
|
197
|
|
|
* class only in certain conditions (e.g. only for logged in users) or |
|
198
|
|
|
* modify what is returned to the caller. |
|
199
|
|
|
* |
|
200
|
|
|
* This option allows you to wrap global decorators |
|
201
|
|
|
* ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
|
202
|
|
|
* |
|
203
|
|
|
* client/html/checkout/standard/address/decorators/global = array( 'decorator1' ) |
|
204
|
|
|
* |
|
205
|
|
|
* This would add the decorator named "decorator1" defined by |
|
206
|
|
|
* "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
|
207
|
|
|
* |
|
208
|
|
|
* @param array List of decorator names |
|
209
|
|
|
* @since 2015.08 |
|
210
|
|
|
* @category Developer |
|
211
|
|
|
* @see client/html/common/decorators/default |
|
212
|
|
|
* @see client/html/checkout/standard/address/decorators/excludes |
|
213
|
|
|
* @see client/html/checkout/standard/address/decorators/local |
|
214
|
|
|
*/ |
|
215
|
|
|
|
|
216
|
|
|
/** client/html/checkout/standard/address/decorators/local |
|
217
|
|
|
* Adds a list of local decorators only to the checkout standard address html client |
|
218
|
|
|
* |
|
219
|
|
|
* Decorators extend the functionality of a class by adding new aspects |
|
220
|
|
|
* (e.g. log what is currently done), executing the methods of the underlying |
|
221
|
|
|
* class only in certain conditions (e.g. only for logged in users) or |
|
222
|
|
|
* modify what is returned to the caller. |
|
223
|
|
|
* |
|
224
|
|
|
* This option allows you to wrap local decorators |
|
225
|
|
|
* ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client. |
|
226
|
|
|
* |
|
227
|
|
|
* client/html/checkout/standard/address/decorators/local = array( 'decorator2' ) |
|
228
|
|
|
* |
|
229
|
|
|
* This would add the decorator named "decorator2" defined by |
|
230
|
|
|
* "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client. |
|
231
|
|
|
* |
|
232
|
|
|
* @param array List of decorator names |
|
233
|
|
|
* @since 2015.08 |
|
234
|
|
|
* @category Developer |
|
235
|
|
|
* @see client/html/common/decorators/default |
|
236
|
|
|
* @see client/html/checkout/standard/address/decorators/excludes |
|
237
|
|
|
* @see client/html/checkout/standard/address/decorators/global |
|
238
|
|
|
*/ |
|
239
|
|
|
|
|
240
|
|
|
return $this->createSubClient( 'checkout/standard/address/' . $type, $name ); |
|
241
|
|
|
} |
|
242
|
|
|
|
|
243
|
|
|
|
|
244
|
|
|
/** |
|
245
|
|
|
* Processes the input, e.g. store given values. |
|
246
|
|
|
* |
|
247
|
|
|
* A view must be available and this method doesn't generate any output |
|
248
|
|
|
* besides setting view variables. |
|
249
|
|
|
*/ |
|
250
|
|
|
public function process() |
|
251
|
|
|
{ |
|
252
|
|
|
$view = $this->getView(); |
|
253
|
|
|
|
|
254
|
|
|
try |
|
255
|
|
|
{ |
|
256
|
|
|
parent::process(); |
|
257
|
|
|
|
|
258
|
|
|
$context = $this->getContext(); |
|
259
|
|
|
|
|
260
|
|
|
if( ( $param = $view->param( 'ca_extra' ) ) !== null ) { |
|
261
|
|
|
$context->getSession()->set( 'client/html/checkout/standard/address/extra', (array) $param ); |
|
262
|
|
|
} |
|
263
|
|
|
|
|
264
|
|
|
$addresses = \Aimeos\Controller\Frontend::create( $context, 'basket' )->get()->getAddresses(); |
|
265
|
|
|
|
|
266
|
|
|
// Test if addresses are available |
|
267
|
|
|
if( !isset( $view->standardStepActive ) && count( $addresses ) === 0 ) |
|
268
|
|
|
{ |
|
269
|
|
|
$view->standardStepActive = 'address'; |
|
270
|
|
|
return; |
|
271
|
|
|
} |
|
272
|
|
|
} |
|
273
|
|
|
catch( \Exception $e ) |
|
274
|
|
|
{ |
|
275
|
|
|
$this->getView()->standardStepActive = 'address'; |
|
276
|
|
|
throw $e; |
|
277
|
|
|
} |
|
278
|
|
|
} |
|
279
|
|
|
|
|
280
|
|
|
|
|
281
|
|
|
/** |
|
282
|
|
|
* Returns the list of sub-client names configured for the client. |
|
283
|
|
|
* |
|
284
|
|
|
* @return array List of HTML client names |
|
285
|
|
|
*/ |
|
286
|
|
|
protected function getSubClientNames() : array |
|
287
|
|
|
{ |
|
288
|
|
|
return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
|
289
|
|
|
} |
|
290
|
|
|
|
|
291
|
|
|
|
|
292
|
|
|
/** |
|
293
|
|
|
* Sets the necessary parameter values in the view. |
|
294
|
|
|
* |
|
295
|
|
|
* @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
|
296
|
|
|
* @param array &$tags Result array for the list of tags that are associated to the output |
|
297
|
|
|
* @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
|
298
|
|
|
* @return \Aimeos\MW\View\Iface Modified view object |
|
299
|
|
|
*/ |
|
300
|
|
|
public function addData( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface |
|
301
|
|
|
{ |
|
302
|
|
|
$context = $this->getContext(); |
|
303
|
|
|
$localeManager = \Aimeos\MShop::create( $context, 'locale' ); |
|
304
|
|
|
$controller = \Aimeos\Controller\Frontend::create( $context, 'customer' ); |
|
305
|
|
|
$orderAddressManager = \Aimeos\MShop::create( $context, 'order/base/address' ); |
|
306
|
|
|
|
|
307
|
|
|
$deliveryAddressItems = []; |
|
308
|
|
|
$item = $controller->uses( ['customer/address'] )->get(); |
|
309
|
|
|
|
|
310
|
|
|
foreach( $item->getAddressItems() as $pos => $addrItem ) { |
|
311
|
|
|
$deliveryAddressItems[$pos] = $orderAddressManager->create()->copyFrom( $addrItem ); |
|
312
|
|
|
} |
|
313
|
|
|
|
|
314
|
|
|
$paymentAddressItem = $orderAddressManager->create() |
|
315
|
|
|
->setLanguageId( $context->getLocale()->getLanguageId() ) |
|
316
|
|
|
->copyFrom( $item->getPaymentAddress() ); |
|
317
|
|
|
|
|
318
|
|
|
$view->addressCustomerItem = $item; |
|
319
|
|
|
$view->addressPaymentItem = $paymentAddressItem; |
|
320
|
|
|
$view->addressDeliveryItems = $deliveryAddressItems; |
|
321
|
|
|
$view->addressLanguages = $localeManager->search( $localeManager->filter( true ) ) |
|
322
|
|
|
->col( 'locale.languageid', 'locale.languageid' ); |
|
323
|
|
|
|
|
324
|
|
|
/** client/html/checkout/standard/address/countries |
|
325
|
|
|
* List of available countries that that users can select from in the front-end |
|
326
|
|
|
* |
|
327
|
|
|
* This configration option is used whenever a list of countries is |
|
328
|
|
|
* shown in the front-end users can select from. It's used e.g. |
|
329
|
|
|
* if the customer should select the country he is living in the |
|
330
|
|
|
* checkout process. In case that the list is empty, no country |
|
331
|
|
|
* selection is shown. |
|
332
|
|
|
* |
|
333
|
|
|
* Each list entry must be a two letter ISO country code that is then |
|
334
|
|
|
* translated into its name. The codes have to be upper case |
|
335
|
|
|
* characters like "DE" for Germany or "GB" for Great Britain, e.g. |
|
336
|
|
|
* |
|
337
|
|
|
* array( 'DE', 'GB', ... ) |
|
338
|
|
|
* |
|
339
|
|
|
* To display the country selection, you have to add the key for the |
|
340
|
|
|
* country ID (order.base.address.languageid) to the "mandatory" or |
|
341
|
|
|
* "optional" configuration option for billing and delivery addresses. |
|
342
|
|
|
* |
|
343
|
|
|
* Until 2015-02, the configuration option was available as |
|
344
|
|
|
* "client/html/common/address/countries" starting from 2014-03. |
|
345
|
|
|
* |
|
346
|
|
|
* @param array List of two letter ISO country codes |
|
347
|
|
|
* @since 2015.02 |
|
348
|
|
|
* @category User |
|
349
|
|
|
* @category Developer |
|
350
|
|
|
* @see client/html/checkout/standard/address/billing/mandatory |
|
351
|
|
|
* @see client/html/checkout/standard/address/billing/optional |
|
352
|
|
|
* @see client/html/checkout/standard/address/delivery/mandatory |
|
353
|
|
|
* @see client/html/checkout/standard/address/delivery/optional |
|
354
|
|
|
*/ |
|
355
|
|
|
$view->addressCountries = $view->config( 'client/html/checkout/standard/address/countries', [] ); |
|
356
|
|
|
|
|
357
|
|
|
/** client/html/checkout/standard/address/states |
|
358
|
|
|
* List of available states that that users can select from in the front-end |
|
359
|
|
|
* |
|
360
|
|
|
* This configration option is used whenever a list of states is |
|
361
|
|
|
* shown in the front-end users can select from. It's used e.g. |
|
362
|
|
|
* if the customer should select the state he is living in the |
|
363
|
|
|
* checkout process. In case that the list is empty, no state |
|
364
|
|
|
* selection is shown. |
|
365
|
|
|
* |
|
366
|
|
|
* A two letter ISO country code must be the key for the list of |
|
367
|
|
|
* states that belong to this country. The list of states must then |
|
368
|
|
|
* contain the state code as key and its name as values, e.g. |
|
369
|
|
|
* |
|
370
|
|
|
* array( |
|
371
|
|
|
* 'US' => array( |
|
372
|
|
|
* 'CA' => 'California', |
|
373
|
|
|
* 'NY' => 'New York', |
|
374
|
|
|
* ... |
|
375
|
|
|
* ), |
|
376
|
|
|
* ... |
|
377
|
|
|
* ); |
|
378
|
|
|
* |
|
379
|
|
|
* The codes have to be upper case characters like "US" for the |
|
380
|
|
|
* United States or "DE" for Germany. The order of the country and |
|
381
|
|
|
* state codes determine the order of the states in the frontend and |
|
382
|
|
|
* the state codes are later used for per state tax calculation. |
|
383
|
|
|
* |
|
384
|
|
|
* To display the country selection, you have to add the key for the |
|
385
|
|
|
* state (order.base.address.state) to the "mandatory" or |
|
386
|
|
|
* "optional" configuration option for billing and delivery addresses. |
|
387
|
|
|
* You also need to add order.base.address.countryid as well because |
|
388
|
|
|
* it is required to display the states that belong to this country. |
|
389
|
|
|
* |
|
390
|
|
|
* Until 2015-02, the configuration option was available as |
|
391
|
|
|
* "client/html/common/address/states" starting from 2014-09. |
|
392
|
|
|
* |
|
393
|
|
|
* @param array Multi-dimensional list ISO country codes and state codes/names |
|
394
|
|
|
* @since 2015.02 |
|
395
|
|
|
* @category User |
|
396
|
|
|
* @category Developer |
|
397
|
|
|
* @see client/html/checkout/standard/address/billing/mandatory |
|
398
|
|
|
* @see client/html/checkout/standard/address/billing/optional |
|
399
|
|
|
* @see client/html/checkout/standard/address/delivery/mandatory |
|
400
|
|
|
* @see client/html/checkout/standard/address/delivery/optional |
|
401
|
|
|
*/ |
|
402
|
|
|
$view->addressStates = $view->config( 'client/html/checkout/standard/address/states', [] ); |
|
403
|
|
|
|
|
404
|
|
|
$view->addressExtra = $context->getSession()->get( 'client/html/checkout/standard/address/extra', [] ); |
|
405
|
|
|
|
|
406
|
|
|
return parent::addData( $view, $tags, $expire ); |
|
407
|
|
|
} |
|
408
|
|
|
} |
|
409
|
|
|
|
aimeos /
ai-client-html
