Passed
Pull Request — master (#138)
by
unknown
04:45
created

Standard   A

Complexity

Total Complexity 38

Size/Duplication

Total Lines 695
Duplicated Lines 0 %

Importance

Changes 5
Bugs 0 Features 0
Metric Value
eloc 127
c 5
b 0
f 0
dl 0
loc 695
rs 9.36
wmc 38

12 Methods

Rating   Name   Duplication   Size   Complexity  
A getHeader() 0 9 2
A getBody() 0 38 3
A getSubClient() 0 77 1
C process() 0 84 12
A isSubscription() 0 10 3
A getSubClientNames() 0 3 1
B addFormData() 0 38 7
A getUrlConfirm() 0 74 1
A addData() 0 5 1
A getUrlUpdate() 0 74 1
A processPayment() 0 28 5
A getUrlSelf() 0 74 1
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
				$args = array();
286
				$config = array();
287
288
				$services = $basket->getService( \Aimeos\MShop\Order\Item\Base\Service\Base::TYPE_PAYMENT );
289
290
				$paymentstatus = $context->getConfig()->get('client/html/checkout/standard/process/zero-total-payment-status',
291
					\Aimeos\MShop\Order\Item\Base::PAY_AUTHORIZED
292
				);
293
294
				if( ( $service = reset( $services ) ) !== false )
295
				{
296
					$args = array( 'code' => $service->getCode() );
297
					$config = array( 'absoluteUri' => true, 'namespace' => false );
298
				}
299
300
				$orderCntl->save( $orderItem->setPaymentStatus( $paymentstatus ) );
301
				$view->standardUrlNext = $this->getUrlConfirm( $view, $args, $config );
302
				$view->standardMethod = 'POST';
303
			}
304
			else // no payment service available
305
			{
306
				$view = $this->addFormData( $view, $form );
307
			}
308
		}
309
		catch( \Aimeos\Client\Html\Exception $e )
310
		{
311
			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
312
			$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error );
313
		}
314
		catch( \Aimeos\Controller\Frontend\Exception $e )
315
		{
316
			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
317
			$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error );
318
		}
319
		catch( \Aimeos\MShop\Exception $e )
320
		{
321
			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
322
			$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error );
323
		}
324
		catch( \Exception $e )
325
		{
326
			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
327
			$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), $error );
328
			$this->logException( $e );
329
		}
330
	}
331
332
333
	/**
334
	 * Adds the required data for the payment form to the view
335
	 *
336
	 * @param \Aimeos\MW\View\Iface $view View object to assign the data to
337
	 * @param \Aimeos\MShop\Common\Helper\Form\Iface $form Form helper object including the form data
338
	 * @return \Aimeos\MW\View\Iface View object with assigned data
339
	 */
340
	protected function addFormData( \Aimeos\MW\View\Iface $view, \Aimeos\MShop\Common\Helper\Form\Iface $form )
341
	{
342
		$url = $form->getUrl();
343
344
		if( $form->getMethod() === 'GET' )
345
		{
346
			$urlParams = [];
347
348
			foreach( $form->getValues() as $item )
349
			{
350
				foreach( (array) $item->getDefault() as $key => $value ) {
351
					$urlParams[$item->getInternalCode()][$key] = $value;
352
				}
353
			}
354
355
			$url .= strpos( $url, '?' ) ? '&' : '?' . map( $urlParams )->toUrl();
356
		}
357
358
		$public = $hidden = [];
359
360
		foreach( $form->getValues() as $key => $item )
361
		{
362
			if( $item->isPublic() ) {
363
				$public[$key] = $item;
364
			} else {
365
				$hidden[$key] = $item;
366
			}
367
		}
368
369
		$view->standardUrlNext = $url;
370
		$view->standardProcessPublic = $public;
371
		$view->standardProcessHidden = $hidden;
372
		$view->standardProcessParams = $form->getValues();
373
		$view->standardUrlExternal = $form->getExternal();
374
		$view->standardMethod = $form->getMethod();
375
		$view->standardHtml = $form->getHtml();
376
377
		return $view;
378
	}
379
380
381
	/**
382
	 * Returns the form helper object for building the payment form in the frontend
383
	 *
384
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Saved basket object including payment service object
385
	 * @param \Aimeos\MShop\Order\Item\Iface $orderItem Saved order item created for the basket object
386
	 * @return \Aimeos\MShop\Common\Helper\Form\Iface|null Form object with URL, parameters, etc.
387
	 * 	or null if no form data is required
388
	 */
