1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/** |
4
|
|
|
* @license LGPLv3, http://opensource.org/licenses/LGPL-3.0 |
5
|
|
|
* @copyright Aimeos (aimeos.org), 2015-2021 |
6
|
|
|
* @package Client |
7
|
|
|
* @subpackage Html |
8
|
|
|
*/ |
9
|
|
|
|
10
|
|
|
|
11
|
|
|
namespace Aimeos\Client\Html\Checkout\Standard\Process; |
12
|
|
|
|
13
|
|
|
|
14
|
|
|
// Strings for translation |
15
|
|
|
sprintf( 'process' ); |
16
|
|
|
|
17
|
|
|
|
18
|
|
|
/** |
19
|
|
|
* Default implementation of checkout process HTML client. |
20
|
|
|
* |
21
|
|
|
* @package Client |
22
|
|
|
* @subpackage Html |
23
|
|
|
*/ |
24
|
|
|
class Standard |
25
|
|
|
extends \Aimeos\Client\Html\Common\Client\Factory\Base |
26
|
|
|
implements \Aimeos\Client\Html\Common\Client\Factory\Iface |
27
|
|
|
{ |
28
|
|
|
/** client/html/checkout/standard/process/subparts |
29
|
|
|
* List of HTML sub-clients rendered within the checkout standard process section |
30
|
|
|
* |
31
|
|
|
* The output of the frontend is composed of the code generated by the HTML |
32
|
|
|
* clients. Each HTML client can consist of serveral (or none) sub-clients |
33
|
|
|
* that are responsible for rendering certain sub-parts of the output. The |
34
|
|
|
* sub-clients can contain HTML clients themselves and therefore a |
35
|
|
|
* hierarchical tree of HTML clients is composed. Each HTML client creates |
36
|
|
|
* the output that is placed inside the container of its parent. |
37
|
|
|
* |
38
|
|
|
* At first, always the HTML code generated by the parent is printed, then |
39
|
|
|
* the HTML code of its sub-clients. The order of the HTML sub-clients |
40
|
|
|
* determines the order of the output of these sub-clients inside the parent |
41
|
|
|
* container. If the configured list of clients is |
42
|
|
|
* |
43
|
|
|
* array( "subclient1", "subclient2" ) |
44
|
|
|
* |
45
|
|
|
* you can easily change the order of the output by reordering the subparts: |
46
|
|
|
* |
47
|
|
|
* client/html/<clients>/subparts = array( "subclient1", "subclient2" ) |
48
|
|
|
* |
49
|
|
|
* You can also remove one or more parts if they shouldn't be rendered: |
50
|
|
|
* |
51
|
|
|
* client/html/<clients>/subparts = array( "subclient1" ) |
52
|
|
|
* |
53
|
|
|
* As the clients only generates structural HTML, the layout defined via CSS |
54
|
|
|
* should support adding, removing or reordering content by a fluid like |
55
|
|
|
* design. |
56
|
|
|
* |
57
|
|
|
* @param array List of sub-client names |
58
|
|
|
* @since 2014.03 |
59
|
|
|
* @category Developer |
60
|
|
|
*/ |
61
|
|
|
private $subPartPath = 'client/html/checkout/standard/process/subparts'; |
62
|
|
|
|
63
|
|
|
/** client/html/checkout/standard/process/account/name |
64
|
|
|
* Name of the account part used by the checkout standard process client implementation |
65
|
|
|
* |
66
|
|
|
* Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Process\Account\Myname". |
67
|
|
|
* The name is case-sensitive and you should avoid camel case names like "MyName". |
68
|
|
|
* |
69
|
|
|
* @param string Last part of the client class name |
70
|
|
|
* @since 2017.04 |
71
|
|
|
* @category Developer |
72
|
|
|
*/ |
73
|
|
|
|
74
|
|
|
/** client/html/checkout/standard/process/address/name |
75
|
|
|
* Name of the address part used by the checkout standard process client implementation |
76
|
|
|
* |
77
|
|
|
* Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Process\Address\Myname". |
78
|
|
|
* The name is case-sensitive and you should avoid camel case names like "MyName". |
79
|
|
|
* |
80
|
|
|
* @param string Last part of the client class name |
81
|
|
|
* @since 2017.04 |
82
|
|
|
* @category Developer |
83
|
|
|
*/ |
84
|
|
|
private $subPartNames = array( 'account', 'address' ); |
85
|
|
|
|
86
|
|
|
|
87
|
|
|
/** |
88
|
|
|
* Returns the HTML code for insertion into the body. |
89
|
|
|
* |
90
|
|
|
* @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
91
|
|
|
* @return string HTML code |
92
|
|
|
*/ |
93
|
|
|
public function getBody( string $uid = '' ) : string |
94
|
|
|
{ |
95
|
|
|
$view = $this->getView(); |
96
|
|
|
|
97
|
|
|
if( $view->get( 'standardStepActive' ) !== 'process' ) { |
98
|
|
|
return ''; |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
$html = ''; |
102
|
|
|
foreach( $this->getSubClients() as $subclient ) { |
103
|
|
|
$html .= $subclient->setView( $view )->getBody( $uid ); |
104
|
|
|
} |
105
|
|
|
$view->processBody = $html; |
106
|
|
|
|
107
|
|
|
/** client/html/checkout/standard/process/template-body |
108
|
|
|
* Relative path to the HTML body template of the checkout standard process client. |
109
|
|
|
* |
110
|
|
|
* The template file contains the HTML code and processing instructions |
111
|
|
|
* to generate the result shown in the body of the frontend. The |
112
|
|
|
* configuration string is the path to the template file relative |
113
|
|
|
* to the templates directory (usually in client/html/templates). |
114
|
|
|
* |
115
|
|
|
* You can overwrite the template file configuration in extensions and |
116
|
|
|
* provide alternative templates. These alternative templates should be |
117
|
|
|
* named like the default one but with the string "standard" replaced by |
118
|
|
|
* an unique name. You may use the name of your project for this. If |
119
|
|
|
* you've implemented an alternative client class as well, "standard" |
120
|
|
|
* should be replaced by the name of the new class. |
121
|
|
|
* |
122
|
|
|
* @param string Relative path to the template creating code for the HTML page body |
123
|
|
|
* @since 2014.03 |
124
|
|
|
* @category Developer |
125
|
|
|
* @see client/html/checkout/standard/process/template-header |
126
|
|
|
*/ |
127
|
|
|
$tplconf = 'client/html/checkout/standard/process/template-body'; |
128
|
|
|
$default = 'checkout/standard/process-body-standard'; |
129
|
|
|
|
130
|
|
|
return $view->render( $view->config( $tplconf, $default ) ); |
131
|
|
|
} |
132
|
|
|
|
133
|
|
|
|
134
|
|
|
/** |
135
|
|
|
* Returns the HTML string for insertion into the header. |
136
|
|
|
* |
137
|
|
|
* @param string $uid Unique identifier for the output if the content is placed more than once on the same page |
138
|
|
|
* @return string|null String including HTML tags for the header on error |
139
|
|
|
*/ |
140
|
|
|
public function getHeader( string $uid = '' ) : ?string |
141
|
|
|
{ |
142
|
|
|
$view = $this->getView(); |
143
|
|
|
|
144
|
|
|
if( $view->get( 'standardStepActive' ) !== 'process' ) { |
145
|
|
|
return ''; |
146
|
|
|
} |
147
|
|
|
|
148
|
|
|
return parent::getHeader( $uid ); |
149
|
|
|
} |
150
|
|
|
|
151
|
|
|
|
152
|
|
|
/** |
153
|
|
|
* Returns the sub-client given by its name. |
154
|
|
|
* |
155
|
|
|
* @param string $type Name of the client type |
156
|
|
|
* @param string|null $name Name of the sub-client (Default if null) |
157
|
|
|
* @return \Aimeos\Client\Html\Iface Sub-client object |
158
|
|
|
*/ |
159
|
|
|
public function getSubClient( string $type, string $name = null ) : \Aimeos\Client\Html\Iface |
160
|
|
|
{ |
161
|
|
|
/** client/html/checkout/standard/process/decorators/excludes |
162
|
|
|
* Excludes decorators added by the "common" option from the checkout standard process html client |
163
|
|
|
* |
164
|
|
|
* Decorators extend the functionality of a class by adding new aspects |
165
|
|
|
* (e.g. log what is currently done), executing the methods of the underlying |
166
|
|
|
* class only in certain conditions (e.g. only for logged in users) or |
167
|
|
|
* modify what is returned to the caller. |
168
|
|
|
* |
169
|
|
|
* This option allows you to remove a decorator added via |
170
|
|
|
* "client/html/common/decorators/default" before they are wrapped |
171
|
|
|
* around the html client. |
172
|
|
|
* |
173
|
|
|
* client/html/checkout/standard/process/decorators/excludes = array( 'decorator1' ) |
174
|
|
|
* |
175
|
|
|
* This would remove the decorator named "decorator1" from the list of |
176
|
|
|
* common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via |
177
|
|
|
* "client/html/common/decorators/default" to the html client. |
178
|
|
|
* |
179
|
|
|
* @param array List of decorator names |
180
|
|
|
* @since 2015.08 |
181
|
|
|
* @category Developer |
182
|
|
|
* @see client/html/common/decorators/default |
183
|
|
|
* @see client/html/checkout/standard/process/decorators/global |
184
|
|
|
* @see client/html/checkout/standard/process/decorators/local |
185
|
|
|
*/ |
186
|
|
|
|
187
|
|
|
/** client/html/checkout/standard/process/decorators/global |
188
|
|
|
* Adds a list of globally available decorators only to the checkout standard process html client |
189
|
|
|
* |
190
|
|
|
* Decorators extend the functionality of a class by adding new aspects |
191
|
|
|
* (e.g. log what is currently done), executing the methods of the underlying |
192
|
|
|
* class only in certain conditions (e.g. only for logged in users) or |
193
|
|
|
* modify what is returned to the caller. |
194
|
|
|
* |
195
|
|
|
* This option allows you to wrap global decorators |
196
|
|
|
* ("\Aimeos\Client\Html\Common\Decorator\*") around the html client. |
197
|
|
|
* |
198
|
|
|
* client/html/checkout/standard/process/decorators/global = array( 'decorator1' ) |
199
|
|
|
* |
200
|
|
|
* This would add the decorator named "decorator1" defined by |
201
|
|
|
* "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client. |
202
|
|
|
* |
203
|
|
|
* @param array List of decorator names |
204
|
|
|
* @since 2015.08 |
205
|
|
|
* @category Developer |
206
|
|
|
* @see client/html/common/decorators/default |
207
|
|
|
* @see client/html/checkout/standard/process/decorators/excludes |
208
|
|
|
* @see client/html/checkout/standard/process/decorators/local |
209
|
|
|
*/ |
210
|
|
|
|
211
|
|
|
/** client/html/checkout/standard/process/decorators/local |
212
|
|
|
* Adds a list of local decorators only to the checkout standard process html client |
213
|
|
|
* |
214
|
|
|
* Decorators extend the functionality of a class by adding new aspects |
215
|
|
|
* (e.g. log what is currently done), executing the methods of the underlying |
216
|
|
|
* class only in certain conditions (e.g. only for logged in users) or |
217
|
|
|
* modify what is returned to the caller. |
218
|
|
|
* |
219
|
|
|
* This option allows you to wrap local decorators |
220
|
|
|
* ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client. |
221
|
|
|
* |
222
|
|
|
* client/html/checkout/standard/process/decorators/local = array( 'decorator2' ) |
223
|
|
|
* |
224
|
|
|
* This would add the decorator named "decorator2" defined by |
225
|
|
|
* "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client. |
226
|
|
|
* |
227
|
|
|
* @param array List of decorator names |
228
|
|
|
* @since 2015.08 |
229
|
|
|
* @category Developer |
230
|
|
|
* @see client/html/common/decorators/default |
231
|
|
|
* @see client/html/checkout/standard/process/decorators/excludes |
232
|
|
|
* @see client/html/checkout/standard/process/decorators/global |
233
|
|
|
*/ |
234
|
|
|
|
235
|
|
|
return $this->createSubClient( 'checkout/standard/process/' . $type, $name ); |
236
|
|
|
} |
237
|
|
|
|
238
|
|
|
|
239
|
|
|
/** |
240
|
|
|
* Processes the input, e.g. store given order. |
241
|
|
|
* |
242
|
|
|
* A view must be available and this method doesn't generate any output |
243
|
|
|
* besides setting view variables. |
244
|
|
|
*/ |
245
|
|
|
public function process() |
246
|
|
|
{ |
247
|
|
|
$view = $this->getView(); |
248
|
|
|
$context = $this->getContext(); |
249
|
|
|
|
250
|
|
|
if( $view->param( 'c_step' ) !== 'process' |
251
|
|
|
|| $view->get( 'standardErrorList', [] ) !== [] |
252
|
|
|
|| $view->get( 'standardStepActive' ) !== null |
253
|
|
|
) { |
254
|
|
|
return true; |
255
|
|
|
} |
256
|
|
|
|
257
|
|
|
try |
258
|
|
|
{ |
259
|
|
|
$orderCntl = \Aimeos\Controller\Frontend::create( $context, 'order' ); |
260
|
|
|
$basketCntl = \Aimeos\Controller\Frontend::create( $context, 'basket' ); |
261
|
|
|
|
262
|
|
|
|
263
|
|
|
if( $view->param( 'cs_order', null ) !== null ) |
264
|
|
|
{ |
265
|
|
|
parent::process(); |
266
|
|
|
|
267
|
|
|
$basket = $basketCntl->store(); |
268
|
|
|
$orderItem = $orderCntl->add( $basket->getId(), ['order.type' => 'web'] )->store(); |
269
|
|
|
|
270
|
|
|
$context->getSession()->set( 'aimeos/orderid', $orderItem->getId() ); |
271
|
|
|
} |
272
|
|
|
elseif( $view->param( 'cp_payment', null ) !== null ) |
273
|
|
|
{ |
274
|
|
|
$parts = \Aimeos\MShop\Order\Item\Base\Base::PARTS_ALL; |
275
|
|
|
$orderItem = $orderCntl->get( $context->getSession()->get( 'aimeos/orderid' ), false ); |
276
|
|
|
$basket = $basketCntl->load( $orderItem->getBaseId(), $parts, false ); |
277
|
|
|
} |
278
|
|
|
else |
279
|
|
|
{ |
280
|
|
|
return; |
281
|
|
|
} |
282
|
|
|
|
283
|
|
|
if( ( $form = $this->processPayment( $basket, $orderItem ) ) === null ) |
284
|
|
|
{ |
285
|
|
|
$services = $basket->getService( \Aimeos\MShop\Order\Item\Base\Service\Base::TYPE_PAYMENT ); |
286
|
|
|
$args = ( $service = reset( $services ) ) ? ['code' => $service->getCode()] : []; |
287
|
|
|
|
288
|
|
|
$orderCntl->save( $orderItem->setPaymentStatus( \Aimeos\MShop\Order\Item\Base::PAY_AUTHORIZED ) ); |
289
|
|
|
$view->standardUrlNext = $this->getUrlConfirm( $view, $args, ['absoluteUri' => true] ); |
290
|
|
|
$view->standardMethod = 'POST'; |
291
|
|
|
} |
292
|
|
|
else // no payment service available |
293
|
|
|
{ |
294
|
|
|
$view = $this->addFormData( $view, $form ); |
295
|
|
|
} |
296
|
|
|
} |
297
|
|
|
catch( \Aimeos\Client\Html\Exception $e ) |
298
|
|
|
{ |
299
|
|
|
$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) ); |
300
|
|
|
$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error ); |
301
|
|
|
} |
302
|
|
|
catch( \Aimeos\Controller\Frontend\Exception $e ) |
303
|
|
|
{ |
304
|
|
|
$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) ); |
305
|
|
|
$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error ); |
306
|
|
|
} |
307
|
|
|
catch( \Aimeos\MShop\Exception $e ) |
308
|
|
|
{ |
309
|
|
|
$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) ); |
310
|
|
|
$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error ); |
311
|
|
|
} |
312
|
|
|
catch( \Exception $e ) |
313
|
|
|
{ |
314
|
|
|
$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) ); |
315
|
|
|
$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error ); |
316
|
|
|
$this->logException( $e ); |
317
|
|
|
} |
318
|
|
|
} |
319
|
|
|
|
320
|
|
|
|
321
|
|
|
/** |
322
|
|
|
* Adds the required data for the payment form to the view |
323
|
|
|
* |
324
|
|
|
* @param \Aimeos\MW\View\Iface $view View object to assign the data to |
325
|
|
|
* @param \Aimeos\MShop\Common\Helper\Form\Iface $form Form helper object including the form data |
326
|
|
|
* @return \Aimeos\MW\View\Iface View object with assigned data |
327
|
|
|
*/ |
328
|
|
|
protected function addFormData( \Aimeos\MW\View\Iface $view, \Aimeos\MShop\Common\Helper\Form\Iface $form ) |
329
|
|
|
{ |
330
|
|
|
$url = $form->getUrl(); |
331
|
|
|
|
332
|
|
|
if( $form->getMethod() === 'GET' ) |
333
|
|
|
{ |
334
|
|
|
$urlParams = []; |
335
|
|
|
|
336
|
|
|
foreach( $form->getValues() as $item ) |
337
|
|
|
{ |
338
|
|
|
foreach( (array) $item->getDefault() as $key => $value ) { |
339
|
|
|
$urlParams[$item->getInternalCode()][$key] = $value; |
340
|
|
|
} |
341
|
|
|
} |
342
|
|
|
|
343
|
|
|
$url .= strpos( $url, '?' ) ? '&' : '?' . map( $urlParams )->toUrl(); |
344
|
|
|
} |
345
|
|
|
|
346
|
|
|
$public = $hidden = []; |
347
|
|
|
|
348
|
|
|
foreach( $form->getValues() as $key => $item ) |
349
|
|
|
{ |
350
|
|
|
if( $item->isPublic() ) { |
351
|
|
|
$public[$key] = $item; |
352
|
|
|
} else { |
353
|
|
|
$hidden[$key] = $item; |
354
|
|
|
} |
355
|
|
|
} |
356
|
|
|
|
357
|
|
|
$view->standardUrlNext = $url; |
358
|
|
|
$view->standardProcessPublic = $public; |
359
|
|
|
$view->standardProcessHidden = $hidden; |
360
|
|
|
$view->standardProcessParams = $form->getValues(); |
361
|
|
|
$view->standardUrlExternal = $form->getExternal(); |
362
|
|
|
$view->standardMethod = $form->getMethod(); |
363
|
|
|
$view->standardHtml = $form->getHtml(); |
364
|
|
|
|
365
|
|
|
return $view; |
366
|
|
|
} |
367
|
|
|
|
368
|
|
|
|
369
|
|
|
/** |
370
|
|
|
* Returns the form helper object for building the payment form in the frontend |
371
|
|
|
* |
372
|
|
|
* @param \Aimeos\MShop\Order\Item\Base\Iface $basket Saved basket object including payment service object |
373
|
|
|
* @param \Aimeos\MShop\Order\Item\Iface $orderItem Saved order item created for the basket object |
374
|
|
|
* @return \Aimeos\MShop\Common\Helper\Form\Iface|null Form object with URL, parameters, etc. |
375
|
|
|
* or null if no form data is required |
376
|
|
|
*/ |
377
|
|
|
protected function processPayment( \Aimeos\MShop\Order\Item\Base\Iface $basket, \Aimeos\MShop\Order\Item\Iface $orderItem ) : ?\Aimeos\MShop\Common\Helper\Form\Iface |
378
|
|
|
{ |
379
|
|
|
if( $basket->getPrice()->getValue() + $basket->getPrice()->getCosts() <= 0 |
380
|
|
|
&& $this->isSubscription( $basket->getProducts() ) === false |
381
|
|
|
) { |
382
|
|
|
return null; |
383
|
|
|
} |
384
|
|
|
|
385
|
|
|
$view = $this->getView(); |
386
|
|
|
$services = $basket->getService( \Aimeos\MShop\Order\Item\Base\Service\Base::TYPE_PAYMENT ); |
387
|
|
|
|
388
|
|
|
if( ( $service = reset( $services ) ) !== false ) |
389
|
|
|
{ |
390
|
|
|
$args = array( 'code' => $service->getCode() ); |
391
|
|
|
$urls = array( |
392
|
|
|
'payment.url-self' => $this->getUrlSelf( $view, ['c_step' => 'process'], [] ), |
393
|
|
|
'payment.url-update' => $this->getUrlUpdate( $view, $args + ['orderid' => $orderItem->getId()], ['absoluteUri' => true] ), |
394
|
|
|
'payment.url-success' => $this->getUrlConfirm( $view, $args, ['absoluteUri' => true] ), |
395
|
|
|
); |
396
|
|
|
|
397
|
|
|
$params = $view->param(); |
398
|
|
|
foreach( $service->getAttributeItems() as $item ) { |
399
|
|
|
$params[$item->getCode()] = $item->getValue(); |
400
|
|
|
} |
401
|
|
|
|
402
|
|
|
$serviceCntl = \Aimeos\Controller\Frontend::create( $this->getContext(), 'service' ); |
403
|
|
|
return $serviceCntl->process( $orderItem, $service->getServiceId(), $urls, $params ); |
404
|
|
|
} |
405
|
|
|
} |
406
|
|
|
|
407
|
|
|
|
408
|
|
|
/** |
409
|
|
|
* Returns the list of sub-client names configured for the client. |
410
|
|
|
* |
411
|
|
|
* @return array List of HTML client names |
412
|
|
|
*/ |
413
|
|
|
protected function getSubClientNames() : array |
414
|
|
|
{ |
415
|
|
|
return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames ); |
416
|
|
|
} |
417
|
|
|
|
418
|
|
|
|
419
|
|
|
/** |
420
|
|
|
* Returns the URL to the confirm page. |
421
|
|
|
* |
422
|
|
|
* @param \Aimeos\MW\View\Iface $view View object |
423
|
|
|
* @param array $params Parameters that should be part of the URL |
424
|
|
|
* @param array $config Default URL configuration |
425
|
|
|
* @return string URL string |
426
|
|
|
*/ |
427
|
|
|
protected function getUrlConfirm( \Aimeos\MW\View\Iface $view, array $params, array $config ) : string |
428
|
|
|
{ |
429
|
|
|
/** client/html/checkout/confirm/url/target |
430
|
|
|
* Destination of the URL where the controller specified in the URL is known |
431
|
|
|
* |
432
|
|
|
* The destination can be a page ID like in a content management system or the |
433
|
|
|
* module of a software development framework. This "target" must contain or know |
434
|
|
|
* the controller that should be called by the generated URL. |
435
|
|
|
* |
436
|
|
|
* @param string Destination of the URL |
437
|
|
|
* @since 2014.03 |
438
|
|
|
* @category Developer |
439
|
|
|
* @see client/html/checkout/confirm/url/controller |
440
|
|
|
* @see client/html/checkout/confirm/url/action |
441
|
|
|
* @see client/html/checkout/confirm/url/config |
442
|
|
|
*/ |
443
|
|
|
$target = $view->config( 'client/html/checkout/confirm/url/target' ); |
444
|
|
|
|
445
|
|
|
/** client/html/checkout/confirm/url/controller |
446
|
|
|
* Name of the controller whose action should be called |
447
|
|
|
* |
448
|
|
|
* In Model-View-Controller (MVC) applications, the controller contains the methods |
449
|
|
|
* that create parts of the output displayed in the generated HTML page. Controller |
450
|
|
|
* names are usually alpha-numeric. |
451
|
|
|
* |
452
|
|
|
* @param string Name of the controller |
453
|
|
|
* @since 2014.03 |
454
|
|
|
* @category Developer |
455
|
|
|
* @see client/html/checkout/confirm/url/target |
456
|
|
|
* @see client/html/checkout/confirm/url/action |
457
|
|
|
* @see client/html/checkout/confirm/url/config |
458
|
|
|
*/ |
459
|
|
|
$cntl = $view->config( 'client/html/checkout/confirm/url/controller', 'checkout' ); |
460
|
|
|
|
461
|
|
|
/** client/html/checkout/confirm/url/action |
462
|
|
|
* Name of the action that should create the output |
463
|
|
|
* |
464
|
|
|
* In Model-View-Controller (MVC) applications, actions are the methods of a |
465
|
|
|
* controller that create parts of the output displayed in the generated HTML page. |
466
|
|
|
* Action names are usually alpha-numeric. |
467
|
|
|
* |
468
|
|
|
* @param string Name of the action |
469
|
|
|
* @since 2014.03 |
470
|
|
|
* @category Developer |
471
|
|
|
* @see client/html/checkout/confirm/url/target |
472
|
|
|
* @see client/html/checkout/confirm/url/controller |
473
|
|
|
* @see client/html/checkout/confirm/url/config |
474
|
|
|
*/ |
475
|
|
|
$action = $view->config( 'client/html/checkout/confirm/url/action', 'confirm' ); |
476
|
|
|
|
477
|
|
|
/** client/html/checkout/confirm/url/config |
478
|
|
|
* Associative list of configuration options used for generating the URL |
479
|
|
|
* |
480
|
|
|
* You can specify additional options as key/value pairs used when generating |
481
|
|
|
* the URLs, like |
482
|
|
|
* |
483
|
|
|
* client/html/<clientname>/url/config = array( 'absoluteUri' => true ) |
484
|
|
|
* |
485
|
|
|
* The available key/value pairs depend on the application that embeds the e-commerce |
486
|
|
|
* framework. This is because the infrastructure of the application is used for |
487
|
|
|
* generating the URLs. The full list of available config options is referenced |
488
|
|
|
* in the "see also" section of this page. |
489
|
|
|
* |
490
|
|
|
* @param string Associative list of configuration options |
491
|
|
|
* @since 2014.03 |
492
|
|
|
* @category Developer |
493
|
|
|
* @see client/html/checkout/confirm/url/target |
494
|
|
|
* @see client/html/checkout/confirm/url/controller |
495
|
|
|
* @see client/html/checkout/confirm/url/action |
496
|
|
|
* @see client/html/url/config |
497
|
|
|
*/ |
498
|
|
|
$config = $view->config( 'client/html/checkout/confirm/url/config', $config ); |
499
|
|
|
|
500
|
|
|
return $view->url( $target, $cntl, $action, $params, [], $config ); |
501
|
|
|
} |
502
|
|
|
|
503
|
|
|
|
504
|
|
|
/** |
505
|
|
|
* Returns the URL to the current page. |
506
|
|
|
* |
507
|
|
|
* @param \Aimeos\MW\View\Iface $view View object |
508
|
|
|
* @param array $params Parameters that should be part of the URL |
509
|
|
|
* @param array $config Default URL configuration |
510
|
|
|
* @return string URL string |
511
|
|
|
*/ |
512
|
|
|
protected function getUrlSelf( \Aimeos\MW\View\Iface $view, array $params, array $config ) : string |
513
|
|
|
{ |
514
|
|
|
/** client/html/checkout/standard/url/target |
515
|
|
|
* Destination of the URL where the controller specified in the URL is known |
516
|
|
|
* |
517
|
|
|
* The destination can be a page ID like in a content management system or the |
518
|
|
|
* module of a software development framework. This "target" must contain or know |
519
|
|
|
* the controller that should be called by the generated URL. |
520
|
|
|
* |
521
|
|
|
* @param string Destination of the URL |
522
|
|
|
* @since 2014.03 |
523
|
|
|
* @category Developer |
524
|
|
|
* @see client/html/checkout/standard/url/controller |
525
|
|
|
* @see client/html/checkout/standard/url/action |
526
|
|
|
* @see client/html/checkout/standard/url/config |
527
|
|
|
*/ |
528
|
|
|
$target = $view->config( 'client/html/checkout/standard/url/target' ); |
529
|
|
|
|
530
|
|
|
/** client/html/checkout/standard/url/controller |
531
|
|
|
* Name of the controller whose action should be called |
532
|
|
|
* |
533
|
|
|
* In Model-View-Controller (MVC) applications, the controller contains the methods |
534
|
|
|
* that create parts of the output displayed in the generated HTML page. Controller |
535
|
|
|
* names are usually alpha-numeric. |
536
|
|
|
* |
537
|
|
|
* @param string Name of the controller |
538
|
|
|
* @since 2014.03 |
539
|
|
|
* @category Developer |
540
|
|
|
* @see client/html/checkout/standard/url/target |
541
|
|
|
* @see client/html/checkout/standard/url/action |
542
|
|
|
* @see client/html/checkout/standard/url/config |
543
|
|
|
*/ |
544
|
|
|
$cntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' ); |
545
|
|
|
|
546
|
|
|
/** client/html/checkout/standard/url/action |
547
|
|
|
* Name of the action that should create the output |
548
|
|
|
* |
549
|
|
|
* In Model-View-Controller (MVC) applications, actions are the methods of a |
550
|
|
|
* controller that create parts of the output displayed in the generated HTML page. |
551
|
|
|
* Action names are usually alpha-numeric. |
552
|
|
|
* |
553
|
|
|
* @param string Name of the action |
554
|
|
|
* @since 2014.03 |
555
|
|
|
* @category Developer |
556
|
|
|
* @see client/html/checkout/standard/url/target |
557
|
|
|
* @see client/html/checkout/standard/url/controller |
558
|
|
|
* @see client/html/checkout/standard/url/config |
559
|
|
|
*/ |
560
|
|
|
$action = $view->config( 'client/html/checkout/standard/url/action', 'index' ); |
561
|
|
|
|
562
|
|
|
/** client/html/checkout/standard/url/config |
563
|
|
|
* Associative list of configuration options used for generating the URL |
564
|
|
|
* |
565
|
|
|
* You can specify additional options as key/value pairs used when generating |
566
|
|
|
* the URLs, like |
567
|
|
|
* |
568
|
|
|
* client/html/<clientname>/url/config = array( 'absoluteUri' => true ) |
569
|
|
|
* |
570
|
|
|
* The available key/value pairs depend on the application that embeds the e-commerce |
571
|
|
|
* framework. This is because the infrastructure of the application is used for |
572
|
|
|
* generating the URLs. The full list of available config options is referenced |
573
|
|
|
* in the "see also" section of this page. |
574
|
|
|
* |
575
|
|
|
* @param string Associative list of configuration options |
576
|
|
|
* @since 2014.03 |
577
|
|
|
* @category Developer |
578
|
|
|
* @see client/html/checkout/standard/url/target |
579
|
|
|
* @see client/html/checkout/standard/url/controller |
580
|
|
|
* @see client/html/checkout/standard/url/action |
581
|
|
|
* @see client/html/url/config |
582
|
|
|
*/ |
583
|
|
|
$config = $view->config( 'client/html/checkout/standard/url/config', $config ); |
584
|
|
|
|
585
|
|
|
return $view->url( $target, $cntl, $action, $params, [], $config ); |
586
|
|
|
} |
587
|
|
|
|
588
|
|
|
|
589
|
|
|
/** |
590
|
|
|
* Returns the URL to the update page. |
591
|
|
|
* |
592
|
|
|
* @param \Aimeos\MW\View\Iface $view View object |
593
|
|
|
* @param array $params Parameters that should be part of the URL |
594
|
|
|
* @param array $config Default URL configuration |
595
|
|
|
* @return string URL string |
596
|
|
|
*/ |
597
|
|
|
protected function getUrlUpdate( \Aimeos\MW\View\Iface $view, array $params, array $config ) : string |
598
|
|
|
{ |
599
|
|
|
/** client/html/checkout/update/url/target |
600
|
|
|
* Destination of the URL where the controller specified in the URL is known |
601
|
|
|
* |
602
|
|
|
* The destination can be a page ID like in a content management system or the |
603
|
|
|
* module of a software development framework. This "target" must contain or know |
604
|
|
|
* the controller that should be called by the generated URL. |
605
|
|
|
* |
606
|
|
|
* @param string Destination of the URL |
607
|
|
|
* @since 2014.03 |
608
|
|
|
* @category Developer |
609
|
|
|
* @see client/html/checkout/update/url/controller |
610
|
|
|
* @see client/html/checkout/update/url/action |
611
|
|
|
* @see client/html/checkout/update/url/config |
612
|
|
|
*/ |
613
|
|
|
$target = $view->config( 'client/html/checkout/update/url/target' ); |
614
|
|
|
|
615
|
|
|
/** client/html/checkout/update/url/controller |
616
|
|
|
* Name of the controller whose action should be called |
617
|
|
|
* |
618
|
|
|
* In Model-View-Controller (MVC) applications, the controller contains the methods |
619
|
|
|
* that create parts of the output displayed in the generated HTML page. Controller |
620
|
|
|
* names are usually alpha-numeric. |
621
|
|
|
* |
622
|
|
|
* @param string Name of the controller |
623
|
|
|
* @since 2014.03 |
624
|
|
|
* @category Developer |
625
|
|
|
* @see client/html/checkout/update/url/target |
626
|
|
|
* @see client/html/checkout/update/url/action |
627
|
|
|
* @see client/html/checkout/update/url/config |
628
|
|
|
*/ |
629
|
|
|
$cntl = $view->config( 'client/html/checkout/update/url/controller', 'checkout' ); |
630
|
|
|
|
631
|
|
|
/** client/html/checkout/update/url/action |
632
|
|
|
* Name of the action that should create the output |
633
|
|
|
* |
634
|
|
|
* In Model-View-Controller (MVC) applications, actions are the methods of a |
635
|
|
|
* controller that create parts of the output displayed in the generated HTML page. |
636
|
|
|
* Action names are usually alpha-numeric. |
637
|
|
|
* |
638
|
|
|
* @param string Name of the action |
639
|
|
|
* @since 2014.03 |
640
|
|
|
* @category Developer |
641
|
|
|
* @see client/html/checkout/update/url/target |
642
|
|
|
* @see client/html/checkout/update/url/controller |
643
|
|
|
* @see client/html/checkout/update/url/config |
644
|
|
|
*/ |
645
|
|
|
$action = $view->config( 'client/html/checkout/update/url/action', 'update' ); |
646
|
|
|
|
647
|
|
|
/** client/html/checkout/update/url/config |
648
|
|
|
* Associative list of configuration options used for generating the URL |
649
|
|
|
* |
650
|
|
|
* You can specify additional options as key/value pairs used when generating |
651
|
|
|
* the URLs, like |
652
|
|
|
* |
653
|
|
|
* client/html/<clientname>/url/config = array( 'absoluteUri' => true ) |
654
|
|
|
* |
655
|
|
|
* The available key/value pairs depend on the application that embeds the e-commerce |
656
|
|
|
* framework. This is because the infrastructure of the application is used for |
657
|
|
|
* generating the URLs. The full list of available config options is referenced |
658
|
|
|
* in the "see also" section of this page. |
659
|
|
|
* |
660
|
|
|
* @param string Associative list of configuration options |
661
|
|
|
* @since 2014.03 |
662
|
|
|
* @category Developer |
663
|
|
|
* @see client/html/checkout/update/url/target |
664
|
|
|
* @see client/html/checkout/update/url/controller |
665
|
|
|
* @see client/html/checkout/update/url/action |
666
|
|
|
* @see client/html/url/config |
667
|
|
|
*/ |
668
|
|
|
$config = $view->config( 'client/html/checkout/update/url/config', $config ); |
669
|
|
|
|
670
|
|
|
return $view->url( $target, $cntl, $action, $params, [], $config ); |
671
|
|
|
} |
672
|
|
|
|
673
|
|
|
|
674
|
|
|
/** |
675
|
|
|
* Tests if one of the products is a subscription |
676
|
|
|
* |
677
|
|
|
* @param \Aimeos\Map $products Ordered products implementing \Aimeos\MShop\Order\Item\Base\Product\Iface |
678
|
|
|
* @return bool True if at least one product is a subscription, false if not |
679
|
|
|
*/ |
680
|
|
|
protected function isSubscription( \Aimeos\Map $products ) : bool |
681
|
|
|
{ |
682
|
|
|
foreach( $products as $orderProduct ) |
683
|
|
|
{ |
684
|
|
|
if( $orderProduct->getAttributeItem( 'interval', 'config' ) ) { |
685
|
|
|
return true; |
686
|
|
|
} |
687
|
|
|
} |
688
|
|
|
|
689
|
|
|
return false; |
690
|
|
|
} |
691
|
|
|
|
692
|
|
|
|
693
|
|
|
/** |
694
|
|
|
* Sets the necessary parameter values in the view. |
695
|
|
|
* |
696
|
|
|
* @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output |
697
|
|
|
* @param array &$tags Result array for the list of tags that are associated to the output |
698
|
|
|
* @param string|null &$expire Result variable for the expiration date of the output (null for no expiry) |
699
|
|
|
* @return \Aimeos\MW\View\Iface Modified view object |
700
|
|
|
*/ |
701
|
|
|
public function addData( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface |
702
|
|
|
{ |
703
|
|
|
$view->standardUrlPayment = $this->getUrlSelf( $view, array( 'c_step' => 'payment' ), [] ); |
704
|
|
|
|
705
|
|
|
return parent::addData( $view, $tags, $expire ); |
706
|
|
|
} |
707
|
|
|
} |
708
|
|
|
|