Standard::getBody() - Code Metrics - Inspection of "removed un-used </div> (#110)" - aimeos/ai-client-html - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a974de...9ab29e )

by Aimeos

created 2021-03-09 14:45 UTC

Standard::getBody() 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\Summary;


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


/**
 * Default implementation of checkout summary HTML client.
 *
 * @package Client
 * @subpackage Html
 */
class Standard
	extends \Aimeos\Client\Html\Common\Client\Summary\Base
	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
{
	/** client/html/checkout/standard/summary/subparts
	 * List of HTML sub-clients rendered within the checkout standard summary 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/summary/subparts';
	private $subPartNames = [];


	/**
	 * 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 getBody( string $uid = '' ) : string
	{
		$view = $this->getView();
		$step = $view->get( 'standardStepActive' );
		$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );

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

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

		/** client/html/checkout/standard/summary/template-body
		 * Relative path to the HTML body template of the checkout standard summary 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/summary/template-header
		 */
		$tplconf = 'client/html/checkout/standard/summary/template-body';
		$default = 'checkout/standard/summary-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 getHeader( string $uid = '' ) : ?string
	{
		$view = $this->getView();
		$step = $view->get( 'standardStepActive' );
		$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );

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

		return parent::getHeader( $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/summary/decorators/excludes
		 * Excludes decorators added by the "common" option from the checkout standard summary 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/summary/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/summary/decorators/global
		 * @see client/html/checkout/standard/summary/decorators/local
		 */

		/** client/html/checkout/standard/summary/decorators/global
		 * Adds a list of globally available decorators only to the checkout standard summary 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/summary/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/summary/decorators/excludes
		 * @see client/html/checkout/standard/summary/decorators/local
		 */

		/** client/html/checkout/standard/summary/decorators/local
		 * Adds a list of local decorators only to the checkout standard summary 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/summary/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/summary/decorators/excludes
		 * @see client/html/checkout/standard/summary/decorators/global
		 */

		return $this->createSubClient( 'checkout/standard/summary/' . $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 process()
	{
		$result = true;
		$view = $this->getView();

		try
		{
			if( $view->param( 'cs_order', null ) === null ) {
				return $result;
			}


			$controller = \Aimeos\Controller\Frontend::create( $this->getContext(), 'basket' );
			$customerref = strip_tags( $view->param( 'cs_customerref', '', false ) );
			$comment = strip_tags( $view->param( 'cs_comment', '', false ) );

			if( $customerref || $comment )
			{
				$controller->get()->setCustomerReference( $customerref )->setComment( $comment );
				$controller->save();
			}


			// only start if there's something to do
			if( $view->param( 'cs_option_terms', null ) !== null
				&& ( $option = $view->param( 'cs_option_terms_value', 0 ) ) != 1

			) {
				$error = $view->translate( 'client', 'Please accept the terms and conditions' );
				$errors = $view->get( 'summaryErrorCodes', [] );
				$errors['option']['terms'] = $error;

				$view->summaryErrorCodes = $errors;
				$view->standardStepActive = 'summary';
				$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), array( $error ) );
			}


			parent::process();

			$controller->get()->check( \Aimeos\MShop\Order\Item\Base\Base::PARTS_ALL );
		}
		catch( \Exception $e )
		{
			$view->standardStepActive = 'summary';
			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->getContext()->getConfig()->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 addData( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface
	{
		$context = $this->getContext();

		$basket = $view->standardBasket;

		$view->summaryCostsDelivery = $this->getCostsDelivery( $basket );
		$view->summaryCostsPayment = $this->getCostsPayment( $basket );
		$view->summaryNamedTaxes = $this->getNamedTaxes( $basket );
		$view->summaryTaxRates = $this->getTaxRates( $basket );

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


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\Summary;
13
14
15			// Strings for translation
16			sprintf( 'summary' );
17
18
19			/**
20			* Default implementation of checkout summary HTML client.
21			*
22			* @package Client
23			* @subpackage Html
24			*/
25			class Standard
26			extends \Aimeos\Client\Html\Common\Client\Summary\Base
27			implements \Aimeos\Client\Html\Common\Client\Factory\Iface
28			{
29			/** client/html/checkout/standard/summary/subparts
30			* List of HTML sub-clients rendered within the checkout standard summary 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/summary/subparts';
63			private $subPartNames = [];
64
65
66			/**
67			* Returns the HTML code for insertion into the body.
68			*
69			* @param string $uid Unique identifier for the output if the content is placed more than once on the same page
70			* @return string HTML code
71			*/
72			public function getBody( string $uid = '' ) : string
73			{
74			$view = $this->getView();
75			$step = $view->get( 'standardStepActive' );
76			$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );
77
78			if( $step != 'summary' && !( in_array( 'summary', $onepage ) && in_array( $step, $onepage ) ) ) {
79			return '';
80			}
81
82			$html = '';
83			foreach( $this->getSubClients() as $subclient ) {
84			$html .= $subclient->setView( $view )->getBody( $uid );
85			}
86			$view->summaryBody = $html;
87
88			/** client/html/checkout/standard/summary/template-body
89			* Relative path to the HTML body template of the checkout standard summary client.
90			*
91			* The template file contains the HTML code and processing instructions
92			* to generate the result shown in the body of the frontend. The
93			* configuration string is the path to the template file relative
94			* to the templates directory (usually in client/html/templates).
95			*
96			* You can overwrite the template file configuration in extensions and
97			* provide alternative templates. These alternative templates should be
98			* named like the default one but with the string "standard" replaced by
99			* an unique name. You may use the name of your project for this. If
100			* you've implemented an alternative client class as well, "standard"
101			* should be replaced by the name of the new class.
102			*
103			* @param string Relative path to the template creating code for the HTML page body
104			* @since 2014.03
105			* @category Developer
106			* @see client/html/checkout/standard/summary/template-header
107			*/
108			$tplconf = 'client/html/checkout/standard/summary/template-body';
109			$default = 'checkout/standard/summary-body-standard';
110
111			return $view->render( $view->config( $tplconf, $default ) );
112			}
113
114
115			/**
116			* Returns the HTML string for insertion into the header.
117			*
118			* @param string $uid Unique identifier for the output if the content is placed more than once on the same page
119			* @return string\|null String including HTML tags for the header on error
120			*/
121			public function getHeader( string $uid = '' ) : ?string
122			{
123			$view = $this->getView();
124			$step = $view->get( 'standardStepActive' );
125			$onepage = $view->config( 'client/html/checkout/standard/onepage', [] );
126
127			if( $step != 'summary' && !( in_array( 'summary', $onepage ) && in_array( $step, $onepage ) ) ) {
128			return '';
129			}
130
131			return parent::getHeader( $uid );
132			}
133
134
135			/**
136			* Returns the sub-client given by its name.
137			*
138			* @param string $type Name of the client type
139			* @param string\|null $name Name of the sub-client (Default if null)
140			* @return \Aimeos\Client\Html\Iface Sub-client object
141			*/
142			public function getSubClient( string $type, string $name = null ) : \Aimeos\Client\Html\Iface
143			{
144			/** client/html/checkout/standard/summary/decorators/excludes
145			* Excludes decorators added by the "common" option from the checkout standard summary html client
146			*
147			* Decorators extend the functionality of a class by adding new aspects
148			* (e.g. log what is currently done), executing the methods of the underlying
149			* class only in certain conditions (e.g. only for logged in users) or
150			* modify what is returned to the caller.
151			*
152			* This option allows you to remove a decorator added via
153			* "client/html/common/decorators/default" before they are wrapped
154			* around the html client.
155			*
156			* client/html/checkout/standard/summary/decorators/excludes = array( 'decorator1' )
157			*
158			* This would remove the decorator named "decorator1" from the list of
159			* common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
160			* "client/html/common/decorators/default" to the html client.
161			*
162			* @param array List of decorator names
163			* @since 2015.08
164			* @category Developer
165			* @see client/html/common/decorators/default
166			* @see client/html/checkout/standard/summary/decorators/global
167			* @see client/html/checkout/standard/summary/decorators/local
168			*/
169
170			/** client/html/checkout/standard/summary/decorators/global
171			* Adds a list of globally available decorators only to the checkout standard summary html client
172			*
173			* Decorators extend the functionality of a class by adding new aspects
174			* (e.g. log what is currently done), executing the methods of the underlying
175			* class only in certain conditions (e.g. only for logged in users) or
176			* modify what is returned to the caller.
177			*
178			* This option allows you to wrap global decorators
179			* ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
180			*
181			* client/html/checkout/standard/summary/decorators/global = array( 'decorator1' )
182			*
183			* This would add the decorator named "decorator1" defined by
184			* "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
185			*
186			* @param array List of decorator names
187			* @since 2015.08
188			* @category Developer
189			* @see client/html/common/decorators/default
190			* @see client/html/checkout/standard/summary/decorators/excludes
191			* @see client/html/checkout/standard/summary/decorators/local
192			*/
193
194			/** client/html/checkout/standard/summary/decorators/local
195			* Adds a list of local decorators only to the checkout standard summary html client
196			*
197			* Decorators extend the functionality of a class by adding new aspects
198			* (e.g. log what is currently done), executing the methods of the underlying
199			* class only in certain conditions (e.g. only for logged in users) or
200			* modify what is returned to the caller.
201			*
202			* This option allows you to wrap local decorators
203			* ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
204			*
205			* client/html/checkout/standard/summary/decorators/local = array( 'decorator2' )
206			*
207			* This would add the decorator named "decorator2" defined by
208			* "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
209			*
210			* @param array List of decorator names
211			* @since 2015.08
212			* @category Developer
213			* @see client/html/common/decorators/default
214			* @see client/html/checkout/standard/summary/decorators/excludes
215			* @see client/html/checkout/standard/summary/decorators/global
216			*/
217
218			return $this->createSubClient( 'checkout/standard/summary/' . $type, $name );
219			}
220
221
222			/**
223			* Processes the input, e.g. store given values.
224			*
225			* A view must be available and this method doesn't generate any output
226			* besides setting view variables.
227			*/
228			public function process()
229			{
230			$result = true;
231			$view = $this->getView();
232
233			try
234			{
235			if( $view->param( 'cs_order', null ) === null ) {
236			return $result;
237			}
238
239
240			$controller = \Aimeos\Controller\Frontend::create( $this->getContext(), 'basket' );
241			$customerref = strip_tags( $view->param( 'cs_customerref', '', false ) );
242			$comment = strip_tags( $view->param( 'cs_comment', '', false ) );
243
244			if( $customerref \|\| $comment )
245			{
246			$controller->get()->setCustomerReference( $customerref )->setComment( $comment );
247			$controller->save();
248			}
249
250
251			// only start if there's something to do
252			if( $view->param( 'cs_option_terms', null ) !== null
253			&& ( $option = $view->param( 'cs_option_terms_value', 0 ) ) != 1
			0 ignored issues – show Unused Code introduced 2019-01-18 12:21 UTC by Report Bug Copy Issue Report The assignment to `$option` is dead and can be removed. Loading history...
254			) {
255			$error = $view->translate( 'client', 'Please accept the terms and conditions' );
256			$errors = $view->get( 'summaryErrorCodes', [] );
257			$errors['option']['terms'] = $error;
258
259			$view->summaryErrorCodes = $errors;
260			$view->standardStepActive = 'summary';
261			$view->standardErrorList = array_merge( $view->get( 'standardErrorList', [] ), array( $error ) );
262			}
263
264
265			parent::process();
266
267			$controller->get()->check( \Aimeos\MShop\Order\Item\Base\Base::PARTS_ALL );
268			}
269			catch( \Exception $e )
270			{
271			$view->standardStepActive = 'summary';
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->getContext()->getConfig()->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 addData( \Aimeos\MW\View\Iface $view, array &$tags = [], string &$expire = null ) : \Aimeos\MW\View\Iface
297			{
298			$context = $this->getContext();
			0 ignored issues – show Unused Code introduced 2019-12-10 11:20 UTC by Report Bug Copy Issue Report The assignment to `$context` is dead and can be removed. Loading history...
299			$basket = $view->standardBasket;
300
301			$view->summaryCostsDelivery = $this->getCostsDelivery( $basket );
302			$view->summaryCostsPayment = $this->getCostsPayment( $basket );
303			$view->summaryNamedTaxes = $this->getNamedTaxes( $basket );
304			$view->summaryTaxRates = $this->getTaxRates( $basket );
305
306			return parent::addData( $view, $tags, $expire );
307			}
308			}
309

aimeos / ai-client-html

Push — master ( a974de...9ab29e )

Standard::getBody() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like