389
	protected function processPayment( \Aimeos\MShop\Order\Item\Base\Iface $basket, \Aimeos\MShop\Order\Item\Iface $orderItem ) : ?\Aimeos\MShop\Common\Helper\Form\Iface
390
	{
391
		if( $basket->getPrice()->getValue() + $basket->getPrice()->getCosts() <= 0
392
			&& $this->isSubscription( $basket->getProducts() ) === false
393
		) {
394
			return null;
395
		}
396
397
		$view = $this->getView();
398
		$services = $basket->getService( \Aimeos\MShop\Order\Item\Base\Service\Base::TYPE_PAYMENT );
399
400
		if( ( $service = reset( $services ) ) !== false )
401
		{
402
			$args = array( 'code' => $service->getCode() );
403
			$config = array( 'absoluteUri' => true, 'namespace' => false );
404
			$urls = array(
405
				'payment.url-self' => $this->getUrlSelf( $view, ['c_step' => 'process'], [] ),
406
				'payment.url-update' => $this->getUrlUpdate( $view, $args + ['orderid' => $orderItem->getId()], $config ),
407
				'payment.url-success' => $this->getUrlConfirm( $view, $args, $config ),
408
			);
409
410
			$params = $view->param();
411
			foreach( $service->getAttributeItems() as $item ) {
412
				$params[$item->getCode()] = $item->getValue();
413
			}
414
415
			$serviceCntl = \Aimeos\Controller\Frontend::create( $this->getContext(), 'service' );
416
			return $serviceCntl->process( $orderItem, $service->getServiceId(), $urls, $params );
417
		}
418
	}
419
420
421
	/**
422
	 * Returns the list of sub-client names configured for the client.
423
	 *
424
	 * @return array List of HTML client names
425
	 */
426
	protected function getSubClientNames() : array
427
	{
428
		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
429
	}
430
431
432
	/**
433
	 * Returns the URL to the confirm page.
434
	 *
435
	 * @param \Aimeos\MW\View\Iface $view View object
436
	 * @param array $params Parameters that should be part of the URL
437
	 * @param array $config Default URL configuration
438
	 * @return string URL string
439
	 */
440
	protected function getUrlConfirm( \Aimeos\MW\View\Iface $view, array $params, array $config ) : string
441
	{
442
		/** client/html/checkout/confirm/url/target
443
		 * Destination of the URL where the controller specified in the URL is known
444
		 *
445
		 * The destination can be a page ID like in a content management system or the
446
		 * module of a software development framework. This "target" must contain or know
447
		 * the controller that should be called by the generated URL.
448
		 *
449
		 * @param string Destination of the URL
450
		 * @since 2014.03
451
		 * @category Developer
452
		 * @see client/html/checkout/confirm/url/controller
453
		 * @see client/html/checkout/confirm/url/action
454
		 * @see client/html/checkout/confirm/url/config
455
		 */
456
		$target = $view->config( 'client/html/checkout/confirm/url/target' );
457
458
		/** client/html/checkout/confirm/url/controller
459
		 * Name of the controller whose action should be called
460
		 *
461
		 * In Model-View-Controller (MVC) applications, the controller contains the methods
462
		 * that create parts of the output displayed in the generated HTML page. Controller
463
		 * names are usually alpha-numeric.
464
		 *
465
		 * @param string Name of the controller
466
		 * @since 2014.03
467
		 * @category Developer
468
		 * @see client/html/checkout/confirm/url/target
469
		 * @see client/html/checkout/confirm/url/action
470
		 * @see client/html/checkout/confirm/url/config
471
		 */
472
		$cntl = $view->config( 'client/html/checkout/confirm/url/controller', 'checkout' );
473
474
		/** client/html/checkout/confirm/url/action
475
		 * Name of the action that should create the output
476
		 *
477
		 * In Model-View-Controller (MVC) applications, actions are the methods of a
478
		 * controller that create parts of the output displayed in the generated HTML page.
479
		 * Action names are usually alpha-numeric.
480
		 *
481
		 * @param string Name of the action
482
		 * @since 2014.03
483
		 * @category Developer
484
		 * @see client/html/checkout/confirm/url/target
485
		 * @see client/html/checkout/confirm/url/controller
486
		 * @see client/html/checkout/confirm/url/config
487
		 */
488
		$action = $view->config( 'client/html/checkout/confirm/url/action', 'confirm' );
489
490
		/** client/html/checkout/confirm/url/config
491
		 * Associative list of configuration options used for generating the URL
492
		 *
493
		 * You can specify additional options as key/value pairs used when generating
494
		 * the URLs, like
495
		 *
496
		 *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
497
		 *
498
		 * The available key/value pairs depend on the application that embeds the e-commerce
499
		 * framework. This is because the infrastructure of the application is used for
500
		 * generating the URLs. The full list of available config options is referenced
501
		 * in the "see also" section of this page.
502
		 *
503
		 * @param string Associative list of configuration options
504
		 * @since 2014.03
505
		 * @category Developer
506
		 * @see client/html/checkout/confirm/url/target
507
		 * @see client/html/checkout/confirm/url/controller
508
		 * @see client/html/checkout/confirm/url/action
509
		 * @see client/html/url/config
510
		 */
511
		$config = $view->config( 'client/html/checkout/confirm/url/config', $config );
512
513
		return $view->url( $target, $cntl, $action, $params, [], $config );
514
	}
