Standard::body() - Code Metrics - Inspection of "Allow customizing checks for steps in checkout/sta..." - aimeos/ai-client-html - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b9e760...0cd60c )

by Aimeos

created 2021-12-11 12:00 UTC

Standard::body() A

↳ Parent: Standard

Complexity

Conditions	5
Paths	3

Size

Total Lines	40
Code Lines	12

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	12
nc	3
nop	1
dl	0
loc	40
rs	9.5555
c	0
b	0
f	0

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Metaways Infosystems GmbH, 2013
 * @copyright Aimeos (aimeos.org), 2015-2021
 * @package Client
 * @subpackage Html
 */


namespace Aimeos\Client\Html\Checkout\Standard\Address;


// Strings for translation
sprintf( 'address' );


/**
 * Default implementation of checkout address HTML client.
 *
 * @package Client
 * @subpackage Html
 */
class Standard
	extends \Aimeos\Client\Html\Common\Client\Factory\Base
	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
{
	/** client/html/checkout/standard/address/subparts
	 * List of HTML sub-clients rendered within the checkout standard address section
	 *
	 * The output of the frontend is composed of the code generated by the HTML
	 * clients. Each HTML client can consist of serveral (or none) sub-clients
	 * that are responsible for rendering certain sub-parts of the output. The
	 * sub-clients can contain HTML clients themselves and therefore a
	 * hierarchical tree of HTML clients is composed. Each HTML client creates
	 * the output that is placed inside the container of its parent.
	 *
	 * At first, always the HTML code generated by the parent is printed, then
	 * the HTML code of its sub-clients. The order of the HTML sub-clients
	 * determines the order of the output of these sub-clients inside the parent
	 * container. If the configured list of clients is
	 *
	 *  array( "subclient1", "subclient2" )
	 *
	 * you can easily change the order of the output by reordering the subparts:
	 *
	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
	 *
	 * You can also remove one or more parts if they shouldn't be rendered:
	 *
	 *  client/html/<clients>/subparts = array( "subclient1" )
	 *
	 * As the clients only generates structural HTML, the layout defined via CSS
	 * should support adding, removing or reordering content by a fluid like
	 * design.
	 *
	 * @param array List of sub-client names
	 * @since 2014.03
	 * @category Developer
	 */
	private $subPartPath = 'client/html/checkout/standard/address/subparts';

	/** client/html/checkout/standard/address/billing/name
	 * Name of the billing part used by the checkout standard address client implementation
	 *
	 * Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Billing\Myname".
	 * The name is case-sensitive and you should avoid camel case names like "MyName".
	 *
	 * @param string Last part of the client class name
	 * @since 2014.03
	 * @category Developer
	 */

	/** client/html/checkout/standard/address/delivery/name
	 * Name of the delivery part used by the checkout standard address client implementation
	 *
	 * Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Delivery\Myname".
	 * The name is case-sensitive and you should avoid camel case names like "MyName".
	 *
	 * @param string Last part of the client class name
	 * @since 2014.03
	 * @category Developer
	 */
	private $subPartNames = array( 'billing', 'delivery' );


	/**
	 * Returns the HTML code for insertion into the body.
	 *
	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
	 * @return string HTML code
	 */
	public function body( string $uid = '' ) : string
	{
		$view = $this->view();
		$step = $view->get( 'standardStepActive', 'address' );
		$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );

		if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
			return '';
		}

		$html = '';
		foreach( $this->getSubClients() as $subclient ) {
			$html .= $subclient->setView( $view )->body( $uid );
		}
		$view->addressBody = $html;

		/** client/html/checkout/standard/address/template-body
		 * Relative path to the HTML body template of the checkout standard address client.
		 *
		 * The template file contains the HTML code and processing instructions
		 * to generate the result shown in the body of the frontend. The
		 * configuration string is the path to the template file relative
		 * to the templates directory (usually in client/html/templates).
		 *
		 * You can overwrite the template file configuration in extensions and
		 * provide alternative templates. These alternative templates should be
		 * named like the default one but with the string "standard" replaced by
		 * an unique name. You may use the name of your project for this. If
		 * you've implemented an alternative client class as well, "standard"
		 * should be replaced by the name of the new class.
		 *
		 * @param string Relative path to the template creating code for the HTML page body
		 * @since 2014.03
		 * @category Developer
		 * @see client/html/checkout/standard/address/template-header
		 */
		$tplconf = 'client/html/checkout/standard/address/template-body';
		$default = 'checkout/standard/address-body-standard';

		return $view->render( $view->config( $tplconf, $default ) );
	}


	/**
	 * Returns the HTML string for insertion into the header.
	 *
	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
	 * @return string|null String including HTML tags for the header on error
	 */
	public function header( string $uid = '' ) : ?string
	{
		$view = $this->view();
		$step = $view->get( 'standardStepActive' );
		$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );

		if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
			return '';
		}

		return parent::header( $uid );
	}


	/**
	 * Returns the sub-client given by its name.
	 *
	 * @param string $type Name of the client type
	 * @param string|null $name Name of the sub-client (Default if null)
	 * @return \Aimeos\Client\Html\Iface Sub-client object
	 */
	public function getSubClient( string $type, string $name = null ) : \Aimeos\Client\Html\Iface
	{
		/** client/html/checkout/standard/address/decorators/excludes
		 * Excludes decorators added by the "common" option from the checkout standard address html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to remove a decorator added via
		 * "client/html/common/decorators/default" before they are wrapped
		 * around the html client.
		 *
		 *  client/html/checkout/standard/address/decorators/excludes = array( 'decorator1' )
		 *
		 * This would remove the decorator named "decorator1" from the list of
		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
		 * "client/html/common/decorators/default" to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2015.08
		 * @category Developer
		 * @see client/html/common/decorators/default
		 * @see client/html/checkout/standard/address/decorators/global
		 * @see client/html/checkout/standard/address/decorators/local
		 */

		/** client/html/checkout/standard/address/decorators/global
		 * Adds a list of globally available decorators only to the checkout standard address html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to wrap global decorators
		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
		 *
		 *  client/html/checkout/standard/address/decorators/global = array( 'decorator1' )
		 *
		 * This would add the decorator named "decorator1" defined by
		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2015.08
		 * @category Developer
		 * @see client/html/common/decorators/default
		 * @see client/html/checkout/standard/address/decorators/excludes
		 * @see client/html/checkout/standard/address/decorators/local
		 */

		/** client/html/checkout/standard/address/decorators/local
		 * Adds a list of local decorators only to the checkout standard address html client
		 *
		 * Decorators extend the functionality of a class by adding new aspects
		 * (e.g. log what is currently done), executing the methods of the underlying
		 * class only in certain conditions (e.g. only for logged in users) or
		 * modify what is returned to the caller.
		 *
		 * This option allows you to wrap local decorators
		 * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
		 *
		 *  client/html/checkout/standard/address/decorators/local = array( 'decorator2' )
		 *
		 * This would add the decorator named "decorator2" defined by
		 * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
		 *
		 * @param array List of decorator names
		 * @since 2015.08
		 * @category Developer
		 * @see client/html/common/decorators/default
		 * @see client/html/checkout/standard/address/decorators/excludes
		 * @see client/html/checkout/standard/address/decorators/global
		 */

		return $this->createSubClient( 'checkout/standard/address/' . $type, $name );
	}


	/**
	 * Processes the input, e.g. store given values.
	 *
	 * A view must be available and this method doesn't generate any output
	 * besides setting view variables.
	 */
	public function init()
	{
		$view = $this->view();
		$context = $this->context();

		try
		{
			parent::init();

			if( ( $param = $view->param( 'ca_extra' ) ) !== null ) {
				$context->getSession()->set( 'client/html/checkout/standard/address/extra', (array) $param );
			}

			if( !isset( $view->standardStepActive )
				&& !$this->call( 'isAvailable', \Aimeos\Controller\Frontend::create( $context, 'basket' )->get() )
			) {
				$view->standardStepActive = 'address';
			}
		}
		catch( \Exception $e )
		{
			$view->standardStepActive = 'address';
			throw $e;
		}
	}


	/**
	 * Returns the list of sub-client names configured for the client.
	 *
	 * @return array List of HTML client names
	 */
	protected function getSubClientNames() : array
	{
		return $this->context()->config()->get( $this->subPartPath, $this->subPartNames );
	}


	/**
	 * Sets the necessary parameter values in the view.
	 *
	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
	 * @param array &$tags Result array for the list of tags that are associated to the output
	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
	 * @return \Aimeos\MW\View\Iface Modified view object
	 */
	public function data( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface
	{
		$context = $this->context();
		$localeManager = \Aimeos\MShop::create( $context, 'locale' );
		$controller = \Aimeos\Controller\Frontend::create( $context, 'customer' );
		$orderAddressManager = \Aimeos\MShop::create( $context, 'order/base/address' );

		$deliveryAddressItems = [];
		$item = $controller->uses( ['customer/address'] )->get();
		$paymentAddressItem = $orderAddressManager->create()->copyFrom( $item->getPaymentAddress() );

		foreach( $item->getAddressItems() as $pos => $addrItem ) {
			$deliveryAddressItems[$pos] = $orderAddressManager->create()->copyFrom( $addrItem );
		}

		$view->addressCustomerItem = $item;
		$view->addressPaymentItem = $paymentAddressItem;
		$view->addressDeliveryItems = $deliveryAddressItems;
		$view->addressLanguages = $localeManager->search( $localeManager->filter( true ) )
			->col( 'locale.languageid', 'locale.languageid' );

		/** common/countries
		 * List of available country codes for frontend and backend
		 *
		 * This configration option is used whenever a list of countries is
		 * shown in the frontend or backend. It's used e.g.
		 * if the customer should select the country he is living in the
		 * checkout process. In case that the list is empty, no country
		 * selection is shown.
		 *
		 * Each list entry must be a two letter ISO country code that is then
		 * translated into its name. The codes have to be upper case
		 * characters like "DE" for Germany or "GB" for Great Britain, e.g.
		 *
		 *  array( 'DE', 'GB', ... )
		 *
		 * @param array List of two letter ISO country codes
		 * @since 2021.10
		 */
		$default = $view->config( 'common/countries', [] );
		/** @deprecated 2022.01 Use common/countries */
		$view->addressCountries = map( $view->config( 'client/html/checkout/standard/address/countries', $default ) )
			->flip()->map( function( $v, $key ) use ( $view ) {
				return $view->translate( 'country', $key );
			} )->asort();

		/** common/states
		 * List of available states for frontend and backend
		 *
		 * This configration option is used whenever a list of states is
		 * shown in the frontend or bakcend. It's used e.g.
		 * if the customer should select the state he is living in the
		 * checkout process. In case that the list is empty, no state
		 * selection is shown.
		 *
		 * A two letter ISO country code must be the key for the list of
		 * states that belong to this country. The list of states must then
		 * contain the state code as key and its name as values, e.g.
		 *
		 *  array(
		 *      'US' => array(
		 *          'CA' => 'California',
		 *          'NY' => 'New York',
		 *          ...
		 *      ),
		 *      ...
		 *  );
		 *
		 * The codes have to be upper case characters like "US" for the
		 * United States or "DE" for Germany. The order of the country and
		 * state codes determine the order of the states in the frontend and
		 * the state codes are later used for per state tax calculation.
		 *
		 * @param array Multi-dimensional list ISO country codes and state codes/names
		 * @since 2020.10
		 */
		$default = $view->config( 'common/states', [] );
		/** @deprecated 2022.01 Use common/states */
		$view->addressStates = $view->config( 'client/html/checkout/standard/address/states', $default );

		$view->addressExtra = $context->getSession()->get( 'client/html/checkout/standard/address/extra', [] );

		return parent::data( $view, $tags, $expire );
	}


	/**
	 * Tests if an item is available and the step can be skipped
	 *
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
	 * @return bool TRUE if step can be skipped, FALSE if not
	 */
	protected function isAvailable( \Aimeos\MShop\Order\Item\Base\Iface $basket ) : bool
	{
		return !empty( $basket->getAddress( 'payment' ) );
	}
}


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 body( string $uid = '' ) : string
95			{
96			$view = $this->view();
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 )->body( $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 header( string $uid = '' ) : ?string
144			{
145			$view = $this->view();
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::header( $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 init()
251			{
252			$view = $this->view();
253			$context = $this->context();
254
255			try
256			{
257			parent::init();
258
259			if( ( $param = $view->param( 'ca_extra' ) ) !== null ) {
260			$context->getSession()->set( 'client/html/checkout/standard/address/extra', (array) $param );
261			}
262
263			if( !isset( $view->standardStepActive )
264			&& !$this->call( 'isAvailable', \Aimeos\Controller\Frontend::create( $context, 'basket' )->get() )
265			) {
266			$view->standardStepActive = 'address';
267			}
268			}
269			catch( \Exception $e )
270			{
271			$view->standardStepActive = 'address';
272			throw $e;
273			}
274			}
275
276
277			/**
278			* Returns the list of sub-client names configured for the client.
279			*
280			* @return array List of HTML client names
281			*/
282			protected function getSubClientNames() : array
283			{
284			return $this->context()->config()->get( $this->subPartPath, $this->subPartNames );
285			}
286
287
288			/**
289			* Sets the necessary parameter values in the view.
290			*
291			* @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
292			* @param array &$tags Result array for the list of tags that are associated to the output
293			* @param string\|null &$expire Result variable for the expiration date of the output (null for no expiry)
294			* @return \Aimeos\MW\View\Iface Modified view object
295			*/
296			public function data( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface
297			{
298			$context = $this->context();
299			$localeManager = \Aimeos\MShop::create( $context, 'locale' );
300			$controller = \Aimeos\Controller\Frontend::create( $context, 'customer' );
301			$orderAddressManager = \Aimeos\MShop::create( $context, 'order/base/address' );
302
303			$deliveryAddressItems = [];
304			$item = $controller->uses( ['customer/address'] )->get();
305			$paymentAddressItem = $orderAddressManager->create()->copyFrom( $item->getPaymentAddress() );
306
307			foreach( $item->getAddressItems() as $pos => $addrItem ) {
308			$deliveryAddressItems[$pos] = $orderAddressManager->create()->copyFrom( $addrItem );
309			}
310
311			$view->addressCustomerItem = $item;
312			$view->addressPaymentItem = $paymentAddressItem;
313			$view->addressDeliveryItems = $deliveryAddressItems;
314			$view->addressLanguages = $localeManager->search( $localeManager->filter( true ) )
315			->col( 'locale.languageid', 'locale.languageid' );
316
317			/** common/countries
318			* List of available country codes for frontend and backend
319			*
320			* This configration option is used whenever a list of countries is
321			* shown in the frontend or backend. It's used e.g.
322			* if the customer should select the country he is living in the
323			* checkout process. In case that the list is empty, no country
324			* selection is shown.
325			*
326			* Each list entry must be a two letter ISO country code that is then
327			* translated into its name. The codes have to be upper case
328			* characters like "DE" for Germany or "GB" for Great Britain, e.g.
329			*
330			* array( 'DE', 'GB', ... )
331			*
332			* @param array List of two letter ISO country codes
333			* @since 2021.10
334			*/
335			$default = $view->config( 'common/countries', [] );
336			/** @deprecated 2022.01 Use common/countries */
337			$view->addressCountries = map( $view->config( 'client/html/checkout/standard/address/countries', $default ) )
338			->flip()->map( function( $v, $key ) use ( $view ) {
339			return $view->translate( 'country', $key );
340			} )->asort();
341
342			/** common/states
343			* List of available states for frontend and backend
344			*
345			* This configration option is used whenever a list of states is
346			* shown in the frontend or bakcend. It's used e.g.
347			* if the customer should select the state he is living in the
348			* checkout process. In case that the list is empty, no state
349			* selection is shown.
350			*
351			* A two letter ISO country code must be the key for the list of
352			* states that belong to this country. The list of states must then
353			* contain the state code as key and its name as values, e.g.
354			*
355			* array(
356			* 'US' => array(
357			* 'CA' => 'California',
358			* 'NY' => 'New York',
359			* ...
360			* ),
361			* ...
362			* );
363			*
364			* The codes have to be upper case characters like "US" for the
365			* United States or "DE" for Germany. The order of the country and
366			* state codes determine the order of the states in the frontend and
367			* the state codes are later used for per state tax calculation.
368			*
369			* @param array Multi-dimensional list ISO country codes and state codes/names
370			* @since 2020.10
371			*/
372			$default = $view->config( 'common/states', [] );
373			/** @deprecated 2022.01 Use common/states */
374			$view->addressStates = $view->config( 'client/html/checkout/standard/address/states', $default );
375
376			$view->addressExtra = $context->getSession()->get( 'client/html/checkout/standard/address/extra', [] );
377
378			return parent::data( $view, $tags, $expire );
379			}
380
381
382			/**
383			* Tests if an item is available and the step can be skipped
384			*
385			* @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
386			* @return bool TRUE if step can be skipped, FALSE if not
387			*/
388			protected function isAvailable( \Aimeos\MShop\Order\Item\Base\Iface $basket ) : bool
389			{
390			return !empty( $basket->getAddress( 'payment' ) );
391			}
392			}
393

aimeos / ai-client-html

Push — master ( b9e760...0cd60c )

Standard::body() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like