515
516
517
	/**
518
	 * Returns the URL to the current page.
519
	 *
520
	 * @param \Aimeos\MW\View\Iface $view View object
521
	 * @param array $params Parameters that should be part of the URL
522
	 * @param array $config Default URL configuration
523
	 * @return string URL string
524
	 */
525
	protected function getUrlSelf( \Aimeos\MW\View\Iface $view, array $params, array $config ) : string
526
	{
527
		/** client/html/checkout/standard/url/target
528
		 * Destination of the URL where the controller specified in the URL is known
529
		 *
530
		 * The destination can be a page ID like in a content management system or the
531
		 * module of a software development framework. This "target" must contain or know
532
		 * the controller that should be called by the generated URL.
533
		 *
534
		 * @param string Destination of the URL
535
		 * @since 2014.03
536
		 * @category Developer
537
		 * @see client/html/checkout/standard/url/controller
538
		 * @see client/html/checkout/standard/url/action
539
		 * @see client/html/checkout/standard/url/config
540
		 */
541
		$target = $view->config( 'client/html/checkout/standard/url/target' );
542
543
		/** client/html/checkout/standard/url/controller
544
		 * Name of the controller whose action should be called
545
		 *
546
		 * In Model-View-Controller (MVC) applications, the controller contains the methods
547
		 * that create parts of the output displayed in the generated HTML page. Controller
548
		 * names are usually alpha-numeric.
549
		 *
550
		 * @param string Name of the controller
551
		 * @since 2014.03
552
		 * @category Developer
553
		 * @see client/html/checkout/standard/url/target
554
		 * @see client/html/checkout/standard/url/action
555
		 * @see client/html/checkout/standard/url/config
556
		 */
557
		$cntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
558
559
		/** client/html/checkout/standard/url/action
560
		 * Name of the action that should create the output
561
		 *
562
		 * In Model-View-Controller (MVC) applications, actions are the methods of a
563
		 * controller that create parts of the output displayed in the generated HTML page.
564
		 * Action names are usually alpha-numeric.
565
		 *
566
		 * @param string Name of the action
567
		 * @since 2014.03
568
		 * @category Developer
569
		 * @see client/html/checkout/standard/url/target
570
		 * @see client/html/checkout/standard/url/controller
571
		 * @see client/html/checkout/standard/url/config
572
		 */
573
		$action = $view->config( 'client/html/checkout/standard/url/action', 'index' );
574
575
		/** client/html/checkout/standard/url/config
576
		 * Associative list of configuration options used for generating the URL
577
		 *
578
		 * You can specify additional options as key/value pairs used when generating
579
		 * the URLs, like
580
		 *
581
		 *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
582
		 *
583
		 * The available key/value pairs depend on the application that embeds the e-commerce
584
		 * framework. This is because the infrastructure of the application is used for
585
		 * generating the URLs. The full list of available config options is referenced
586
		 * in the "see also" section of this page.
587
		 *
588
		 * @param string Associative list of configuration options
589
		 * @since 2014.03
590
		 * @category Developer
591
		 * @see client/html/checkout/standard/url/target
592
		 * @see client/html/checkout/standard/url/controller
593
		 * @see client/html/checkout/standard/url/action
594
		 * @see client/html/url/config
595
		 */
596
		$config = $view->config( 'client/html/checkout/standard/url/config', $config );
597
598
		return $view->url( $target, $cntl, $action, $params, [], $config );
599
	}
600
601
602
	/**
603
	 * Returns the URL to the update page.
604
	 *
605
	 * @param \Aimeos\MW\View\Iface $view View object
606
	 * @param array $params Parameters that should be part of the URL
607
	 * @param array $config Default URL configuration
608
	 * @return string URL string
609
	 */
610
	protected function getUrlUpdate( \Aimeos\MW\View\Iface $view, array $params, array $config ) : string
611
	{
612
		/** client/html/checkout/update/url/target
613
		 * Destination of the URL where the controller specified in the URL is known
614
		 *
615
		 * The destination can be a page ID like in a content management system or the
616
		 * module of a software development framework. This "target" must contain or know
617
		 * the controller that should be called by the generated URL.
618
		 *
619
		 * @param string Destination of the URL
620
		 * @since 2014.03
621
		 * @category Developer
622
		 * @see client/html/checkout/update/url/controller
623
		 * @see client/html/checkout/update/url/action
624
		 * @see client/html/checkout/update/url/config
625
		 */
626
		$target = $view->config( 'client/html/checkout/update/url/target' );
627
628
		/** client/html/checkout/update/url/controller
629
		 * Name of the controller whose action should be called
630
		 *
631
		 * In Model-View-Controller (MVC) applications, the controller contains the methods
632
		 * that create parts of the output displayed in the generated HTML page. Controller
633
		 * names are usually alpha-numeric.
634
		 *
635
		 * @param string Name of the controller
636
		 * @since 2014.03
637
		 * @category Developer
638
		 * @see client/html/checkout/update/url/target
639
		 * @see client/html/checkout/update/url/action
640
		 * @see client/html/checkout/update/url/config
641
		 */
642
		$cntl = $view->config( 'client/html/checkout/update/url/controller', 'checkout' );
643
644
		/** client/html/checkout/update/url/action
645
		 * Name of the action that should create the output
646
		 *
647
		 * In Model-View-Controller (MVC) applications, actions are the methods of a
648
		 * controller that create parts of the output displayed in the generated HTML page.
649
		 * Action names are usually alpha-numeric.
650
		 *
651
		 * @param string Name of the action
652
		 * @since 2014.03
653
		 * @category Developer
654
		 * @see client/html/checkout/update/url/target
655
		 * @see client/html/checkout/update/url/controller
656
		 * @see client/html/checkout/update/url/config
657
		 */
658
		$action = $view->config( 'client/html/checkout/update/url/action', 'update' );
659
660
		/** client/html/checkout/update/url/config
661
		 * Associative list of configuration options used for generating the URL
662
		 *
663
		 * You can specify additional options as key/value pairs used when generating
664
		 * the URLs, like
665
		 *
666
		 *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
667
		 *
668
		 * The available key/value pairs depend on the application that embeds the e-commerce
669
		 * framework. This is because the infrastructure of the application is used for
670
		 * generating the URLs. The full list of available config options is referenced
671
		 * in the "see also" section of this page.
672
		 *
673
		 * @param string Associative list of configuration options
674
		 * @since 2014.03
675
		 * @category Developer
676
		 * @see client/html/checkout/update/url/target
677
		 * @see client/html/checkout/update/url/controller
678
		 * @see client/html/checkout/update/url/action
679
		 * @see client/html/url/config
680
		 */
681
		$config = $view->config( 'client/html/checkout/update/url/config', $config );
682
683
		return $view->url( $target, $cntl, $action, $params, [], $config );
684
	}
685
686
687
	/**
688
	 * Tests if one of the products is a subscription
689
	 *
690
	 * @param \Aimeos\Map $products Ordered products implementing \Aimeos\MShop\Order\Item\Base\Product\Iface
691
	 * @return bool True if at least one product is a subscription, false if not
692
	 */
693
	protected function isSubscription( \Aimeos\Map $products ) : bool
694
	{
695
		foreach( $products as $orderProduct )
696
		{
697
			if( $orderProduct->getAttributeItem( 'interval', 'config' ) ) {
698
				return true;
699
			}
700
		}
701
702
		return false;
703
	}
704
705
706
	/**
707
	 * Sets the necessary parameter values in the view.
708
	 *
709
	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
710
	 * @param array &$tags Result array for the list of tags that are associated to the output
711
	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
712
	 * @return \Aimeos\MW\View\Iface Modified view object
713
	 */
714
	public function addData( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface
715
	{
716
		$view->standardUrlPayment = $this->getUrlSelf( $view, array( 'c_step' => 'payment' ), [] );
717
718
		return parent::addData( $view, $tags, $expire );
719
	}
720
}
721