aimeos / ai-client-html

client/html/src/Client/Html/Checkout/Standard/Standard.php

Indentation +593 added lines, -593 removed lines

@@ -19,598 +19,598 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/checkout/standard/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout standard 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/standard/subparts';
-
-	/** client/html/checkout/standard/address/name
-	 * Name of the address part used by the checkout standard client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Address\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/delivery/name
-	 * Name of the delivery part used by the checkout standard client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\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
-	 */
-
-	/** client/html/checkout/standard/payment/name
-	 * Name of the payment part used by the checkout standard client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Payment\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/summary/name
-	 * Name of the summary part used by the checkout standard client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Summary\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/order/name
-	 * Name of the order part used by the checkout standard client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Order\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/process/name
-	 * Name of the process part used by the checkout standard client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Process\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 2015.07
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'address', 'delivery', 'payment', 'summary', 'order', 'process' );
-	private $cache;
-
-
-	/**
-	 * 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
-	 * @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 string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
-
-		try
-		{
-			$view = $this->setViewParams( $view, $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->standardBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-
-		/** client/html/checkout/standard/standard/template-body
-		 * Relative path to the HTML body template of the checkout standard 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/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/standard/standard/template-body';
-		$default = 'checkout/standard/body-default.php';
-
-		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
-	 * @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 string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		try
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->standardHeader = $html;
-
-			/** client/html/checkout/standard/standard/template-header
-			 * Relative path to the HTML header template of the checkout standard client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the HTML code that is inserted into the HTML page header
-			 * of the rendered page in 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 head
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/checkout/standard/standard/template-body
-			 */
-			$tplconf = 'client/html/checkout/standard/standard/template-header';
-			$default = 'checkout/standard/header-default.php';
-
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
-
-
-	/**
-	 * 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( $type, $name = null )
-	{
-		/** client/html/checkout/standard/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout standard 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/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 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/standard/decorators/global
-		 * @see client/html/checkout/standard/decorators/local
-		 */
-
-		/** client/html/checkout/standard/decorators/global
-		 * Adds a list of globally available decorators only to the checkout standard 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/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 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/standard/decorators/excludes
-		 * @see client/html/checkout/standard/decorators/local
-		 */
-
-		/** client/html/checkout/standard/decorators/local
-		 * Adds a list of local decorators only to the checkout standard 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/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 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/standard/decorators/excludes
-		 * @see client/html/checkout/standard/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/standard/' . $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()
-	{
-		$view = $this->getView();
-		$context = $this->getContext();
-
-		try
-		{
-			parent::process();
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
-		{
-			$errors = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$errors = array_merge( $errors, $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
-
-			$view->summaryErrorCodes = $e->getErrorCodes();
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $errors;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
-		}
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		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
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$context = $this->getContext();
-
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-			$view->standardBasket = $basketCntl->get();
-
-
-			/** client/html/checkout/standard/url/step-active
-			 * Name of the checkout process step to jump to if no previous step requires attention
-			 *
-			 * The checkout process consists of several steps which are usually
-			 * displayed one by another to the customer. If the data of a step
-			 * is already available, then that step is skipped. The active step
-			 * is the one that is displayed if all other steps are skipped.
-			 *
-			 * If one of the previous steps misses some data the customer has
-			 * to enter, then this step is displayed first. After providing
-			 * the missing data, the whole series of steps are tested again
-			 * and if no other step requests attention, the configured active
-			 * step will be displayed.
-			 *
-			 * The order of the steps is determined by the order of sub-parts
-			 * that are configured for the checkout client.
-			 *
-			 * @param string Name of the confirm standard HTML client
-			 * @since 2014.07
-			 * @category Developer
-			 * @category User
-			 * @see client/html/checkout/standard/standard/subparts
-			 */
-			$default = $view->config( 'client/html/checkout/standard/url/step-active', 'summary' );
-
-			/** client/html/checkout/standard/onepage
-			 * Shows all named checkout subparts at once for a one page checkout
-			 *
-			 * Normally, the checkout process is divided into several steps for entering
-			 * addresses, select delivery and payment options as well as showing the
-			 * summary page. This enables dependencies between two steps like showing
-			 * delivery options based on the address entered by the customer. Furthermore,
-			 * this is good way to limit the amount of information displayed which is
-			 * preferred by mobile users.
-			 *
-			 * Contrary to that, a one page checkout displays all information on only
-			 * one page and customers get an immediate overview of which information
-			 * they have to enter and what options they can select from. This is an
-			 * advantage if only a very limited amount of information must be entered
-			 * or if there are almost no options to choose from and no dependencies
-			 * between exist.
-			 *
-			 * Using this config options, shop developers are able to define which
-			 * checkout subparts are combined to a one page view. Simply add the names
-			 * of all checkout subparts to the list. Available checkout subparts for
-			 * a one page checkout are:
-			 * * address
-			 * * delivery
-			 * * payment
-			 * * summary
-			 *
-			 * @param array List of checkout subparts name
-			 * @since 2015.05
-			 * @category Developer
-			 */
-			$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
-			$onestep = array_shift( $onepage ); // keep the first one page step
-
-			$steps = (array) $context->getConfig()->get( $this->subPartPath, $this->subPartNames );
-			$steps = array_diff( $steps, $onepage ); // remove all remaining steps in $onepage
-
-			// use first step if default step isn't available
-			$default = ( !in_array( $default, $steps ) ? reset( $steps ) : $default );
-
-			$current = $view->param( 'c_step', $default );
-			// use $onestep if current step isn't available due to one page layout
-			$current = ( !in_array( $current, $steps ) ? $onestep : $current );
-
-			$cpos = $cpos = array_search( $current, $steps );
-
-			if( !isset( $view->standardStepActive )
-				|| ( ( $apos = array_search( $view->standardStepActive, $steps ) ) !== false
-				&& $cpos !== false && $cpos < $apos )
-			) {
-				$view->standardStepActive = $current;
-			}
-
-			$view->standardSteps = $steps;
-
-
-			$this->cache = $this->addNavigationUrls( $view, $steps, $view->standardStepActive );
-		}
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Adds the "back" and "next" URLs to the view
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @param array $steps List of checkout step names
-	 * @param unknown $activeStep Name of the active step
-	 * @return \Aimeos\MW\View\Iface Enhanced view object
-	 * @since 2016.05
-	 */
-	protected function addNavigationUrls( \Aimeos\MW\View\Iface $view, array $steps, $activeStep )
-	{
-		/** client/html/checkout/standard/url/target
-		 * Destination of the URL where the controller specified in the URL is known
-		 *
-		 * The destination can be a page ID like in a content management system or the
-		 * module of a software development framework. This "target" must contain or know
-		 * the controller that should be called by the generated URL.
-		 *
-		 * @param string Destination of the URL
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/standard/url/controller
-		 * @see client/html/checkout/standard/url/action
-		 * @see client/html/checkout/standard/url/config
-		 */
-		$cTarget = $view->config( 'client/html/checkout/standard/url/target' );
-
-		/** client/html/checkout/standard/url/controller
-		 * Name of the controller whose action should be called
-		 *
-		 * In Model-View-Controller (MVC) applications, the controller contains the methods
-		 * that create parts of the output displayed in the generated HTML page. Controller
-		 * names are usually alpha-numeric.
-		 *
-		 * @param string Name of the controller
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/standard/url/target
-		 * @see client/html/checkout/standard/url/action
-		 * @see client/html/checkout/standard/url/config
-		*/
-		$cCntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
-
-		/** client/html/checkout/standard/url/action
-		 * Name of the action that should create the output
-		 *
-		 * In Model-View-Controller (MVC) applications, actions are the methods of a
-		 * controller that create parts of the output displayed in the generated HTML page.
-		 * Action names are usually alpha-numeric.
-		 *
-		 * @param string Name of the action
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/standard/url/target
-		 * @see client/html/checkout/standard/url/controller
-		 * @see client/html/checkout/standard/url/config
-		*/
-		$cAction = $view->config( 'client/html/checkout/standard/url/action', 'index' );
-
-		/** client/html/checkout/standard/url/config
-		 * Associative list of configuration options used for generating the URL
-		 *
-		 * You can specify additional options as key/value pairs used when generating
-		 * the URLs, like
-		 *
-		 *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
-		 *
-		 * The available key/value pairs depend on the application that embeds the e-commerce
-		 * framework. This is because the infrastructure of the application is used for
-		 * generating the URLs. The full list of available config options is referenced
-		 * in the "see also" section of this page.
-		 *
-		 * @param string Associative list of configuration options
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/standard/url/target
-		 * @see client/html/checkout/standard/url/controller
-		 * @see client/html/checkout/standard/url/action
-		 * @see client/html/url/config
-		*/
-		$cConfig = $view->config( 'client/html/checkout/standard/url/config', array() );
-
-
-		$bTarget = $view->config( 'client/html/basket/standard/url/target' );
-		$bCntl = $view->config( 'client/html/basket/standard/url/controller', 'basket' );
-		$bAction = $view->config( 'client/html/basket/standard/url/action', 'index' );
-		$bConfig = $view->config( 'client/html/basket/standard/url/config', array() );
-
-
-		$step = null;
-		do {
-			$lastStep = $step;
-		}
-		while( ( $step = array_shift( $steps ) ) !== null && $step !== $activeStep );
-
-
-		if( $lastStep !== null ) {
-			$param = array( 'c_step' => $lastStep );
-			$view->standardUrlBack = $view->url( $cTarget, $cCntl, $cAction, $param, array(), $cConfig );
-		} else {
-			$view->standardUrlBack = $view->url( $bTarget, $bCntl, $bAction, array(), array(), $bConfig );
-		}
-
-		if( !isset( $view->standardUrlNext ) && ( $nextStep = array_shift( $steps ) ) !== null ) {
-			$param = array( 'c_step' => $nextStep );
-			$view->standardUrlNext = $view->url( $cTarget, $cCntl, $cAction, $param, array(), $cConfig );
-		}
-		// don't overwrite $view->standardUrlNext so order step URL is used
-
-		return $view;
-	}
+    /** client/html/checkout/standard/standard/subparts
+     * List of HTML sub-clients rendered within the checkout standard 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/standard/subparts';
+
+    /** client/html/checkout/standard/address/name
+     * Name of the address part used by the checkout standard client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Address\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/delivery/name
+     * Name of the delivery part used by the checkout standard client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\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
+     */
+
+    /** client/html/checkout/standard/payment/name
+     * Name of the payment part used by the checkout standard client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Payment\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/summary/name
+     * Name of the summary part used by the checkout standard client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Summary\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/order/name
+     * Name of the order part used by the checkout standard client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Order\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/process/name
+     * Name of the process part used by the checkout standard client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Standard\Process\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 2015.07
+     * @category Developer
+     */
+    private $subPartNames = array( 'address', 'delivery', 'payment', 'summary', 'order', 'process' );
+    private $cache;
+
+
+    /**
+     * 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
+     * @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 string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
+
+        try
+        {
+            $view = $this->setViewParams( $view, $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->standardBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+        catch( \Exception $e )
+        {
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+
+        /** client/html/checkout/standard/standard/template-body
+         * Relative path to the HTML body template of the checkout standard 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/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/standard/standard/template-body';
+        $default = 'checkout/standard/body-default.php';
+
+        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
+     * @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 string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->standardHeader = $html;
+
+            /** client/html/checkout/standard/standard/template-header
+             * Relative path to the HTML header template of the checkout standard client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the HTML code that is inserted into the HTML page header
+             * of the rendered page in 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 head
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/checkout/standard/standard/template-body
+             */
+            $tplconf = 'client/html/checkout/standard/standard/template-header';
+            $default = 'checkout/standard/header-default.php';
+
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
+
+
+    /**
+     * 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( $type, $name = null )
+    {
+        /** client/html/checkout/standard/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout standard 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/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 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/standard/decorators/global
+         * @see client/html/checkout/standard/decorators/local
+         */
+
+        /** client/html/checkout/standard/decorators/global
+         * Adds a list of globally available decorators only to the checkout standard 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/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 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/standard/decorators/excludes
+         * @see client/html/checkout/standard/decorators/local
+         */
+
+        /** client/html/checkout/standard/decorators/local
+         * Adds a list of local decorators only to the checkout standard 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/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 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/standard/decorators/excludes
+         * @see client/html/checkout/standard/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/standard/' . $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()
+    {
+        $view = $this->getView();
+        $context = $this->getContext();
+
+        try
+        {
+            parent::process();
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+        {
+            $errors = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $errors = array_merge( $errors, $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
+
+            $view->summaryErrorCodes = $e->getErrorCodes();
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $errors;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+        catch( \Exception $e )
+        {
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+        }
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        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
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $context = $this->getContext();
+
+            $basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+            $view->standardBasket = $basketCntl->get();
+
+
+            /** client/html/checkout/standard/url/step-active
+             * Name of the checkout process step to jump to if no previous step requires attention
+             *
+             * The checkout process consists of several steps which are usually
+             * displayed one by another to the customer. If the data of a step
+             * is already available, then that step is skipped. The active step
+             * is the one that is displayed if all other steps are skipped.
+             *
+             * If one of the previous steps misses some data the customer has
+             * to enter, then this step is displayed first. After providing
+             * the missing data, the whole series of steps are tested again
+             * and if no other step requests attention, the configured active
+             * step will be displayed.
+             *
+             * The order of the steps is determined by the order of sub-parts
+             * that are configured for the checkout client.
+             *
+             * @param string Name of the confirm standard HTML client
+             * @since 2014.07
+             * @category Developer
+             * @category User
+             * @see client/html/checkout/standard/standard/subparts
+             */
+            $default = $view->config( 'client/html/checkout/standard/url/step-active', 'summary' );
+
+            /** client/html/checkout/standard/onepage
+             * Shows all named checkout subparts at once for a one page checkout
+             *
+             * Normally, the checkout process is divided into several steps for entering
+             * addresses, select delivery and payment options as well as showing the
+             * summary page. This enables dependencies between two steps like showing
+             * delivery options based on the address entered by the customer. Furthermore,
+             * this is good way to limit the amount of information displayed which is
+             * preferred by mobile users.
+             *
+             * Contrary to that, a one page checkout displays all information on only
+             * one page and customers get an immediate overview of which information
+             * they have to enter and what options they can select from. This is an
+             * advantage if only a very limited amount of information must be entered
+             * or if there are almost no options to choose from and no dependencies
+             * between exist.
+             *
+             * Using this config options, shop developers are able to define which
+             * checkout subparts are combined to a one page view. Simply add the names
+             * of all checkout subparts to the list. Available checkout subparts for
+             * a one page checkout are:
+             * * address
+             * * delivery
+             * * payment
+             * * summary
+             *
+             * @param array List of checkout subparts name
+             * @since 2015.05
+             * @category Developer
+             */
+            $onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+            $onestep = array_shift( $onepage ); // keep the first one page step
+
+            $steps = (array) $context->getConfig()->get( $this->subPartPath, $this->subPartNames );
+            $steps = array_diff( $steps, $onepage ); // remove all remaining steps in $onepage
+
+            // use first step if default step isn't available
+            $default = ( !in_array( $default, $steps ) ? reset( $steps ) : $default );
+
+            $current = $view->param( 'c_step', $default );
+            // use $onestep if current step isn't available due to one page layout
+            $current = ( !in_array( $current, $steps ) ? $onestep : $current );
+
+            $cpos = $cpos = array_search( $current, $steps );
+
+            if( !isset( $view->standardStepActive )
+                || ( ( $apos = array_search( $view->standardStepActive, $steps ) ) !== false
+                && $cpos !== false && $cpos < $apos )
+            ) {
+                $view->standardStepActive = $current;
+            }
+
+            $view->standardSteps = $steps;
+
+
+            $this->cache = $this->addNavigationUrls( $view, $steps, $view->standardStepActive );
+        }
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Adds the "back" and "next" URLs to the view
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @param array $steps List of checkout step names
+     * @param unknown $activeStep Name of the active step
+     * @return \Aimeos\MW\View\Iface Enhanced view object
+     * @since 2016.05
+     */
+    protected function addNavigationUrls( \Aimeos\MW\View\Iface $view, array $steps, $activeStep )
+    {
+        /** client/html/checkout/standard/url/target
+         * Destination of the URL where the controller specified in the URL is known
+         *
+         * The destination can be a page ID like in a content management system or the
+         * module of a software development framework. This "target" must contain or know
+         * the controller that should be called by the generated URL.
+         *
+         * @param string Destination of the URL
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/standard/url/controller
+         * @see client/html/checkout/standard/url/action
+         * @see client/html/checkout/standard/url/config
+         */
+        $cTarget = $view->config( 'client/html/checkout/standard/url/target' );
+
+        /** client/html/checkout/standard/url/controller
+         * Name of the controller whose action should be called
+         *
+         * In Model-View-Controller (MVC) applications, the controller contains the methods
+         * that create parts of the output displayed in the generated HTML page. Controller
+         * names are usually alpha-numeric.
+         *
+         * @param string Name of the controller
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/standard/url/target
+         * @see client/html/checkout/standard/url/action
+         * @see client/html/checkout/standard/url/config
+         */
+        $cCntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
+
+        /** client/html/checkout/standard/url/action
+         * Name of the action that should create the output
+         *
+         * In Model-View-Controller (MVC) applications, actions are the methods of a
+         * controller that create parts of the output displayed in the generated HTML page.
+         * Action names are usually alpha-numeric.
+         *
+         * @param string Name of the action
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/standard/url/target
+         * @see client/html/checkout/standard/url/controller
+         * @see client/html/checkout/standard/url/config
+         */
+        $cAction = $view->config( 'client/html/checkout/standard/url/action', 'index' );
+
+        /** client/html/checkout/standard/url/config
+         * Associative list of configuration options used for generating the URL
+         *
+         * You can specify additional options as key/value pairs used when generating
+         * the URLs, like
+         *
+         *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
+         *
+         * The available key/value pairs depend on the application that embeds the e-commerce
+         * framework. This is because the infrastructure of the application is used for
+         * generating the URLs. The full list of available config options is referenced
+         * in the "see also" section of this page.
+         *
+         * @param string Associative list of configuration options
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/standard/url/target
+         * @see client/html/checkout/standard/url/controller
+         * @see client/html/checkout/standard/url/action
+         * @see client/html/url/config
+         */
+        $cConfig = $view->config( 'client/html/checkout/standard/url/config', array() );
+
+
+        $bTarget = $view->config( 'client/html/basket/standard/url/target' );
+        $bCntl = $view->config( 'client/html/basket/standard/url/controller', 'basket' );
+        $bAction = $view->config( 'client/html/basket/standard/url/action', 'index' );
+        $bConfig = $view->config( 'client/html/basket/standard/url/config', array() );
+
+
+        $step = null;
+        do {
+            $lastStep = $step;
+        }
+        while( ( $step = array_shift( $steps ) ) !== null && $step !== $activeStep );
+
+
+        if( $lastStep !== null ) {
+            $param = array( 'c_step' => $lastStep );
+            $view->standardUrlBack = $view->url( $cTarget, $cCntl, $cAction, $param, array(), $cConfig );
+        } else {
+            $view->standardUrlBack = $view->url( $bTarget, $bCntl, $bAction, array(), array(), $bConfig );
+        }
+
+        if( !isset( $view->standardUrlNext ) && ( $nextStep = array_shift( $steps ) ) !== null ) {
+            $param = array( 'c_step' => $nextStep );
+            $view->standardUrlNext = $view->url( $cTarget, $cCntl, $cAction, $param, array(), $cConfig );
+        }
+        // don't overwrite $view->standardUrlNext so order step URL is used
+
+        return $view;
+    }
 }
\ No newline at end of file

Spacing +79 added lines, -79 removed lines

@@ -122,7 +122,7 @@ 
 	 * @since 2015.07
 	 * @category Developer
 	 */
-	private $subPartNames = array( 'address', 'delivery', 'payment', 'summary', 'order', 'process' );
+	private $subPartNames = array('address', 'delivery', 'payment', 'summary', 'order', 'process');
 	private $cache;
 
 
@@ -134,42 +134,42 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
 		$context = $this->getContext();
 		$view = $this->getView();
 
 		try
 		{
-			$view = $this->setViewParams( $view, $tags, $expire );
+			$view = $this->setViewParams($view, $tags, $expire);
 
 			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+			foreach ($this->getSubClients() as $subclient) {
+				$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 			}
 			$view->standardBody = $html;
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
 
 		/** client/html/checkout/standard/standard/template-body
@@ -195,7 +195,7 @@ 
 		$tplconf = 'client/html/checkout/standard/standard/template-body';
 		$default = 'checkout/standard/body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -207,15 +207,15 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
 		try
 		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
+			$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+			foreach ($this->getSubClients() as $subclient) {
+				$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 			}
 			$view->standardHeader = $html;
 
@@ -243,11 +243,11 @@ 
 			$tplconf = 'client/html/checkout/standard/standard/template-header';
 			$default = 'checkout/standard/header-default.php';
 
-			return $view->render( $view->config( $tplconf, $default ) );
+			return $view->render($view->config($tplconf, $default));
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+			$this->getContext()->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 		}
 	}
 
@@ -259,7 +259,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/checkout/standard/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout standard html client
@@ -335,7 +335,7 @@ 
 		 * @see client/html/checkout/standard/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/standard/' . $type, $name );
+		return $this->createSubClient('checkout/standard/'.$type, $name);
 	}
 
 
@@ -353,35 +353,35 @@ 
 		{
 			parent::process();
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Plugin\Provider\Exception $e )
+		catch (\Aimeos\MShop\Plugin\Provider\Exception $e)
 		{
-			$errors = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$errors = array_merge( $errors, $this->translatePluginErrorCodes( $e->getErrorCodes() ) );
+			$errors = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
+			$errors = array_merge($errors, $this->translatePluginErrorCodes($e->getErrorCodes()));
 
 			$view->summaryErrorCodes = $e->getErrorCodes();
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $errors;
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $errors;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->standardErrorList = $view->get( 'standardErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->standardErrorList = $view->get('standardErrorList', array()) + $error;
 		}
 	}
 
@@ -393,7 +393,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -405,13 +405,13 @@ 
 	 * @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
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$context = $this->getContext();
 
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
 			$view->standardBasket = $basketCntl->get();
 
 
@@ -438,7 +438,7 @@ 
 			 * @category User
 			 * @see client/html/checkout/standard/standard/subparts
 			 */
-			$default = $view->config( 'client/html/checkout/standard/url/step-active', 'summary' );
+			$default = $view->config('client/html/checkout/standard/url/step-active', 'summary');
 
 			/** client/html/checkout/standard/onepage
 			 * Shows all named checkout subparts at once for a one page checkout
@@ -470,24 +470,24 @@ 
 			 * @since 2015.05
 			 * @category Developer
 			 */
-			$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
-			$onestep = array_shift( $onepage ); // keep the first one page step
+			$onepage = $view->config('client/html/checkout/standard/onepage', array());
+			$onestep = array_shift($onepage); // keep the first one page step
 
-			$steps = (array) $context->getConfig()->get( $this->subPartPath, $this->subPartNames );
-			$steps = array_diff( $steps, $onepage ); // remove all remaining steps in $onepage
+			$steps = (array) $context->getConfig()->get($this->subPartPath, $this->subPartNames);
+			$steps = array_diff($steps, $onepage); // remove all remaining steps in $onepage
 
 			// use first step if default step isn't available
-			$default = ( !in_array( $default, $steps ) ? reset( $steps ) : $default );
+			$default = (!in_array($default, $steps) ? reset($steps) : $default);
 
-			$current = $view->param( 'c_step', $default );
+			$current = $view->param('c_step', $default);
 			// use $onestep if current step isn't available due to one page layout
-			$current = ( !in_array( $current, $steps ) ? $onestep : $current );
+			$current = (!in_array($current, $steps) ? $onestep : $current);
 
-			$cpos = $cpos = array_search( $current, $steps );
+			$cpos = $cpos = array_search($current, $steps);
 
-			if( !isset( $view->standardStepActive )
-				|| ( ( $apos = array_search( $view->standardStepActive, $steps ) ) !== false
-				&& $cpos !== false && $cpos < $apos )
+			if (!isset($view->standardStepActive)
+				|| (($apos = array_search($view->standardStepActive, $steps)) !== false
+				&& $cpos !== false && $cpos < $apos)
 			) {
 				$view->standardStepActive = $current;
 			}
@@ -495,7 +495,7 @@ 
 			$view->standardSteps = $steps;
 
 
-			$this->cache = $this->addNavigationUrls( $view, $steps, $view->standardStepActive );
+			$this->cache = $this->addNavigationUrls($view, $steps, $view->standardStepActive);
 		}
 
 		return $this->cache;
@@ -511,7 +511,7 @@ 
 	 * @return \Aimeos\MW\View\Iface Enhanced view object
 	 * @since 2016.05
 	 */
-	protected function addNavigationUrls( \Aimeos\MW\View\Iface $view, array $steps, $activeStep )
+	protected function addNavigationUrls(\Aimeos\MW\View\Iface $view, array $steps, $activeStep)
 	{
 		/** client/html/checkout/standard/url/target
 		 * Destination of the URL where the controller specified in the URL is known
@@ -527,7 +527,7 @@ 
 		 * @see client/html/checkout/standard/url/action
 		 * @see client/html/checkout/standard/url/config
 		 */
-		$cTarget = $view->config( 'client/html/checkout/standard/url/target' );
+		$cTarget = $view->config('client/html/checkout/standard/url/target');
 
 		/** client/html/checkout/standard/url/controller
 		 * Name of the controller whose action should be called
@@ -543,7 +543,7 @@ 
 		 * @see client/html/checkout/standard/url/action
 		 * @see client/html/checkout/standard/url/config
 		*/
-		$cCntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
+		$cCntl = $view->config('client/html/checkout/standard/url/controller', 'checkout');
 
 		/** client/html/checkout/standard/url/action
 		 * Name of the action that should create the output
@@ -559,7 +559,7 @@ 
 		 * @see client/html/checkout/standard/url/controller
 		 * @see client/html/checkout/standard/url/config
 		*/
-		$cAction = $view->config( 'client/html/checkout/standard/url/action', 'index' );
+		$cAction = $view->config('client/html/checkout/standard/url/action', 'index');
 
 		/** client/html/checkout/standard/url/config
 		 * Associative list of configuration options used for generating the URL
@@ -582,32 +582,32 @@ 
 		 * @see client/html/checkout/standard/url/action
 		 * @see client/html/url/config
 		*/
-		$cConfig = $view->config( 'client/html/checkout/standard/url/config', array() );
+		$cConfig = $view->config('client/html/checkout/standard/url/config', array());
 
 
-		$bTarget = $view->config( 'client/html/basket/standard/url/target' );
-		$bCntl = $view->config( 'client/html/basket/standard/url/controller', 'basket' );
-		$bAction = $view->config( 'client/html/basket/standard/url/action', 'index' );
-		$bConfig = $view->config( 'client/html/basket/standard/url/config', array() );
+		$bTarget = $view->config('client/html/basket/standard/url/target');
+		$bCntl = $view->config('client/html/basket/standard/url/controller', 'basket');
+		$bAction = $view->config('client/html/basket/standard/url/action', 'index');
+		$bConfig = $view->config('client/html/basket/standard/url/config', array());
 
 
 		$step = null;
 		do {
 			$lastStep = $step;
 		}
-		while( ( $step = array_shift( $steps ) ) !== null && $step !== $activeStep );
+		while (($step = array_shift($steps)) !== null && $step !== $activeStep);
 
 
-		if( $lastStep !== null ) {
-			$param = array( 'c_step' => $lastStep );
-			$view->standardUrlBack = $view->url( $cTarget, $cCntl, $cAction, $param, array(), $cConfig );
+		if ($lastStep !== null) {
+			$param = array('c_step' => $lastStep);
+			$view->standardUrlBack = $view->url($cTarget, $cCntl, $cAction, $param, array(), $cConfig);
 		} else {
-			$view->standardUrlBack = $view->url( $bTarget, $bCntl, $bAction, array(), array(), $bConfig );
+			$view->standardUrlBack = $view->url($bTarget, $bCntl, $bAction, array(), array(), $bConfig);
 		}
 
-		if( !isset( $view->standardUrlNext ) && ( $nextStep = array_shift( $steps ) ) !== null ) {
-			$param = array( 'c_step' => $nextStep );
-			$view->standardUrlNext = $view->url( $cTarget, $cCntl, $cAction, $param, array(), $cConfig );
+		if (!isset($view->standardUrlNext) && ($nextStep = array_shift($steps)) !== null) {
+			$param = array('c_step' => $nextStep);
+			$view->standardUrlNext = $view->url($cTarget, $cCntl, $cAction, $param, array(), $cConfig);
 		}
 		// don't overwrite $view->standardUrlNext so order step URL is used
 

client/html/src/Client/Html/Checkout/Standard/Address/Delivery/Standard.php

Indentation +762 added lines, -762 removed lines

@@ -19,767 +19,767 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/checkout/standard/address/delivery/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout standard address delivery 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/delivery/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
-
-	private $mandatory = array(
-		'order.base.address.salutation',
-		'order.base.address.firstname',
-		'order.base.address.lastname',
-		'order.base.address.address1',
-		'order.base.address.postal',
-		'order.base.address.city',
-		'order.base.address.languageid',
-	);
-
-	private $optional = array(
-		'order.base.address.company',
-		'order.base.address.vatid',
-		'order.base.address.address2',
-		'order.base.address.countryid',
-		'order.base.address.state',
-	);
-
-
-	/**
-	 * 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
-	 * @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 string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->deliveryBody = $html;
-
-		/** client/html/checkout/standard/address/delivery/standard/template-body
-		 * Relative path to the HTML body template of the checkout standard address delivery 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/delivery/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/standard/address/delivery/standard/template-body';
-		$default = 'checkout/standard/address-delivery-body-default.php';
-
-		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
-	 * @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 string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->deliveryHeader = $html;
-
-		/** client/html/checkout/standard/address/delivery/standard/template-header
-		 * Relative path to the HTML header template of the checkout standard address delivery client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in 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 head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/delivery/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/standard/address/delivery/standard/template-header';
-		$default = 'checkout/standard/address-delivery-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * 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( $type, $name = null )
-	{
-		/** client/html/checkout/standard/address/delivery/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout standard address delivery 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/delivery/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/delivery/decorators/global
-		 * @see client/html/checkout/standard/address/delivery/decorators/local
-		 */
-
-		/** client/html/checkout/standard/address/delivery/decorators/global
-		 * Adds a list of globally available decorators only to the checkout standard address delivery 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/delivery/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/delivery/decorators/excludes
-		 * @see client/html/checkout/standard/address/delivery/decorators/local
-		 */
-
-		/** client/html/checkout/standard/address/delivery/decorators/local
-		 * Adds a list of local decorators only to the checkout standard address delivery 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/delivery/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/delivery/decorators/excludes
-		 * @see client/html/checkout/standard/address/delivery/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/standard/address/delivery/' . $type, $name );
-	}
-
-
-	/**
-	 * Stores the given or fetched billing address in the basket.
-	 */
-	public function process()
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
-
-		try
-		{
-			if( ( $id = $view->param( 'ca_delivery_delete', null ) ) !== null )
-			{
-				$customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
-				$address = $customerAddressManager->getItem( $id );
-
-				if( $address->getParentId() != $context->getUserId() ) {
-					throw new \Aimeos\Client\Html\Exception( sprintf( 'Address with ID "%1$s" not found', $id ) );
-				}
-
-				$customerAddressManager->deleteItem( $id );
-			}
-
-			// only start if there's something to do
-			if( $view->param( 'ca_deliveryoption', null ) === null ) {
-				return;
-			}
-
-			$this->setAddress( $view );
-
-			parent::process();
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$view->deliveryError = $e->getErrorList();
-			throw $e;
-		}
-	}
-
-
-	/**
-	 * Checks the address fields for missing data and sanitizes the given parameter list.
-	 *
-	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
-	 * @return array List of missing field names
-	 */
-	protected function checkFields( array &$params )
-	{
-		$view = $this->getView();
-
-		/** client/html/checkout/standard/address/delivery/mandatory
-		 * List of delivery address input fields that are required
-		 *
-		 * You can configure the list of delivery address fields that are
-		 * necessary and must be filled by the customer before he can
-		 * continue the checkout process. Available field keys are:
-		 * * order.base.address.company
-		 * * order.base.address.vatid
-		 * * order.base.address.salutation
-		 * * order.base.address.firstname
-		 * * order.base.address.lastname
-		 * * order.base.address.address1
-		 * * order.base.address.address2
-		 * * order.base.address.address3
-		 * * order.base.address.postal
-		 * * order.base.address.city
-		 * * order.base.address.state
-		 * * order.base.address.languageid
-		 * * order.base.address.countryid
-		 * * order.base.address.telephone
-		 * * order.base.address.telefax
-		 * * order.base.address.email
-		 * * order.base.address.website
-		 *
-		 * Until 2015-02, the configuration option was available as
-		 * "client/html/common/address/delivery/mandatory" starting from 2014-03.
-		 *
-		 * @param array List of field keys
-		 * @since 2015.02
-		 * @category User
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/delivery/disable-new
-		 * @see client/html/checkout/standard/address/delivery/salutations
-		 * @see client/html/checkout/standard/address/delivery/optional
-		 * @see client/html/checkout/standard/address/delivery/hidden
-		 * @see client/html/checkout/standard/address/countries
-		 * @see client/html/checkout/standard/address/validate
-		 */
-		$mandatory = $view->config( 'client/html/checkout/standard/address/delivery/mandatory', $this->mandatory );
-
-		/** client/html/checkout/standard/address/delivery/optional
-		 * List of delivery address input fields that are optional
-		 *
-		 * You can configure the list of delivery address fields that
-		 * customers can fill but don't have to before they can
-		 * continue the checkout process. Available field keys are:
-		 * * order.base.address.company
-		 * * order.base.address.vatid
-		 * * order.base.address.salutation
-		 * * order.base.address.firstname
-		 * * order.base.address.lastname
-		 * * order.base.address.address1
-		 * * order.base.address.address2
-		 * * order.base.address.address3
-		 * * order.base.address.postal
-		 * * order.base.address.city
-		 * * order.base.address.state
-		 * * order.base.address.languageid
-		 * * order.base.address.countryid
-		 * * order.base.address.telephone
-		 * * order.base.address.telefax
-		 * * order.base.address.email
-		 * * order.base.address.website
-		 *
-		 * Until 2015-02, the configuration option was available as
-		 * "client/html/common/address/delivery/optional" starting from 2014-03.
-		 *
-		 * @param array List of field keys
-		 * @since 2015.02
-		 * @category User
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/delivery/disable-new
-		 * @see client/html/checkout/standard/address/delivery/salutations
-		 * @see client/html/checkout/standard/address/delivery/mandatory
-		 * @see client/html/checkout/standard/address/delivery/hidden
-		 * @see client/html/checkout/standard/address/countries
-		 * @see client/html/checkout/standard/address/validate
-		 */
-		$optional = $view->config( 'client/html/checkout/standard/address/delivery/optional', $this->optional );
-
-		/** client/html/checkout/standard/address/validate
-		 *
-		 * @see client/html/checkout/standard/address/delivery/mandatory
-		 * @see client/html/checkout/standard/address/delivery/optional
-		 */
-
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
-		$invalid = $this->validateFields( $params, $allFields );
-		$this->checkSalutation( $params, $mandatory );
-
-		foreach( $invalid as $key => $name )
-		{
-			$msg = $view->translate( 'client', 'Delivery address part "%1$s" is invalid' );
-			$invalid[$key] = sprintf( $msg, $name );
-		}
-
-		foreach( $mandatory as $key )
-		{
-			if( !isset( $params[$key] ) || $params[$key] == '' )
-			{
-				$msg = $view->translate( 'client', 'Delivery address part "%1$s" is missing' );
-				$invalid[$key] = sprintf( $msg, substr( $key, 19 ) );
-				unset( $params[$key] );
-			}
-		}
-
-		return $invalid;
-	}
-
-
-	/**
-	 * Additional checks for the salutation
-	 *
-	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
-	 * @param array &$mandatory List of mandatory field names
-	 * @return array Additional mandatory address keys
-	 * @since 2016.05
-	 */
-	protected function checkSalutation( array &$params, array &$mandatory )
-	{
-		if( isset( $params['order.base.address.salutation'] )
-				&& $params['order.base.address.salutation'] === \Aimeos\MShop\Common\Item\Address\Base::SALUTATION_COMPANY
-				&& in_array( 'order.base.address.company', $mandatory ) === false
-		) {
-			$mandatory[] = 'order.base.address.company';
-		} else {
-			$params['order.base.address.company'] = $params['order.base.address.vatid'] = '';
-		}
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Sets the new address
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @throws \Aimeos\Client\Html\Exception If an error occurs
-	 * @since 2016.05
-	 */
-	protected function setAddress( \Aimeos\MW\View\Iface $view )
-	{
-		$context = $this->getContext();
-		$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-
-		/** client/html/checkout/standard/address/delivery/disable-new
-		 * Disables the option to enter a different delivery address for an order
-		 *
-		 * Besides the billing address, customers can usually enter a different
-		 * delivery address as well. To suppress displaying the form fields for
-		 * a delivery address, you can set this configuration option to "1".
-		 *
-		 * Until 2015-02, the configuration option was available as
-		 * "client/html/common/address/delivery/disable-new" starting from 2014-03.
-		 *
-		 * @param boolean A value of "1" to disable, "0" enables the delivery address form
-		 * @since 2015.02
-		 * @category User
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/delivery/salutations
-		 * @see client/html/checkout/standard/address/delivery/mandatory
-		 * @see client/html/checkout/standard/address/delivery/optional
-		 * @see client/html/checkout/standard/address/delivery/hidden
-		*/
-		$disable = $view->config( 'client/html/checkout/standard/address/delivery/disable-new', false );
-		$type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_DELIVERY;
-
-		if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) === 'null' && $disable === false ) // new address
-		{
-			$params = $view->param( 'ca_delivery', array() );
-			$invalid = $this->checkFields( $params );
-
-			if( count( $invalid ) > 0 )
-			{
-				$view->deliveryError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one delivery address part is missing or invalid' ) );
-			}
-
-			$basketCtrl->setAddress( $type, $params );
-		}
-		else if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) !== '-1' ) // existing address
-		{
-			$customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
-			$address = $customerAddressManager->getItem( $option );
-
-			if( $address->getParentId() != $context->getUserId() ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Address with ID "%1$s" not found', $option ) );
-			}
-
-			$invalid = array();
-			$params = $view->param( 'ca_delivery_' . $option, array() );
-
-			if( !empty( $params ) )
-			{
-				$list = array();
-				$invalid = $this->checkFields( $params );
-
-				foreach( $params as $key => $value ) {
-					$list[str_replace( 'order.base', 'customer', $key )] = $value;
-				}
-
-				$address->fromArray( $list );
-				$customerAddressManager->saveItem( $address );
-			}
-
-			if( count( $invalid ) > 0 )
-			{
-				$view->deliveryError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one delivery address part is missing or invalid' ) );
-			}
-
-			$basketCtrl->setAddress( $type, $address );
-		}
-		else
-		{
-			$basketCtrl->setAddress( $type, null );
-		}
-	}
-
-
-	/**
-	 * 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
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$context = $this->getContext();
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-
-			try {
-				$langid = $basketCntl->get()->getAddress( 'delivery' )->getLanguageId();
-			} catch( \Exception $e ) {
-				$langid = $view->param( 'ca_delivery/order.base.address.languageid', $context->getLocale()->getLanguageId() );
-			}
-			$view->deliveryLanguage = $langid;
-
-			/** client/html/checkout/standard/address/delivery/hidden
-			 * List of delivery address input fields that are optional
-			 *
-			 * You can configure the list of delivery address fields that
-			 * are hidden when a customer enters his delivery address.
-			 * Available field keys are:
-			 * * order.base.address.company
-			 * * order.base.address.vatid
-			 * * order.base.address.salutation
-			 * * order.base.address.firstname
-			 * * order.base.address.lastname
-			 * * order.base.address.address1
-			 * * order.base.address.address2
-			 * * order.base.address.address3
-			 * * order.base.address.postal
-			 * * order.base.address.city
-			 * * order.base.address.state
-			 * * order.base.address.languageid
-			 * * order.base.address.countryid
-			 * * order.base.address.telephone
-			 * * order.base.address.telefax
-			 * * order.base.address.email
-			 * * order.base.address.website
-			 *
-			 * Caution: Only hide fields that don't require any input
-			 *
-			 * Until 2015-02, the configuration option was available as
-			 * "client/html/common/address/delivery/hidden" starting from 2014-03.
-			 *
-			 * @param array List of field keys
-			 * @since 2015.02
-			 * @category User
-			 * @category Developer
-			 * @see client/html/checkout/standard/address/delivery/disable-new
-			 * @see client/html/checkout/standard/address/delivery/salutations
-			 * @see client/html/checkout/standard/address/delivery/mandatory
-			 * @see client/html/checkout/standard/address/delivery/optional
-			 * @see client/html/checkout/standard/address/countries
-			 */
-			$hidden = $view->config( 'client/html/checkout/standard/address/delivery/hidden', array() );
-
-			if( count( $view->get( 'addressLanguages', array() ) ) === 1 ) {
-				$hidden[] = 'order.base.address.languageid';
-			}
-
-			$salutations = array( 'company', 'mr', 'mrs' );
-
-			/** client/html/checkout/standard/address/delivery/salutations
-			 * List of salutions the customer can select from for the delivery address
-			 *
-			 * The following salutations are available:
-			 * * empty string for "unknown"
-			 * * company
-			 * * mr
-			 * * mrs
-			 * * miss
-			 *
-			 * You can modify the list of salutation codes and remove the ones
-			 * which shouldn't be used. Adding new salutations is a little bit
-			 * more difficult because you have to adapt a few areas in the source
-			 * code.
-			 *
-			 * Until 2015-02, the configuration option was available as
-			 * "client/html/common/address/delivery/salutations" starting from 2014-03.
-			 *
-			 * @param array List of available salutation codes
-			 * @since 2015.02
-			 * @category User
-			 * @category Developer
-			 * @see client/html/checkout/standard/address/delivery/disable-new
-			 * @see client/html/checkout/standard/address/delivery/mandatory
-			 * @see client/html/checkout/standard/address/delivery/optional
-			 * @see client/html/checkout/standard/address/delivery/hidden
-			 * @see client/html/checkout/standard/address/countries
-			 */
-			$view->deliverySalutations = $view->config( 'client/html/checkout/standard/address/delivery/salutations', $salutations );
-
-			$view->deliveryMandatory = $view->config( 'client/html/checkout/standard/address/delivery/mandatory', $this->mandatory );
-			$view->deliveryOptional = $view->config( 'client/html/checkout/standard/address/delivery/optional', $this->optional );
-			$view->deliveryHidden = $hidden;
-
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Validate the address key/value pairs using regular expressions
-	 *
-	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
-	 * @param array $fields List of field names to validate
-	 * @return array List of invalid address keys
-	 * @since 2016.05
-	 */
-	protected function validateFields( array &$params, array $fields )
-	{
-		$config = $this->getContext()->getConfig();
-
-		/** client/html/checkout/standard/address/validate/company
-		 * Regular expression to check the "company" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/vatid
-		 * Regular expression to check the "vatid" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/salutation
-		 * Regular expression to check the "salutation" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/firstname
-		 * Regular expression to check the "firstname" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/lastname
-		 * Regular expression to check the "lastname" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/address1
-		 * Regular expression to check the "address1" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/address2
-		 * Regular expression to check the "address2" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/address3
-		 * Regular expression to check the "address3" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/postal
-		 * Regular expression to check the "postal" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/city
-		 * Regular expression to check the "city" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/state
-		 * Regular expression to check the "state" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/languageid
-		 * Regular expression to check the "languageid" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/countryid
-		 * Regular expression to check the "countryid" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/telephone
-		 * Regular expression to check the "telephone" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/telefax
-		 * Regular expression to check the "telefax" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/email
-		 * Regular expression to check the "email" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/website
-		 * Regular expression to check the "website" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		$invalid = array();
-
-		foreach( $params as $key => $value )
-		{
-			if( isset( $fields[$key] ) )
-			{
-				$name = substr( $key, 19 );
-				$regex = $config->get( 'client/html/checkout/standard/address/validate/' . $name );
-
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
-				{
-					$invalid[$key] = $name;
-					unset( $params[$key] );
-				}
-			}
-			else
-			{
-				unset( $params[$key] );
-			}
-		}
-
-		return $invalid;
-	}
+    /** client/html/checkout/standard/address/delivery/standard/subparts
+     * List of HTML sub-clients rendered within the checkout standard address delivery 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/delivery/standard/subparts';
+    private $subPartNames = array();
+    private $cache;
+
+    private $mandatory = array(
+        'order.base.address.salutation',
+        'order.base.address.firstname',
+        'order.base.address.lastname',
+        'order.base.address.address1',
+        'order.base.address.postal',
+        'order.base.address.city',
+        'order.base.address.languageid',
+    );
+
+    private $optional = array(
+        'order.base.address.company',
+        'order.base.address.vatid',
+        'order.base.address.address2',
+        'order.base.address.countryid',
+        'order.base.address.state',
+    );
+
+
+    /**
+     * 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
+     * @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 string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->deliveryBody = $html;
+
+        /** client/html/checkout/standard/address/delivery/standard/template-body
+         * Relative path to the HTML body template of the checkout standard address delivery 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/delivery/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/standard/address/delivery/standard/template-body';
+        $default = 'checkout/standard/address-delivery-body-default.php';
+
+        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
+     * @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 string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->deliveryHeader = $html;
+
+        /** client/html/checkout/standard/address/delivery/standard/template-header
+         * Relative path to the HTML header template of the checkout standard address delivery client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in 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 head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/standard/address/delivery/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/standard/address/delivery/standard/template-header';
+        $default = 'checkout/standard/address-delivery-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * 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( $type, $name = null )
+    {
+        /** client/html/checkout/standard/address/delivery/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout standard address delivery 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/delivery/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/delivery/decorators/global
+         * @see client/html/checkout/standard/address/delivery/decorators/local
+         */
+
+        /** client/html/checkout/standard/address/delivery/decorators/global
+         * Adds a list of globally available decorators only to the checkout standard address delivery 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/delivery/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/delivery/decorators/excludes
+         * @see client/html/checkout/standard/address/delivery/decorators/local
+         */
+
+        /** client/html/checkout/standard/address/delivery/decorators/local
+         * Adds a list of local decorators only to the checkout standard address delivery 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/delivery/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/delivery/decorators/excludes
+         * @see client/html/checkout/standard/address/delivery/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/standard/address/delivery/' . $type, $name );
+    }
+
+
+    /**
+     * Stores the given or fetched billing address in the basket.
+     */
+    public function process()
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
+
+        try
+        {
+            if( ( $id = $view->param( 'ca_delivery_delete', null ) ) !== null )
+            {
+                $customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
+                $address = $customerAddressManager->getItem( $id );
+
+                if( $address->getParentId() != $context->getUserId() ) {
+                    throw new \Aimeos\Client\Html\Exception( sprintf( 'Address with ID "%1$s" not found', $id ) );
+                }
+
+                $customerAddressManager->deleteItem( $id );
+            }
+
+            // only start if there's something to do
+            if( $view->param( 'ca_deliveryoption', null ) === null ) {
+                return;
+            }
+
+            $this->setAddress( $view );
+
+            parent::process();
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $view->deliveryError = $e->getErrorList();
+            throw $e;
+        }
+    }
+
+
+    /**
+     * Checks the address fields for missing data and sanitizes the given parameter list.
+     *
+     * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
+     * @return array List of missing field names
+     */
+    protected function checkFields( array &$params )
+    {
+        $view = $this->getView();
+
+        /** client/html/checkout/standard/address/delivery/mandatory
+         * List of delivery address input fields that are required
+         *
+         * You can configure the list of delivery address fields that are
+         * necessary and must be filled by the customer before he can
+         * continue the checkout process. Available field keys are:
+         * * order.base.address.company
+         * * order.base.address.vatid
+         * * order.base.address.salutation
+         * * order.base.address.firstname
+         * * order.base.address.lastname
+         * * order.base.address.address1
+         * * order.base.address.address2
+         * * order.base.address.address3
+         * * order.base.address.postal
+         * * order.base.address.city
+         * * order.base.address.state
+         * * order.base.address.languageid
+         * * order.base.address.countryid
+         * * order.base.address.telephone
+         * * order.base.address.telefax
+         * * order.base.address.email
+         * * order.base.address.website
+         *
+         * Until 2015-02, the configuration option was available as
+         * "client/html/common/address/delivery/mandatory" starting from 2014-03.
+         *
+         * @param array List of field keys
+         * @since 2015.02
+         * @category User
+         * @category Developer
+         * @see client/html/checkout/standard/address/delivery/disable-new
+         * @see client/html/checkout/standard/address/delivery/salutations
+         * @see client/html/checkout/standard/address/delivery/optional
+         * @see client/html/checkout/standard/address/delivery/hidden
+         * @see client/html/checkout/standard/address/countries
+         * @see client/html/checkout/standard/address/validate
+         */
+        $mandatory = $view->config( 'client/html/checkout/standard/address/delivery/mandatory', $this->mandatory );
+
+        /** client/html/checkout/standard/address/delivery/optional
+         * List of delivery address input fields that are optional
+         *
+         * You can configure the list of delivery address fields that
+         * customers can fill but don't have to before they can
+         * continue the checkout process. Available field keys are:
+         * * order.base.address.company
+         * * order.base.address.vatid
+         * * order.base.address.salutation
+         * * order.base.address.firstname
+         * * order.base.address.lastname
+         * * order.base.address.address1
+         * * order.base.address.address2
+         * * order.base.address.address3
+         * * order.base.address.postal
+         * * order.base.address.city
+         * * order.base.address.state
+         * * order.base.address.languageid
+         * * order.base.address.countryid
+         * * order.base.address.telephone
+         * * order.base.address.telefax
+         * * order.base.address.email
+         * * order.base.address.website
+         *
+         * Until 2015-02, the configuration option was available as
+         * "client/html/common/address/delivery/optional" starting from 2014-03.
+         *
+         * @param array List of field keys
+         * @since 2015.02
+         * @category User
+         * @category Developer
+         * @see client/html/checkout/standard/address/delivery/disable-new
+         * @see client/html/checkout/standard/address/delivery/salutations
+         * @see client/html/checkout/standard/address/delivery/mandatory
+         * @see client/html/checkout/standard/address/delivery/hidden
+         * @see client/html/checkout/standard/address/countries
+         * @see client/html/checkout/standard/address/validate
+         */
+        $optional = $view->config( 'client/html/checkout/standard/address/delivery/optional', $this->optional );
+
+        /** client/html/checkout/standard/address/validate
+         *
+         * @see client/html/checkout/standard/address/delivery/mandatory
+         * @see client/html/checkout/standard/address/delivery/optional
+         */
+
+        $allFields = array_flip( array_merge( $mandatory, $optional ) );
+        $invalid = $this->validateFields( $params, $allFields );
+        $this->checkSalutation( $params, $mandatory );
+
+        foreach( $invalid as $key => $name )
+        {
+            $msg = $view->translate( 'client', 'Delivery address part "%1$s" is invalid' );
+            $invalid[$key] = sprintf( $msg, $name );
+        }
+
+        foreach( $mandatory as $key )
+        {
+            if( !isset( $params[$key] ) || $params[$key] == '' )
+            {
+                $msg = $view->translate( 'client', 'Delivery address part "%1$s" is missing' );
+                $invalid[$key] = sprintf( $msg, substr( $key, 19 ) );
+                unset( $params[$key] );
+            }
+        }
+
+        return $invalid;
+    }
+
+
+    /**
+     * Additional checks for the salutation
+     *
+     * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
+     * @param array &$mandatory List of mandatory field names
+     * @return array Additional mandatory address keys
+     * @since 2016.05
+     */
+    protected function checkSalutation( array &$params, array &$mandatory )
+    {
+        if( isset( $params['order.base.address.salutation'] )
+                && $params['order.base.address.salutation'] === \Aimeos\MShop\Common\Item\Address\Base::SALUTATION_COMPANY
+                && in_array( 'order.base.address.company', $mandatory ) === false
+        ) {
+            $mandatory[] = 'order.base.address.company';
+        } else {
+            $params['order.base.address.company'] = $params['order.base.address.vatid'] = '';
+        }
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Sets the new address
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @throws \Aimeos\Client\Html\Exception If an error occurs
+     * @since 2016.05
+     */
+    protected function setAddress( \Aimeos\MW\View\Iface $view )
+    {
+        $context = $this->getContext();
+        $basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+
+        /** client/html/checkout/standard/address/delivery/disable-new
+         * Disables the option to enter a different delivery address for an order
+         *
+         * Besides the billing address, customers can usually enter a different
+         * delivery address as well. To suppress displaying the form fields for
+         * a delivery address, you can set this configuration option to "1".
+         *
+         * Until 2015-02, the configuration option was available as
+         * "client/html/common/address/delivery/disable-new" starting from 2014-03.
+         *
+         * @param boolean A value of "1" to disable, "0" enables the delivery address form
+         * @since 2015.02
+         * @category User
+         * @category Developer
+         * @see client/html/checkout/standard/address/delivery/salutations
+         * @see client/html/checkout/standard/address/delivery/mandatory
+         * @see client/html/checkout/standard/address/delivery/optional
+         * @see client/html/checkout/standard/address/delivery/hidden
+         */
+        $disable = $view->config( 'client/html/checkout/standard/address/delivery/disable-new', false );
+        $type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_DELIVERY;
+
+        if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) === 'null' && $disable === false ) // new address
+        {
+            $params = $view->param( 'ca_delivery', array() );
+            $invalid = $this->checkFields( $params );
+
+            if( count( $invalid ) > 0 )
+            {
+                $view->deliveryError = $invalid;
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one delivery address part is missing or invalid' ) );
+            }
+
+            $basketCtrl->setAddress( $type, $params );
+        }
+        else if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) !== '-1' ) // existing address
+        {
+            $customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
+            $address = $customerAddressManager->getItem( $option );
+
+            if( $address->getParentId() != $context->getUserId() ) {
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Address with ID "%1$s" not found', $option ) );
+            }
+
+            $invalid = array();
+            $params = $view->param( 'ca_delivery_' . $option, array() );
+
+            if( !empty( $params ) )
+            {
+                $list = array();
+                $invalid = $this->checkFields( $params );
+
+                foreach( $params as $key => $value ) {
+                    $list[str_replace( 'order.base', 'customer', $key )] = $value;
+                }
+
+                $address->fromArray( $list );
+                $customerAddressManager->saveItem( $address );
+            }
+
+            if( count( $invalid ) > 0 )
+            {
+                $view->deliveryError = $invalid;
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one delivery address part is missing or invalid' ) );
+            }
+
+            $basketCtrl->setAddress( $type, $address );
+        }
+        else
+        {
+            $basketCtrl->setAddress( $type, null );
+        }
+    }
+
+
+    /**
+     * 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
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $context = $this->getContext();
+            $basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+
+            try {
+                $langid = $basketCntl->get()->getAddress( 'delivery' )->getLanguageId();
+            } catch( \Exception $e ) {
+                $langid = $view->param( 'ca_delivery/order.base.address.languageid', $context->getLocale()->getLanguageId() );
+            }
+            $view->deliveryLanguage = $langid;
+
+            /** client/html/checkout/standard/address/delivery/hidden
+             * List of delivery address input fields that are optional
+             *
+             * You can configure the list of delivery address fields that
+             * are hidden when a customer enters his delivery address.
+             * Available field keys are:
+             * * order.base.address.company
+             * * order.base.address.vatid
+             * * order.base.address.salutation
+             * * order.base.address.firstname
+             * * order.base.address.lastname
+             * * order.base.address.address1
+             * * order.base.address.address2
+             * * order.base.address.address3
+             * * order.base.address.postal
+             * * order.base.address.city
+             * * order.base.address.state
+             * * order.base.address.languageid
+             * * order.base.address.countryid
+             * * order.base.address.telephone
+             * * order.base.address.telefax
+             * * order.base.address.email
+             * * order.base.address.website
+             *
+             * Caution: Only hide fields that don't require any input
+             *
+             * Until 2015-02, the configuration option was available as
+             * "client/html/common/address/delivery/hidden" starting from 2014-03.
+             *
+             * @param array List of field keys
+             * @since 2015.02
+             * @category User
+             * @category Developer
+             * @see client/html/checkout/standard/address/delivery/disable-new
+             * @see client/html/checkout/standard/address/delivery/salutations
+             * @see client/html/checkout/standard/address/delivery/mandatory
+             * @see client/html/checkout/standard/address/delivery/optional
+             * @see client/html/checkout/standard/address/countries
+             */
+            $hidden = $view->config( 'client/html/checkout/standard/address/delivery/hidden', array() );
+
+            if( count( $view->get( 'addressLanguages', array() ) ) === 1 ) {
+                $hidden[] = 'order.base.address.languageid';
+            }
+
+            $salutations = array( 'company', 'mr', 'mrs' );
+
+            /** client/html/checkout/standard/address/delivery/salutations
+             * List of salutions the customer can select from for the delivery address
+             *
+             * The following salutations are available:
+             * * empty string for "unknown"
+             * * company
+             * * mr
+             * * mrs
+             * * miss
+             *
+             * You can modify the list of salutation codes and remove the ones
+             * which shouldn't be used. Adding new salutations is a little bit
+             * more difficult because you have to adapt a few areas in the source
+             * code.
+             *
+             * Until 2015-02, the configuration option was available as
+             * "client/html/common/address/delivery/salutations" starting from 2014-03.
+             *
+             * @param array List of available salutation codes
+             * @since 2015.02
+             * @category User
+             * @category Developer
+             * @see client/html/checkout/standard/address/delivery/disable-new
+             * @see client/html/checkout/standard/address/delivery/mandatory
+             * @see client/html/checkout/standard/address/delivery/optional
+             * @see client/html/checkout/standard/address/delivery/hidden
+             * @see client/html/checkout/standard/address/countries
+             */
+            $view->deliverySalutations = $view->config( 'client/html/checkout/standard/address/delivery/salutations', $salutations );
+
+            $view->deliveryMandatory = $view->config( 'client/html/checkout/standard/address/delivery/mandatory', $this->mandatory );
+            $view->deliveryOptional = $view->config( 'client/html/checkout/standard/address/delivery/optional', $this->optional );
+            $view->deliveryHidden = $hidden;
+
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Validate the address key/value pairs using regular expressions
+     *
+     * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
+     * @param array $fields List of field names to validate
+     * @return array List of invalid address keys
+     * @since 2016.05
+     */
+    protected function validateFields( array &$params, array $fields )
+    {
+        $config = $this->getContext()->getConfig();
+
+        /** client/html/checkout/standard/address/validate/company
+         * Regular expression to check the "company" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/vatid
+         * Regular expression to check the "vatid" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/salutation
+         * Regular expression to check the "salutation" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/firstname
+         * Regular expression to check the "firstname" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/lastname
+         * Regular expression to check the "lastname" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/address1
+         * Regular expression to check the "address1" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/address2
+         * Regular expression to check the "address2" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/address3
+         * Regular expression to check the "address3" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/postal
+         * Regular expression to check the "postal" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/city
+         * Regular expression to check the "city" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/state
+         * Regular expression to check the "state" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/languageid
+         * Regular expression to check the "languageid" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/countryid
+         * Regular expression to check the "countryid" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/telephone
+         * Regular expression to check the "telephone" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/telefax
+         * Regular expression to check the "telefax" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/email
+         * Regular expression to check the "email" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/website
+         * Regular expression to check the "website" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        $invalid = array();
+
+        foreach( $params as $key => $value )
+        {
+            if( isset( $fields[$key] ) )
+            {
+                $name = substr( $key, 19 );
+                $regex = $config->get( 'client/html/checkout/standard/address/validate/' . $name );
+
+                if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+                {
+                    $invalid[$key] = $name;
+                    unset( $params[$key] );
+                }
+            }
+            else
+            {
+                unset( $params[$key] );
+            }
+        }
+
+        return $invalid;
+    }
 }
\ No newline at end of file

Spacing +84 added lines, -84 removed lines

@@ -86,13 +86,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->deliveryBody = $html;
 
@@ -119,7 +119,7 @@ 
 		$tplconf = 'client/html/checkout/standard/address/delivery/standard/template-body';
 		$default = 'checkout/standard/address-delivery-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -131,13 +131,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->deliveryHeader = $html;
 
@@ -165,7 +165,7 @@ 
 		$tplconf = 'client/html/checkout/standard/address/delivery/standard/template-header';
 		$default = 'checkout/standard/address-delivery-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -176,7 +176,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/checkout/standard/address/delivery/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout standard address delivery html client
@@ -252,7 +252,7 @@ 
 		 * @see client/html/checkout/standard/address/delivery/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/standard/address/delivery/' . $type, $name );
+		return $this->createSubClient('checkout/standard/address/delivery/'.$type, $name);
 	}
 
 
@@ -266,28 +266,28 @@ 
 
 		try
 		{
-			if( ( $id = $view->param( 'ca_delivery_delete', null ) ) !== null )
+			if (($id = $view->param('ca_delivery_delete', null)) !== null)
 			{
-				$customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
-				$address = $customerAddressManager->getItem( $id );
+				$customerAddressManager = \Aimeos\MShop\Factory::createManager($context, 'customer/address');
+				$address = $customerAddressManager->getItem($id);
 
-				if( $address->getParentId() != $context->getUserId() ) {
-					throw new \Aimeos\Client\Html\Exception( sprintf( 'Address with ID "%1$s" not found', $id ) );
+				if ($address->getParentId() != $context->getUserId()) {
+					throw new \Aimeos\Client\Html\Exception(sprintf('Address with ID "%1$s" not found', $id));
 				}
 
-				$customerAddressManager->deleteItem( $id );
+				$customerAddressManager->deleteItem($id);
 			}
 
 			// only start if there's something to do
-			if( $view->param( 'ca_deliveryoption', null ) === null ) {
+			if ($view->param('ca_deliveryoption', null) === null) {
 				return;
 			}
 
-			$this->setAddress( $view );
+			$this->setAddress($view);
 
 			parent::process();
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
 			$view->deliveryError = $e->getErrorList();
 			throw $e;
@@ -301,7 +301,7 @@ 
 	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
 	 * @return array List of missing field names
 	 */
-	protected function checkFields( array &$params )
+	protected function checkFields(array &$params)
 	{
 		$view = $this->getView();
 
@@ -343,7 +343,7 @@ 
 		 * @see client/html/checkout/standard/address/countries
 		 * @see client/html/checkout/standard/address/validate
 		 */
-		$mandatory = $view->config( 'client/html/checkout/standard/address/delivery/mandatory', $this->mandatory );
+		$mandatory = $view->config('client/html/checkout/standard/address/delivery/mandatory', $this->mandatory);
 
 		/** client/html/checkout/standard/address/delivery/optional
 		 * List of delivery address input fields that are optional
@@ -383,7 +383,7 @@ 
 		 * @see client/html/checkout/standard/address/countries
 		 * @see client/html/checkout/standard/address/validate
 		 */
-		$optional = $view->config( 'client/html/checkout/standard/address/delivery/optional', $this->optional );
+		$optional = $view->config('client/html/checkout/standard/address/delivery/optional', $this->optional);
 
 		/** client/html/checkout/standard/address/validate
 		 *
@@ -391,23 +391,23 @@ 
 		 * @see client/html/checkout/standard/address/delivery/optional
 		 */
 
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
-		$invalid = $this->validateFields( $params, $allFields );
-		$this->checkSalutation( $params, $mandatory );
+		$allFields = array_flip(array_merge($mandatory, $optional));
+		$invalid = $this->validateFields($params, $allFields);
+		$this->checkSalutation($params, $mandatory);
 
-		foreach( $invalid as $key => $name )
+		foreach ($invalid as $key => $name)
 		{
-			$msg = $view->translate( 'client', 'Delivery address part "%1$s" is invalid' );
-			$invalid[$key] = sprintf( $msg, $name );
+			$msg = $view->translate('client', 'Delivery address part "%1$s" is invalid');
+			$invalid[$key] = sprintf($msg, $name);
 		}
 
-		foreach( $mandatory as $key )
+		foreach ($mandatory as $key)
 		{
-			if( !isset( $params[$key] ) || $params[$key] == '' )
+			if (!isset($params[$key]) || $params[$key] == '')
 			{
-				$msg = $view->translate( 'client', 'Delivery address part "%1$s" is missing' );
-				$invalid[$key] = sprintf( $msg, substr( $key, 19 ) );
-				unset( $params[$key] );
+				$msg = $view->translate('client', 'Delivery address part "%1$s" is missing');
+				$invalid[$key] = sprintf($msg, substr($key, 19));
+				unset($params[$key]);
 			}
 		}
 
@@ -423,11 +423,11 @@ 
 	 * @return array Additional mandatory address keys
 	 * @since 2016.05
 	 */
-	protected function checkSalutation( array &$params, array &$mandatory )
+	protected function checkSalutation(array &$params, array &$mandatory)
 	{
-		if( isset( $params['order.base.address.salutation'] )
+		if (isset($params['order.base.address.salutation'])
 				&& $params['order.base.address.salutation'] === \Aimeos\MShop\Common\Item\Address\Base::SALUTATION_COMPANY
-				&& in_array( 'order.base.address.company', $mandatory ) === false
+				&& in_array('order.base.address.company', $mandatory) === false
 		) {
 			$mandatory[] = 'order.base.address.company';
 		} else {
@@ -443,7 +443,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -454,10 +454,10 @@ 
 	 * @throws \Aimeos\Client\Html\Exception If an error occurs
 	 * @since 2016.05
 	 */
-	protected function setAddress( \Aimeos\MW\View\Iface $view )
+	protected function setAddress(\Aimeos\MW\View\Iface $view)
 	{
 		$context = $this->getContext();
-		$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+		$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
 
 		/** client/html/checkout/standard/address/delivery/disable-new
 		 * Disables the option to enter a different delivery address for an order
@@ -478,58 +478,58 @@ 
 		 * @see client/html/checkout/standard/address/delivery/optional
 		 * @see client/html/checkout/standard/address/delivery/hidden
 		*/
-		$disable = $view->config( 'client/html/checkout/standard/address/delivery/disable-new', false );
+		$disable = $view->config('client/html/checkout/standard/address/delivery/disable-new', false);
 		$type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_DELIVERY;
 
-		if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) === 'null' && $disable === false ) // new address
+		if (($option = $view->param('ca_deliveryoption', 'null')) === 'null' && $disable === false) // new address
 		{
-			$params = $view->param( 'ca_delivery', array() );
-			$invalid = $this->checkFields( $params );
+			$params = $view->param('ca_delivery', array());
+			$invalid = $this->checkFields($params);
 
-			if( count( $invalid ) > 0 )
+			if (count($invalid) > 0)
 			{
 				$view->deliveryError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one delivery address part is missing or invalid' ) );
+				throw new \Aimeos\Client\Html\Exception(sprintf('At least one delivery address part is missing or invalid'));
 			}
 
-			$basketCtrl->setAddress( $type, $params );
+			$basketCtrl->setAddress($type, $params);
 		}
-		else if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) !== '-1' ) // existing address
+		else if (($option = $view->param('ca_deliveryoption', 'null')) !== '-1') // existing address
 		{
-			$customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
-			$address = $customerAddressManager->getItem( $option );
+			$customerAddressManager = \Aimeos\MShop\Factory::createManager($context, 'customer/address');
+			$address = $customerAddressManager->getItem($option);
 
-			if( $address->getParentId() != $context->getUserId() ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Address with ID "%1$s" not found', $option ) );
+			if ($address->getParentId() != $context->getUserId()) {
+				throw new \Aimeos\Client\Html\Exception(sprintf('Address with ID "%1$s" not found', $option));
 			}
 
 			$invalid = array();
-			$params = $view->param( 'ca_delivery_' . $option, array() );
+			$params = $view->param('ca_delivery_'.$option, array());
 
-			if( !empty( $params ) )
+			if (!empty($params))
 			{
 				$list = array();
-				$invalid = $this->checkFields( $params );
+				$invalid = $this->checkFields($params);
 
-				foreach( $params as $key => $value ) {
-					$list[str_replace( 'order.base', 'customer', $key )] = $value;
+				foreach ($params as $key => $value) {
+					$list[str_replace('order.base', 'customer', $key)] = $value;
 				}
 
-				$address->fromArray( $list );
-				$customerAddressManager->saveItem( $address );
+				$address->fromArray($list);
+				$customerAddressManager->saveItem($address);
 			}
 
-			if( count( $invalid ) > 0 )
+			if (count($invalid) > 0)
 			{
 				$view->deliveryError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one delivery address part is missing or invalid' ) );
+				throw new \Aimeos\Client\Html\Exception(sprintf('At least one delivery address part is missing or invalid'));
 			}
 
-			$basketCtrl->setAddress( $type, $address );
+			$basketCtrl->setAddress($type, $address);
 		}
 		else
 		{
-			$basketCtrl->setAddress( $type, null );
+			$basketCtrl->setAddress($type, null);
 		}
 	}
 
@@ -542,17 +542,17 @@ 
 	 * @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
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$context = $this->getContext();
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
 
 			try {
-				$langid = $basketCntl->get()->getAddress( 'delivery' )->getLanguageId();
-			} catch( \Exception $e ) {
-				$langid = $view->param( 'ca_delivery/order.base.address.languageid', $context->getLocale()->getLanguageId() );
+				$langid = $basketCntl->get()->getAddress('delivery')->getLanguageId();
+			} catch (\Exception $e) {
+				$langid = $view->param('ca_delivery/order.base.address.languageid', $context->getLocale()->getLanguageId());
 			}
 			$view->deliveryLanguage = $langid;
 
@@ -595,13 +595,13 @@ 
 			 * @see client/html/checkout/standard/address/delivery/optional
 			 * @see client/html/checkout/standard/address/countries
 			 */
-			$hidden = $view->config( 'client/html/checkout/standard/address/delivery/hidden', array() );
+			$hidden = $view->config('client/html/checkout/standard/address/delivery/hidden', array());
 
-			if( count( $view->get( 'addressLanguages', array() ) ) === 1 ) {
+			if (count($view->get('addressLanguages', array())) === 1) {
 				$hidden[] = 'order.base.address.languageid';
 			}
 
-			$salutations = array( 'company', 'mr', 'mrs' );
+			$salutations = array('company', 'mr', 'mrs');
 
 			/** client/html/checkout/standard/address/delivery/salutations
 			 * List of salutions the customer can select from for the delivery address
@@ -631,10 +631,10 @@ 
 			 * @see client/html/checkout/standard/address/delivery/hidden
 			 * @see client/html/checkout/standard/address/countries
 			 */
-			$view->deliverySalutations = $view->config( 'client/html/checkout/standard/address/delivery/salutations', $salutations );
+			$view->deliverySalutations = $view->config('client/html/checkout/standard/address/delivery/salutations', $salutations);
 
-			$view->deliveryMandatory = $view->config( 'client/html/checkout/standard/address/delivery/mandatory', $this->mandatory );
-			$view->deliveryOptional = $view->config( 'client/html/checkout/standard/address/delivery/optional', $this->optional );
+			$view->deliveryMandatory = $view->config('client/html/checkout/standard/address/delivery/mandatory', $this->mandatory);
+			$view->deliveryOptional = $view->config('client/html/checkout/standard/address/delivery/optional', $this->optional);
 			$view->deliveryHidden = $hidden;
 
 
@@ -653,7 +653,7 @@ 
 	 * @return array List of invalid address keys
 	 * @since 2016.05
 	 */
-	protected function validateFields( array &$params, array $fields )
+	protected function validateFields(array &$params, array $fields)
 	{
 		$config = $this->getContext()->getConfig();
 
@@ -761,22 +761,22 @@ 
 
 		$invalid = array();
 
-		foreach( $params as $key => $value )
+		foreach ($params as $key => $value)
 		{
-			if( isset( $fields[$key] ) )
+			if (isset($fields[$key]))
 			{
-				$name = substr( $key, 19 );
-				$regex = $config->get( 'client/html/checkout/standard/address/validate/' . $name );
+				$name = substr($key, 19);
+				$regex = $config->get('client/html/checkout/standard/address/validate/'.$name);
 
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+				if ($regex && preg_match('/'.$regex.'/', $value) !== 1)
 				{
 					$invalid[$key] = $name;
-					unset( $params[$key] );
+					unset($params[$key]);
 				}
 			}
 			else
 			{
-				unset( $params[$key] );
+				unset($params[$key]);
 			}
 		}
 

Braces +9 added lines, -9 removed lines

@@ -286,8 +286,7 @@ 
 			$this->setAddress( $view );
 
 			parent::process();
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
 		{
 			$view->deliveryError = $e->getErrorList();
 			throw $e;
@@ -481,9 +480,11 @@ 
 		$disable = $view->config( 'client/html/checkout/standard/address/delivery/disable-new', false );
 		$type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_DELIVERY;
 
-		if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) === 'null' && $disable === false ) // new address
+		if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) === 'null' && $disable === false ) {
+		    // new address
 		{
 			$params = $view->param( 'ca_delivery', array() );
+		}
 			$invalid = $this->checkFields( $params );
 
 			if( count( $invalid ) > 0 )
@@ -493,10 +494,11 @@ 
 			}
 
 			$basketCtrl->setAddress( $type, $params );
-		}
-		else if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) !== '-1' ) // existing address
+		} else if( ( $option = $view->param( 'ca_deliveryoption', 'null' ) ) !== '-1' ) {
+		    // existing address
 		{
 			$customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
+		}
 			$address = $customerAddressManager->getItem( $option );
 
 			if( $address->getParentId() != $context->getUserId() ) {
@@ -526,8 +528,7 @@ 
 			}
 
 			$basketCtrl->setAddress( $type, $address );
-		}
-		else
+		} else
 		{
 			$basketCtrl->setAddress( $type, null );
 		}
@@ -773,8 +774,7 @@ 
 					$invalid[$key] = $name;
 					unset( $params[$key] );
 				}
-			}
-			else
+			} else
 			{
 				unset( $params[$key] );
 			}

client/html/src/Client/Html/Checkout/Standard/Address/Billing/Standard.php

Indentation +826 added lines, -826 removed lines

@@ -19,831 +19,831 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/checkout/standard/address/billing/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout standard address billing 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/billing/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
-
-	private $mandatory = array(
-		'order.base.address.salutation',
-		'order.base.address.firstname',
-		'order.base.address.lastname',
-		'order.base.address.address1',
-		'order.base.address.postal',
-		'order.base.address.city',
-		'order.base.address.languageid',
-		'order.base.address.email'
-	);
-
-	private $optional = array(
-		'order.base.address.company',
-		'order.base.address.vatid',
-		'order.base.address.address2',
-		'order.base.address.countryid',
-		'order.base.address.state',
-	);
-
-
-	/**
-	 * 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
-	 * @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 string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->billingBody = $html;
-
-		/** client/html/checkout/standard/address/billing/standard/template-body
-		 * Relative path to the HTML body template of the checkout standard address billing 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/billing/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/standard/address/billing/standard/template-body';
-		$default = 'checkout/standard/address-billing-body-default.php';
-
-		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
-	 * @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 string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->billingHeader = $html;
-
-		/** client/html/checkout/standard/address/billing/standard/template-header
-		 * Relative path to the HTML header template of the checkout standard address billing client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in 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 head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/billing/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/standard/address/billing/standard/template-header';
-		$default = 'checkout/standard/address-billing-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * 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( $type, $name = null )
-	{
-		/** client/html/checkout/standard/address/billing/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout standard address billing 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/billing/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/billing/decorators/global
-		 * @see client/html/checkout/standard/address/billing/decorators/local
-		 */
-
-		/** client/html/checkout/standard/address/billing/decorators/global
-		 * Adds a list of globally available decorators only to the checkout standard address billing 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/billing/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/billing/decorators/excludes
-		 * @see client/html/checkout/standard/address/billing/decorators/local
-		 */
-
-		/** client/html/checkout/standard/address/billing/decorators/local
-		 * Adds a list of local decorators only to the checkout standard address billing 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/billing/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/billing/decorators/excludes
-		 * @see client/html/checkout/standard/address/billing/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/standard/address/billing/' . $type, $name );
-	}
-
-
-	/**
-	 * Stores the given or fetched billing address in the basket.
-	 */
-	public function process()
-	{
-		$view = $this->getView();
-
-		try
-		{
-			// only start if there's something to do
-			if( $view->param( 'ca_billingoption', null ) === null ) {
-				return;
-			}
-
-			$this->setAddress( $view );
-
-			parent::process();
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$view->billingError = $e->getErrorList();
-			throw $e;
-		}
-	}
-
-
-	/**
-	 * Checks the address fields for missing data and sanitizes the given parameter list.
-	 *
-	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
-	 * @return array List of missing field names
-	 */
-	protected function checkFields( array &$params )
-	{
-		$view = $this->getView();
-
-		/** client/html/checkout/standard/address/billing/mandatory
-		 * List of billing address input fields that are required
-		 *
-		 * You can configure the list of billing address fields that are
-		 * necessary and must be filled by the customer before he can
-		 * continue the checkout process. Available field keys are:
-		 * * order.base.address.company
-		 * * order.base.address.vatid
-		 * * order.base.address.salutation
-		 * * order.base.address.firstname
-		 * * order.base.address.lastname
-		 * * order.base.address.address1
-		 * * order.base.address.address2
-		 * * order.base.address.address3
-		 * * order.base.address.postal
-		 * * order.base.address.city
-		 * * order.base.address.state
-		 * * order.base.address.languageid
-		 * * order.base.address.countryid
-		 * * order.base.address.telephone
-		 * * order.base.address.telefax
-		 * * order.base.address.email
-		 * * order.base.address.website
-		 *
-		 * Until 2015-02, the configuration option was available as
-		 * "client/html/common/address/billing/mandatory" starting from 2014-03.
-		 *
-		 * @param array List of field keys
-		 * @since 2015.02
-		 * @category User
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/billing/disable-new
-		 * @see client/html/checkout/standard/address/billing/salutations
-		 * @see client/html/checkout/standard/address/billing/optional
-		 * @see client/html/checkout/standard/address/billing/hidden
-		 * @see client/html/checkout/standard/address/countries
-		 * @see client/html/checkout/standard/address/validate
-		 */
-		$mandatory = $view->config( 'client/html/checkout/standard/address/billing/mandatory', $this->mandatory );
-
-		/** client/html/checkout/standard/address/billing/optional
-		 * List of billing address input fields that are optional
-		 *
-		 * You can configure the list of billing address fields that
-		 * customers can fill but don't have to before they can
-		 * continue the checkout process. Available field keys are:
-		 * * order.base.address.company
-		 * * order.base.address.vatid
-		 * * order.base.address.salutation
-		 * * order.base.address.firstname
-		 * * order.base.address.lastname
-		 * * order.base.address.address1
-		 * * order.base.address.address2
-		 * * order.base.address.address3
-		 * * order.base.address.postal
-		 * * order.base.address.city
-		 * * order.base.address.state
-		 * * order.base.address.languageid
-		 * * order.base.address.countryid
-		 * * order.base.address.telephone
-		 * * order.base.address.telefax
-		 * * order.base.address.email
-		 * * order.base.address.website
-		 *
-		 * Until 2015-02, the configuration option was available as
-		 * "client/html/common/address/billing/optional" starting from 2014-03.
-		 *
-		 * @param array List of field keys
-		 * @since 2015.02
-		 * @category User
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/billing/disable-new
-		 * @see client/html/checkout/standard/address/billing/salutations
-		 * @see client/html/checkout/standard/address/billing/mandatory
-		 * @see client/html/checkout/standard/address/billing/hidden
-		 * @see client/html/checkout/standard/address/countries
-		 * @see client/html/checkout/standard/address/validate
-		 */
-		$optional = $view->config( 'client/html/checkout/standard/address/billing/optional', $this->optional );
-
-		/** client/html/checkout/standard/address/validate
-		 * List of regular expressions to validate the data of the address fields
-		 *
-		 * To validate the address input data of the customer, an individual
-		 * {@link http://php.net/manual/en/pcre.pattern.php Perl compatible regular expression}
-		 * can be applied to each field. Available fields are:
-		 * * company
-		 * * vatid
-		 * * salutation
-		 * * firstname
-		 * * lastname
-		 * * address1
-		 * * address2
-		 * * address3
-		 * * postal
-		 * * city
-		 * * state
-		 * * languageid
-		 * * countryid
-		 * * telephone
-		 * * telefax
-		 * * email
-		 * * website
-		 *
-		 * Some fields are validated automatically because they are not
-		 * dependent on a country specific rule. These fields are:
-		 * * salutation
-		 * * email
-		 * * website
-		 *
-		 * To validate e.g the postal/zip code, you can define a regular
-		 * expression like this if you want to allow only digits:
-		 *
-		 *  client/html/checkout/standard/address/validate/postal = '^[0-9]+$'
-		 *
-		 * Several regular expressions can be defined line this:
-		 *
-		 *  client/html/checkout/standard/address/validate = array(
-		 *      'postal' = '^[0-9]+$',
-		 *      'vatid' = '^[A-Z]{2}[0-9]{8}$',
-		 *  )
-		 *
-		 * Don't add any delimiting characters like slashes (/) to the beginning
-		 * or the end of the regular expression. They will be added automatically.
-		 * Any slashes inside the expression must be escaped by backlashes,
-		 * i.e. "\/".
-		 *
-		 * Until 2015-02, the configuration option was available as
-		 * "client/html/common/address/billing/validate" starting from 2014-09.
-		 *
-		 * @param array Associative list of field names and regular expressions
-		 * @since 2014.09
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/billing/mandatory
-		 * @see client/html/checkout/standard/address/billing/optional
-		 */
-
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
-		$invalid = $this->validateFields( $params, $allFields );
-		$this->checkSalutation( $params, $mandatory );
-
-		foreach( $invalid as $key => $name )
-		{
-			$msg = $view->translate( 'client', 'Billing address part "%1$s" is invalid' );
-			$invalid[$key] = sprintf( $msg, $name );
-		}
-
-		foreach( $mandatory as $key )
-		{
-			if( !isset( $params[$key] ) || $params[$key] == '' )
-			{
-				$msg = $view->translate( 'client', 'Billing address part "%1$s" is missing' );
-				$invalid[$key] = sprintf( $msg, substr( $key, 19 ) );
-				unset( $params[$key] );
-			}
-		}
-
-		return $invalid;
-	}
-
-
-	/**
-	 * Additional checks for the salutation
-	 *
-	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
-	 * @param array &$mandatory List of mandatory field names
-	 * @since 2016.05
-	 */
-	protected function checkSalutation( array &$params, array &$mandatory )
-	{
-		if( isset( $params['order.base.address.salutation'] )
-			&& $params['order.base.address.salutation'] === \Aimeos\MShop\Common\Item\Address\Base::SALUTATION_COMPANY
-			&& in_array( 'order.base.address.company', $mandatory ) === false
-		) {
-			$mandatory[] = 'order.base.address.company';
-		} else {
-			$params['order.base.address.company'] = $params['order.base.address.vatid'] = '';
-		}
-	}
-
-
-	/**
-	 * Returns the customer item for the given ID
-	 *
-	 * @param string $id Unique customer ID
-	 * @return \Aimeos\MShop\Customer\Item\Iface Customer item
-	 * @throws \Aimeos\Client\Html\Exception If no customer item is available
-	 * @since 2016.05
-	 */
-	protected function getCustomerItem( $id )
-	{
-		$context = $this->getContext();
-		$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
-
-		$search = $customerManager->createSearch( true );
-		$expr = array(
-				$search->compare( '==', 'customer.id', $id ),
-				$search->getConditions(),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-
-		$items = $customerManager->searchItems( $search );
-
-		if( ( $item = reset( $items ) ) === false || $id != $context->getUserId() ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Customer with ID "%1$s" not found', $id ) );
-		}
-
-		return $item;
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Sets the new address
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @throws \Aimeos\Client\Html\Exception If an error occurs
-	 * @since 2016.05
-	 */
-	protected function setAddress( \Aimeos\MW\View\Iface $view )
-	{
-		$context = $this->getContext();
-		$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-
-
-		/** client/html/checkout/standard/address/billing/disable-new
-		 * Disables the option to enter a new billing address for an order
-		 *
-		 * Besides the main billing address, customers can usually enter a new
-		 * billing address as well. To suppress displaying the form fields for
-		 * a billing address, you can set this configuration option to "1".
-		 *
-		 * Until 2015-02, the configuration option was available as
-		 * "client/html/common/address/billing/disable-new" starting from 2014-03.
-		 *
-		 * @param boolean A value of "1" to disable, "0" enables the billing address form
-		 * @since 2015.02
-		 * @category User
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/billing/salutations
-		 * @see client/html/checkout/standard/address/billing/mandatory
-		 * @see client/html/checkout/standard/address/billing/optional
-		 * @see client/html/checkout/standard/address/billing/hidden
-		*/
-		$disable = $view->config( 'client/html/checkout/standard/address/billing/disable-new', false );
-		$type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_PAYMENT;
-
-		if( ( $option = $view->param( 'ca_billingoption', 'null' ) ) === 'null' && $disable === false ) // new address
-		{
-			$params = $view->param( 'ca_billing', array() );
-			$invalid = $this->checkFields( $params );
-
-			if( count( $invalid ) > 0 )
-			{
-				$view->billingError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one billing address part is missing or invalid' ) );
-			}
-
-			$basketCtrl->setAddress( $type, $params );
-		}
-		else // existing address
-		{
-			$item = $this->getCustomerItem( $option );
-			$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
-
-			$invalid = array();
-			$addr = $item->getPaymentAddress();
-			$params = $view->param( 'ca_billing_' . $option, array() );
-
-			if( !empty( $params ) )
-			{
-				$list = array();
-				$invalid = $this->checkFields( $params );
-
-				foreach( $params as $key => $value ) {
-					$list[str_replace( 'order.base', 'customer', $key )] = $value;
-				}
-
-				$addr->fromArray( $list );
-				$item->setPaymentAddress( $addr );
-
-				$customerManager->saveItem( $item );
-			}
-
-			if( count( $invalid ) > 0 )
-			{
-				$view->billingError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one billing address part is missing or invalid' ) );
-			}
-
-			$basketCtrl->setAddress( $type, $addr );
-		}
-	}
-
-
-	/**
-	 * 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
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$context = $this->getContext();
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-
-			try {
-				$langid = $basketCntl->get()->getAddress( 'payment' )->getLanguageId();
-			} catch( \Exception $e ) {
-				$langid = $view->param( 'ca_billing/order.base.address.languageid', $context->getLocale()->getLanguageId() );
-			}
-			$view->billingLanguage = $langid;
-
-			/** client/html/checkout/standard/address/billing/hidden
-			 * List of billing address input fields that are optional and should be hidden
-			 *
-			 * You can configure the list of billing address fields that
-			 * are hidden when a customer enters his new billing address.
-			 * Available field keys are:
-			 * * order.base.address.company
-			 * * order.base.address.vatid
-			 * * order.base.address.salutation
-			 * * order.base.address.firstname
-			 * * order.base.address.lastname
-			 * * order.base.address.address1
-			 * * order.base.address.address2
-			 * * order.base.address.address3
-			 * * order.base.address.postal
-			 * * order.base.address.city
-			 * * order.base.address.state
-			 * * order.base.address.languageid
-			 * * order.base.address.countryid
-			 * * order.base.address.telephone
-			 * * order.base.address.telefax
-			 * * order.base.address.email
-			 * * order.base.address.website
-			 *
-			 * Caution: Only hide fields that don't require any input
-			 *
-			 * Until 2015-02, the configuration option was available as
-			 * "client/html/common/address/billing/hidden" starting from 2014-03.
-			 *
-			 * @param array List of field keys
-			 * @since 2015.02
-			 * @category User
-			 * @category Developer
-			 * @see client/html/checkout/standard/address/billing/disable-new
-			 * @see client/html/checkout/standard/address/billing/salutations
-			 * @see client/html/checkout/standard/address/billing/mandatory
-			 * @see client/html/checkout/standard/address/billing/optional
-			 * @see client/html/checkout/standard/address/countries
-			 */
-			$hidden = $view->config( 'client/html/checkout/standard/address/billing/hidden', array() );
-
-			if( count( $view->get( 'addressLanguages', array() ) ) === 1 ) {
-				$hidden[] = 'order.base.address.languageid';
-			}
-
-			$salutations = array( 'company', 'mr', 'mrs' );
-
-			/** client/html/checkout/standard/address/billing/salutations
-			 * List of salutions the customer can select from for the billing address
-			 *
-			 * The following salutations are available:
-			 * * empty string for "unknown"
-			 * * company
-			 * * mr
-			 * * mrs
-			 * * miss
-			 *
-			 * You can modify the list of salutation codes and remove the ones
-			 * which shouldn't be used. Adding new salutations is a little bit
-			 * more difficult because you have to adapt a few areas in the source
-			 * code.
-			 *
-			 * Until 2015-02, the configuration option was available as
-			 * "client/html/common/address/billing/salutations" starting from 2014-03.
-			 *
-			 * @param array List of available salutation codes
-			 * @since 2015.02
-			 * @category User
-			 * @category Developer
-			 * @see client/html/checkout/standard/address/billing/disable-new
-			 * @see client/html/checkout/standard/address/billing/mandatory
-			 * @see client/html/checkout/standard/address/billing/optional
-			 * @see client/html/checkout/standard/address/billing/hidden
-			 * @see client/html/checkout/standard/address/countries
-			 */
-			$view->billingSalutations = $view->config( 'client/html/checkout/standard/address/billing/salutations', $salutations );
-
-			$view->billingMandatory = $view->config( 'client/html/checkout/standard/address/billing/mandatory', $this->mandatory );
-			$view->billingOptional = $view->config( 'client/html/checkout/standard/address/billing/optional', $this->optional );
-			$view->billingHidden = $hidden;
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Validate the address key/value pairs using regular expressions
-	 *
-	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
-	 * @param array $fields List of field names to validate
-	 * @return array List of invalid address keys
-	 * @since 2016.05
-	 */
-	protected function validateFields( array &$params, array $fields )
-	{
-		$config = $this->getContext()->getConfig();
-
-		/** client/html/checkout/standard/address/validate/company
-		 * Regular expression to check the "company" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/vatid
-		 * Regular expression to check the "vatid" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/salutation
-		 * Regular expression to check the "salutation" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/firstname
-		 * Regular expression to check the "firstname" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/lastname
-		 * Regular expression to check the "lastname" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/address1
-		 * Regular expression to check the "address1" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/address2
-		 * Regular expression to check the "address2" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/address3
-		 * Regular expression to check the "address3" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/postal
-		 * Regular expression to check the "postal" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/city
-		 * Regular expression to check the "city" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/state
-		 * Regular expression to check the "state" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/languageid
-		 * Regular expression to check the "languageid" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/countryid
-		 * Regular expression to check the "countryid" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/telephone
-		 * Regular expression to check the "telephone" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/telefax
-		 * Regular expression to check the "telefax" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/email
-		 * Regular expression to check the "email" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		/** client/html/checkout/standard/address/validate/website
-		 * Regular expression to check the "website" address value
-		 *
-		 * @see client/html/checkout/standard/address/validate
-		 */
-
-		$invalid = array();
-
-		foreach( $params as $key => $value )
-		{
-			if( isset( $fields[$key] ) )
-			{
-				$name = substr( $key, 19 );
-				$regex = $config->get( 'client/html/checkout/standard/address/validate/' . $name );
-
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
-				{
-					$msg =
-					$invalid[$key] = $name;
-					unset( $params[$key] );
-				}
-			}
-			else
-			{
-				unset( $params[$key] );
-			}
-		}
-
-		return $invalid;
-	}
+    /** client/html/checkout/standard/address/billing/standard/subparts
+     * List of HTML sub-clients rendered within the checkout standard address billing 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/billing/standard/subparts';
+    private $subPartNames = array();
+    private $cache;
+
+    private $mandatory = array(
+        'order.base.address.salutation',
+        'order.base.address.firstname',
+        'order.base.address.lastname',
+        'order.base.address.address1',
+        'order.base.address.postal',
+        'order.base.address.city',
+        'order.base.address.languageid',
+        'order.base.address.email'
+    );
+
+    private $optional = array(
+        'order.base.address.company',
+        'order.base.address.vatid',
+        'order.base.address.address2',
+        'order.base.address.countryid',
+        'order.base.address.state',
+    );
+
+
+    /**
+     * 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
+     * @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 string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->billingBody = $html;
+
+        /** client/html/checkout/standard/address/billing/standard/template-body
+         * Relative path to the HTML body template of the checkout standard address billing 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/billing/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/standard/address/billing/standard/template-body';
+        $default = 'checkout/standard/address-billing-body-default.php';
+
+        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
+     * @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 string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->billingHeader = $html;
+
+        /** client/html/checkout/standard/address/billing/standard/template-header
+         * Relative path to the HTML header template of the checkout standard address billing client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in 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 head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/standard/address/billing/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/standard/address/billing/standard/template-header';
+        $default = 'checkout/standard/address-billing-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * 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( $type, $name = null )
+    {
+        /** client/html/checkout/standard/address/billing/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout standard address billing 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/billing/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/billing/decorators/global
+         * @see client/html/checkout/standard/address/billing/decorators/local
+         */
+
+        /** client/html/checkout/standard/address/billing/decorators/global
+         * Adds a list of globally available decorators only to the checkout standard address billing 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/billing/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/billing/decorators/excludes
+         * @see client/html/checkout/standard/address/billing/decorators/local
+         */
+
+        /** client/html/checkout/standard/address/billing/decorators/local
+         * Adds a list of local decorators only to the checkout standard address billing 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/billing/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/billing/decorators/excludes
+         * @see client/html/checkout/standard/address/billing/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/standard/address/billing/' . $type, $name );
+    }
+
+
+    /**
+     * Stores the given or fetched billing address in the basket.
+     */
+    public function process()
+    {
+        $view = $this->getView();
+
+        try
+        {
+            // only start if there's something to do
+            if( $view->param( 'ca_billingoption', null ) === null ) {
+                return;
+            }
+
+            $this->setAddress( $view );
+
+            parent::process();
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $view->billingError = $e->getErrorList();
+            throw $e;
+        }
+    }
+
+
+    /**
+     * Checks the address fields for missing data and sanitizes the given parameter list.
+     *
+     * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
+     * @return array List of missing field names
+     */
+    protected function checkFields( array &$params )
+    {
+        $view = $this->getView();
+
+        /** client/html/checkout/standard/address/billing/mandatory
+         * List of billing address input fields that are required
+         *
+         * You can configure the list of billing address fields that are
+         * necessary and must be filled by the customer before he can
+         * continue the checkout process. Available field keys are:
+         * * order.base.address.company
+         * * order.base.address.vatid
+         * * order.base.address.salutation
+         * * order.base.address.firstname
+         * * order.base.address.lastname
+         * * order.base.address.address1
+         * * order.base.address.address2
+         * * order.base.address.address3
+         * * order.base.address.postal
+         * * order.base.address.city
+         * * order.base.address.state
+         * * order.base.address.languageid
+         * * order.base.address.countryid
+         * * order.base.address.telephone
+         * * order.base.address.telefax
+         * * order.base.address.email
+         * * order.base.address.website
+         *
+         * Until 2015-02, the configuration option was available as
+         * "client/html/common/address/billing/mandatory" starting from 2014-03.
+         *
+         * @param array List of field keys
+         * @since 2015.02
+         * @category User
+         * @category Developer
+         * @see client/html/checkout/standard/address/billing/disable-new
+         * @see client/html/checkout/standard/address/billing/salutations
+         * @see client/html/checkout/standard/address/billing/optional
+         * @see client/html/checkout/standard/address/billing/hidden
+         * @see client/html/checkout/standard/address/countries
+         * @see client/html/checkout/standard/address/validate
+         */
+        $mandatory = $view->config( 'client/html/checkout/standard/address/billing/mandatory', $this->mandatory );
+
+        /** client/html/checkout/standard/address/billing/optional
+         * List of billing address input fields that are optional
+         *
+         * You can configure the list of billing address fields that
+         * customers can fill but don't have to before they can
+         * continue the checkout process. Available field keys are:
+         * * order.base.address.company
+         * * order.base.address.vatid
+         * * order.base.address.salutation
+         * * order.base.address.firstname
+         * * order.base.address.lastname
+         * * order.base.address.address1
+         * * order.base.address.address2
+         * * order.base.address.address3
+         * * order.base.address.postal
+         * * order.base.address.city
+         * * order.base.address.state
+         * * order.base.address.languageid
+         * * order.base.address.countryid
+         * * order.base.address.telephone
+         * * order.base.address.telefax
+         * * order.base.address.email
+         * * order.base.address.website
+         *
+         * Until 2015-02, the configuration option was available as
+         * "client/html/common/address/billing/optional" starting from 2014-03.
+         *
+         * @param array List of field keys
+         * @since 2015.02
+         * @category User
+         * @category Developer
+         * @see client/html/checkout/standard/address/billing/disable-new
+         * @see client/html/checkout/standard/address/billing/salutations
+         * @see client/html/checkout/standard/address/billing/mandatory
+         * @see client/html/checkout/standard/address/billing/hidden
+         * @see client/html/checkout/standard/address/countries
+         * @see client/html/checkout/standard/address/validate
+         */
+        $optional = $view->config( 'client/html/checkout/standard/address/billing/optional', $this->optional );
+
+        /** client/html/checkout/standard/address/validate
+         * List of regular expressions to validate the data of the address fields
+         *
+         * To validate the address input data of the customer, an individual
+         * {@link http://php.net/manual/en/pcre.pattern.php Perl compatible regular expression}
+         * can be applied to each field. Available fields are:
+         * * company
+         * * vatid
+         * * salutation
+         * * firstname
+         * * lastname
+         * * address1
+         * * address2
+         * * address3
+         * * postal
+         * * city
+         * * state
+         * * languageid
+         * * countryid
+         * * telephone
+         * * telefax
+         * * email
+         * * website
+         *
+         * Some fields are validated automatically because they are not
+         * dependent on a country specific rule. These fields are:
+         * * salutation
+         * * email
+         * * website
+         *
+         * To validate e.g the postal/zip code, you can define a regular
+         * expression like this if you want to allow only digits:
+         *
+         *  client/html/checkout/standard/address/validate/postal = '^[0-9]+$'
+         *
+         * Several regular expressions can be defined line this:
+         *
+         *  client/html/checkout/standard/address/validate = array(
+         *      'postal' = '^[0-9]+$',
+         *      'vatid' = '^[A-Z]{2}[0-9]{8}$',
+         *  )
+         *
+         * Don't add any delimiting characters like slashes (/) to the beginning
+         * or the end of the regular expression. They will be added automatically.
+         * Any slashes inside the expression must be escaped by backlashes,
+         * i.e. "\/".
+         *
+         * Until 2015-02, the configuration option was available as
+         * "client/html/common/address/billing/validate" starting from 2014-09.
+         *
+         * @param array Associative list of field names and regular expressions
+         * @since 2014.09
+         * @category Developer
+         * @see client/html/checkout/standard/address/billing/mandatory
+         * @see client/html/checkout/standard/address/billing/optional
+         */
+
+        $allFields = array_flip( array_merge( $mandatory, $optional ) );
+        $invalid = $this->validateFields( $params, $allFields );
+        $this->checkSalutation( $params, $mandatory );
+
+        foreach( $invalid as $key => $name )
+        {
+            $msg = $view->translate( 'client', 'Billing address part "%1$s" is invalid' );
+            $invalid[$key] = sprintf( $msg, $name );
+        }
+
+        foreach( $mandatory as $key )
+        {
+            if( !isset( $params[$key] ) || $params[$key] == '' )
+            {
+                $msg = $view->translate( 'client', 'Billing address part "%1$s" is missing' );
+                $invalid[$key] = sprintf( $msg, substr( $key, 19 ) );
+                unset( $params[$key] );
+            }
+        }
+
+        return $invalid;
+    }
+
+
+    /**
+     * Additional checks for the salutation
+     *
+     * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
+     * @param array &$mandatory List of mandatory field names
+     * @since 2016.05
+     */
+    protected function checkSalutation( array &$params, array &$mandatory )
+    {
+        if( isset( $params['order.base.address.salutation'] )
+            && $params['order.base.address.salutation'] === \Aimeos\MShop\Common\Item\Address\Base::SALUTATION_COMPANY
+            && in_array( 'order.base.address.company', $mandatory ) === false
+        ) {
+            $mandatory[] = 'order.base.address.company';
+        } else {
+            $params['order.base.address.company'] = $params['order.base.address.vatid'] = '';
+        }
+    }
+
+
+    /**
+     * Returns the customer item for the given ID
+     *
+     * @param string $id Unique customer ID
+     * @return \Aimeos\MShop\Customer\Item\Iface Customer item
+     * @throws \Aimeos\Client\Html\Exception If no customer item is available
+     * @since 2016.05
+     */
+    protected function getCustomerItem( $id )
+    {
+        $context = $this->getContext();
+        $customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
+
+        $search = $customerManager->createSearch( true );
+        $expr = array(
+                $search->compare( '==', 'customer.id', $id ),
+                $search->getConditions(),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+
+        $items = $customerManager->searchItems( $search );
+
+        if( ( $item = reset( $items ) ) === false || $id != $context->getUserId() ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Customer with ID "%1$s" not found', $id ) );
+        }
+
+        return $item;
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Sets the new address
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @throws \Aimeos\Client\Html\Exception If an error occurs
+     * @since 2016.05
+     */
+    protected function setAddress( \Aimeos\MW\View\Iface $view )
+    {
+        $context = $this->getContext();
+        $basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+
+
+        /** client/html/checkout/standard/address/billing/disable-new
+         * Disables the option to enter a new billing address for an order
+         *
+         * Besides the main billing address, customers can usually enter a new
+         * billing address as well. To suppress displaying the form fields for
+         * a billing address, you can set this configuration option to "1".
+         *
+         * Until 2015-02, the configuration option was available as
+         * "client/html/common/address/billing/disable-new" starting from 2014-03.
+         *
+         * @param boolean A value of "1" to disable, "0" enables the billing address form
+         * @since 2015.02
+         * @category User
+         * @category Developer
+         * @see client/html/checkout/standard/address/billing/salutations
+         * @see client/html/checkout/standard/address/billing/mandatory
+         * @see client/html/checkout/standard/address/billing/optional
+         * @see client/html/checkout/standard/address/billing/hidden
+         */
+        $disable = $view->config( 'client/html/checkout/standard/address/billing/disable-new', false );
+        $type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_PAYMENT;
+
+        if( ( $option = $view->param( 'ca_billingoption', 'null' ) ) === 'null' && $disable === false ) // new address
+        {
+            $params = $view->param( 'ca_billing', array() );
+            $invalid = $this->checkFields( $params );
+
+            if( count( $invalid ) > 0 )
+            {
+                $view->billingError = $invalid;
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one billing address part is missing or invalid' ) );
+            }
+
+            $basketCtrl->setAddress( $type, $params );
+        }
+        else // existing address
+        {
+            $item = $this->getCustomerItem( $option );
+            $customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
+
+            $invalid = array();
+            $addr = $item->getPaymentAddress();
+            $params = $view->param( 'ca_billing_' . $option, array() );
+
+            if( !empty( $params ) )
+            {
+                $list = array();
+                $invalid = $this->checkFields( $params );
+
+                foreach( $params as $key => $value ) {
+                    $list[str_replace( 'order.base', 'customer', $key )] = $value;
+                }
+
+                $addr->fromArray( $list );
+                $item->setPaymentAddress( $addr );
+
+                $customerManager->saveItem( $item );
+            }
+
+            if( count( $invalid ) > 0 )
+            {
+                $view->billingError = $invalid;
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one billing address part is missing or invalid' ) );
+            }
+
+            $basketCtrl->setAddress( $type, $addr );
+        }
+    }
+
+
+    /**
+     * 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
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $context = $this->getContext();
+            $basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+
+            try {
+                $langid = $basketCntl->get()->getAddress( 'payment' )->getLanguageId();
+            } catch( \Exception $e ) {
+                $langid = $view->param( 'ca_billing/order.base.address.languageid', $context->getLocale()->getLanguageId() );
+            }
+            $view->billingLanguage = $langid;
+
+            /** client/html/checkout/standard/address/billing/hidden
+             * List of billing address input fields that are optional and should be hidden
+             *
+             * You can configure the list of billing address fields that
+             * are hidden when a customer enters his new billing address.
+             * Available field keys are:
+             * * order.base.address.company
+             * * order.base.address.vatid
+             * * order.base.address.salutation
+             * * order.base.address.firstname
+             * * order.base.address.lastname
+             * * order.base.address.address1
+             * * order.base.address.address2
+             * * order.base.address.address3
+             * * order.base.address.postal
+             * * order.base.address.city
+             * * order.base.address.state
+             * * order.base.address.languageid
+             * * order.base.address.countryid
+             * * order.base.address.telephone
+             * * order.base.address.telefax
+             * * order.base.address.email
+             * * order.base.address.website
+             *
+             * Caution: Only hide fields that don't require any input
+             *
+             * Until 2015-02, the configuration option was available as
+             * "client/html/common/address/billing/hidden" starting from 2014-03.
+             *
+             * @param array List of field keys
+             * @since 2015.02
+             * @category User
+             * @category Developer
+             * @see client/html/checkout/standard/address/billing/disable-new
+             * @see client/html/checkout/standard/address/billing/salutations
+             * @see client/html/checkout/standard/address/billing/mandatory
+             * @see client/html/checkout/standard/address/billing/optional
+             * @see client/html/checkout/standard/address/countries
+             */
+            $hidden = $view->config( 'client/html/checkout/standard/address/billing/hidden', array() );
+
+            if( count( $view->get( 'addressLanguages', array() ) ) === 1 ) {
+                $hidden[] = 'order.base.address.languageid';
+            }
+
+            $salutations = array( 'company', 'mr', 'mrs' );
+
+            /** client/html/checkout/standard/address/billing/salutations
+             * List of salutions the customer can select from for the billing address
+             *
+             * The following salutations are available:
+             * * empty string for "unknown"
+             * * company
+             * * mr
+             * * mrs
+             * * miss
+             *
+             * You can modify the list of salutation codes and remove the ones
+             * which shouldn't be used. Adding new salutations is a little bit
+             * more difficult because you have to adapt a few areas in the source
+             * code.
+             *
+             * Until 2015-02, the configuration option was available as
+             * "client/html/common/address/billing/salutations" starting from 2014-03.
+             *
+             * @param array List of available salutation codes
+             * @since 2015.02
+             * @category User
+             * @category Developer
+             * @see client/html/checkout/standard/address/billing/disable-new
+             * @see client/html/checkout/standard/address/billing/mandatory
+             * @see client/html/checkout/standard/address/billing/optional
+             * @see client/html/checkout/standard/address/billing/hidden
+             * @see client/html/checkout/standard/address/countries
+             */
+            $view->billingSalutations = $view->config( 'client/html/checkout/standard/address/billing/salutations', $salutations );
+
+            $view->billingMandatory = $view->config( 'client/html/checkout/standard/address/billing/mandatory', $this->mandatory );
+            $view->billingOptional = $view->config( 'client/html/checkout/standard/address/billing/optional', $this->optional );
+            $view->billingHidden = $hidden;
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Validate the address key/value pairs using regular expressions
+     *
+     * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
+     * @param array $fields List of field names to validate
+     * @return array List of invalid address keys
+     * @since 2016.05
+     */
+    protected function validateFields( array &$params, array $fields )
+    {
+        $config = $this->getContext()->getConfig();
+
+        /** client/html/checkout/standard/address/validate/company
+         * Regular expression to check the "company" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/vatid
+         * Regular expression to check the "vatid" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/salutation
+         * Regular expression to check the "salutation" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/firstname
+         * Regular expression to check the "firstname" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/lastname
+         * Regular expression to check the "lastname" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/address1
+         * Regular expression to check the "address1" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/address2
+         * Regular expression to check the "address2" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/address3
+         * Regular expression to check the "address3" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/postal
+         * Regular expression to check the "postal" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/city
+         * Regular expression to check the "city" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/state
+         * Regular expression to check the "state" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/languageid
+         * Regular expression to check the "languageid" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/countryid
+         * Regular expression to check the "countryid" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/telephone
+         * Regular expression to check the "telephone" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/telefax
+         * Regular expression to check the "telefax" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/email
+         * Regular expression to check the "email" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        /** client/html/checkout/standard/address/validate/website
+         * Regular expression to check the "website" address value
+         *
+         * @see client/html/checkout/standard/address/validate
+         */
+
+        $invalid = array();
+
+        foreach( $params as $key => $value )
+        {
+            if( isset( $fields[$key] ) )
+            {
+                $name = substr( $key, 19 );
+                $regex = $config->get( 'client/html/checkout/standard/address/validate/' . $name );
+
+                if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+                {
+                    $msg =
+                    $invalid[$key] = $name;
+                    unset( $params[$key] );
+                }
+            }
+            else
+            {
+                unset( $params[$key] );
+            }
+        }
+
+        return $invalid;
+    }
 }
\ No newline at end of file

Spacing +83 added lines, -83 removed lines

@@ -87,13 +87,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->billingBody = $html;
 
@@ -120,7 +120,7 @@ 
 		$tplconf = 'client/html/checkout/standard/address/billing/standard/template-body';
 		$default = 'checkout/standard/address-billing-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -132,13 +132,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->billingHeader = $html;
 
@@ -166,7 +166,7 @@ 
 		$tplconf = 'client/html/checkout/standard/address/billing/standard/template-header';
 		$default = 'checkout/standard/address-billing-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -177,7 +177,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/checkout/standard/address/billing/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout standard address billing html client
@@ -253,7 +253,7 @@ 
 		 * @see client/html/checkout/standard/address/billing/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/standard/address/billing/' . $type, $name );
+		return $this->createSubClient('checkout/standard/address/billing/'.$type, $name);
 	}
 
 
@@ -267,15 +267,15 @@ 
 		try
 		{
 			// only start if there's something to do
-			if( $view->param( 'ca_billingoption', null ) === null ) {
+			if ($view->param('ca_billingoption', null) === null) {
 				return;
 			}
 
-			$this->setAddress( $view );
+			$this->setAddress($view);
 
 			parent::process();
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
 			$view->billingError = $e->getErrorList();
 			throw $e;
@@ -289,7 +289,7 @@ 
 	 * @param array &$params Associative list of address keys (order.base.address.* or customer.address.*) and their values
 	 * @return array List of missing field names
 	 */
-	protected function checkFields( array &$params )
+	protected function checkFields(array &$params)
 	{
 		$view = $this->getView();
 
@@ -331,7 +331,7 @@ 
 		 * @see client/html/checkout/standard/address/countries
 		 * @see client/html/checkout/standard/address/validate
 		 */
-		$mandatory = $view->config( 'client/html/checkout/standard/address/billing/mandatory', $this->mandatory );
+		$mandatory = $view->config('client/html/checkout/standard/address/billing/mandatory', $this->mandatory);
 
 		/** client/html/checkout/standard/address/billing/optional
 		 * List of billing address input fields that are optional
@@ -371,7 +371,7 @@ 
 		 * @see client/html/checkout/standard/address/countries
 		 * @see client/html/checkout/standard/address/validate
 		 */
-		$optional = $view->config( 'client/html/checkout/standard/address/billing/optional', $this->optional );
+		$optional = $view->config('client/html/checkout/standard/address/billing/optional', $this->optional);
 
 		/** client/html/checkout/standard/address/validate
 		 * List of regular expressions to validate the data of the address fields
@@ -430,23 +430,23 @@ 
 		 * @see client/html/checkout/standard/address/billing/optional
 		 */
 
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
-		$invalid = $this->validateFields( $params, $allFields );
-		$this->checkSalutation( $params, $mandatory );
+		$allFields = array_flip(array_merge($mandatory, $optional));
+		$invalid = $this->validateFields($params, $allFields);
+		$this->checkSalutation($params, $mandatory);
 
-		foreach( $invalid as $key => $name )
+		foreach ($invalid as $key => $name)
 		{
-			$msg = $view->translate( 'client', 'Billing address part "%1$s" is invalid' );
-			$invalid[$key] = sprintf( $msg, $name );
+			$msg = $view->translate('client', 'Billing address part "%1$s" is invalid');
+			$invalid[$key] = sprintf($msg, $name);
 		}
 
-		foreach( $mandatory as $key )
+		foreach ($mandatory as $key)
 		{
-			if( !isset( $params[$key] ) || $params[$key] == '' )
+			if (!isset($params[$key]) || $params[$key] == '')
 			{
-				$msg = $view->translate( 'client', 'Billing address part "%1$s" is missing' );
-				$invalid[$key] = sprintf( $msg, substr( $key, 19 ) );
-				unset( $params[$key] );
+				$msg = $view->translate('client', 'Billing address part "%1$s" is missing');
+				$invalid[$key] = sprintf($msg, substr($key, 19));
+				unset($params[$key]);
 			}
 		}
 
@@ -461,11 +461,11 @@ 
 	 * @param array &$mandatory List of mandatory field names
 	 * @since 2016.05
 	 */
-	protected function checkSalutation( array &$params, array &$mandatory )
+	protected function checkSalutation(array &$params, array &$mandatory)
 	{
-		if( isset( $params['order.base.address.salutation'] )
+		if (isset($params['order.base.address.salutation'])
 			&& $params['order.base.address.salutation'] === \Aimeos\MShop\Common\Item\Address\Base::SALUTATION_COMPANY
-			&& in_array( 'order.base.address.company', $mandatory ) === false
+			&& in_array('order.base.address.company', $mandatory) === false
 		) {
 			$mandatory[] = 'order.base.address.company';
 		} else {
@@ -482,22 +482,22 @@ 
 	 * @throws \Aimeos\Client\Html\Exception If no customer item is available
 	 * @since 2016.05
 	 */
-	protected function getCustomerItem( $id )
+	protected function getCustomerItem($id)
 	{
 		$context = $this->getContext();
-		$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
+		$customerManager = \Aimeos\MShop\Factory::createManager($context, 'customer');
 
-		$search = $customerManager->createSearch( true );
+		$search = $customerManager->createSearch(true);
 		$expr = array(
-				$search->compare( '==', 'customer.id', $id ),
+				$search->compare('==', 'customer.id', $id),
 				$search->getConditions(),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
+		$search->setConditions($search->combine('&&', $expr));
 
-		$items = $customerManager->searchItems( $search );
+		$items = $customerManager->searchItems($search);
 
-		if( ( $item = reset( $items ) ) === false || $id != $context->getUserId() ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Customer with ID "%1$s" not found', $id ) );
+		if (($item = reset($items)) === false || $id != $context->getUserId()) {
+			throw new \Aimeos\Client\Html\Exception(sprintf('Customer with ID "%1$s" not found', $id));
 		}
 
 		return $item;
@@ -511,7 +511,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -522,10 +522,10 @@ 
 	 * @throws \Aimeos\Client\Html\Exception If an error occurs
 	 * @since 2016.05
 	 */
-	protected function setAddress( \Aimeos\MW\View\Iface $view )
+	protected function setAddress(\Aimeos\MW\View\Iface $view)
 	{
 		$context = $this->getContext();
-		$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+		$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
 
 
 		/** client/html/checkout/standard/address/billing/disable-new
@@ -547,53 +547,53 @@ 
 		 * @see client/html/checkout/standard/address/billing/optional
 		 * @see client/html/checkout/standard/address/billing/hidden
 		*/
-		$disable = $view->config( 'client/html/checkout/standard/address/billing/disable-new', false );
+		$disable = $view->config('client/html/checkout/standard/address/billing/disable-new', false);
 		$type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_PAYMENT;
 
-		if( ( $option = $view->param( 'ca_billingoption', 'null' ) ) === 'null' && $disable === false ) // new address
+		if (($option = $view->param('ca_billingoption', 'null')) === 'null' && $disable === false) // new address
 		{
-			$params = $view->param( 'ca_billing', array() );
-			$invalid = $this->checkFields( $params );
+			$params = $view->param('ca_billing', array());
+			$invalid = $this->checkFields($params);
 
-			if( count( $invalid ) > 0 )
+			if (count($invalid) > 0)
 			{
 				$view->billingError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one billing address part is missing or invalid' ) );
+				throw new \Aimeos\Client\Html\Exception(sprintf('At least one billing address part is missing or invalid'));
 			}
 
-			$basketCtrl->setAddress( $type, $params );
+			$basketCtrl->setAddress($type, $params);
 		}
 		else // existing address
 		{
-			$item = $this->getCustomerItem( $option );
-			$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
+			$item = $this->getCustomerItem($option);
+			$customerManager = \Aimeos\MShop\Factory::createManager($context, 'customer');
 
 			$invalid = array();
 			$addr = $item->getPaymentAddress();
-			$params = $view->param( 'ca_billing_' . $option, array() );
+			$params = $view->param('ca_billing_'.$option, array());
 
-			if( !empty( $params ) )
+			if (!empty($params))
 			{
 				$list = array();
-				$invalid = $this->checkFields( $params );
+				$invalid = $this->checkFields($params);
 
-				foreach( $params as $key => $value ) {
-					$list[str_replace( 'order.base', 'customer', $key )] = $value;
+				foreach ($params as $key => $value) {
+					$list[str_replace('order.base', 'customer', $key)] = $value;
 				}
 
-				$addr->fromArray( $list );
-				$item->setPaymentAddress( $addr );
+				$addr->fromArray($list);
+				$item->setPaymentAddress($addr);
 
-				$customerManager->saveItem( $item );
+				$customerManager->saveItem($item);
 			}
 
-			if( count( $invalid ) > 0 )
+			if (count($invalid) > 0)
 			{
 				$view->billingError = $invalid;
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'At least one billing address part is missing or invalid' ) );
+				throw new \Aimeos\Client\Html\Exception(sprintf('At least one billing address part is missing or invalid'));
 			}
 
-			$basketCtrl->setAddress( $type, $addr );
+			$basketCtrl->setAddress($type, $addr);
 		}
 	}
 
@@ -606,17 +606,17 @@ 
 	 * @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
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$context = $this->getContext();
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
 
 			try {
-				$langid = $basketCntl->get()->getAddress( 'payment' )->getLanguageId();
-			} catch( \Exception $e ) {
-				$langid = $view->param( 'ca_billing/order.base.address.languageid', $context->getLocale()->getLanguageId() );
+				$langid = $basketCntl->get()->getAddress('payment')->getLanguageId();
+			} catch (\Exception $e) {
+				$langid = $view->param('ca_billing/order.base.address.languageid', $context->getLocale()->getLanguageId());
 			}
 			$view->billingLanguage = $langid;
 
@@ -659,13 +659,13 @@ 
 			 * @see client/html/checkout/standard/address/billing/optional
 			 * @see client/html/checkout/standard/address/countries
 			 */
-			$hidden = $view->config( 'client/html/checkout/standard/address/billing/hidden', array() );
+			$hidden = $view->config('client/html/checkout/standard/address/billing/hidden', array());
 
-			if( count( $view->get( 'addressLanguages', array() ) ) === 1 ) {
+			if (count($view->get('addressLanguages', array())) === 1) {
 				$hidden[] = 'order.base.address.languageid';
 			}
 
-			$salutations = array( 'company', 'mr', 'mrs' );
+			$salutations = array('company', 'mr', 'mrs');
 
 			/** client/html/checkout/standard/address/billing/salutations
 			 * List of salutions the customer can select from for the billing address
@@ -695,10 +695,10 @@ 
 			 * @see client/html/checkout/standard/address/billing/hidden
 			 * @see client/html/checkout/standard/address/countries
 			 */
-			$view->billingSalutations = $view->config( 'client/html/checkout/standard/address/billing/salutations', $salutations );
+			$view->billingSalutations = $view->config('client/html/checkout/standard/address/billing/salutations', $salutations);
 
-			$view->billingMandatory = $view->config( 'client/html/checkout/standard/address/billing/mandatory', $this->mandatory );
-			$view->billingOptional = $view->config( 'client/html/checkout/standard/address/billing/optional', $this->optional );
+			$view->billingMandatory = $view->config('client/html/checkout/standard/address/billing/mandatory', $this->mandatory);
+			$view->billingOptional = $view->config('client/html/checkout/standard/address/billing/optional', $this->optional);
 			$view->billingHidden = $hidden;
 
 			$this->cache = $view;
@@ -716,7 +716,7 @@ 
 	 * @return array List of invalid address keys
 	 * @since 2016.05
 	 */
-	protected function validateFields( array &$params, array $fields )
+	protected function validateFields(array &$params, array $fields)
 	{
 		$config = $this->getContext()->getConfig();
 
@@ -824,23 +824,23 @@ 
 
 		$invalid = array();
 
-		foreach( $params as $key => $value )
+		foreach ($params as $key => $value)
 		{
-			if( isset( $fields[$key] ) )
+			if (isset($fields[$key]))
 			{
-				$name = substr( $key, 19 );
-				$regex = $config->get( 'client/html/checkout/standard/address/validate/' . $name );
+				$name = substr($key, 19);
+				$regex = $config->get('client/html/checkout/standard/address/validate/'.$name);
 
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+				if ($regex && preg_match('/'.$regex.'/', $value) !== 1)
 				{
 					$msg =
 					$invalid[$key] = $name;
-					unset( $params[$key] );
+					unset($params[$key]);
 				}
 			}
 			else
 			{
-				unset( $params[$key] );
+				unset($params[$key]);
 			}
 		}
 

Braces +6 added lines, -7 removed lines

@@ -274,8 +274,7 @@ 
 			$this->setAddress( $view );
 
 			parent::process();
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
 		{
 			$view->billingError = $e->getErrorList();
 			throw $e;
@@ -550,9 +549,11 @@ 
 		$disable = $view->config( 'client/html/checkout/standard/address/billing/disable-new', false );
 		$type = \Aimeos\MShop\Order\Item\Base\Address\Base::TYPE_PAYMENT;
 
-		if( ( $option = $view->param( 'ca_billingoption', 'null' ) ) === 'null' && $disable === false ) // new address
+		if( ( $option = $view->param( 'ca_billingoption', 'null' ) ) === 'null' && $disable === false ) {
+		    // new address
 		{
 			$params = $view->param( 'ca_billing', array() );
+		}
 			$invalid = $this->checkFields( $params );
 
 			if( count( $invalid ) > 0 )
@@ -562,8 +563,7 @@ 
 			}
 
 			$basketCtrl->setAddress( $type, $params );
-		}
-		else // existing address
+		} else // existing address
 		{
 			$item = $this->getCustomerItem( $option );
 			$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
@@ -837,8 +837,7 @@ 
 					$invalid[$key] = $name;
 					unset( $params[$key] );
 				}
-			}
-			else
+			} else
 			{
 				unset( $params[$key] );
 			}

client/html/src/Client/Html/Account/Watch/Standard.php

Indentation +601 added lines, -601 removed lines

@@ -19,606 +19,606 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/account/watch/standard/subparts
-	 * List of HTML sub-clients rendered within the account watch 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/account/watch/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
-
-
-	/**
-	 * 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
-	 * @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 string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
-
-		try
-		{
-			$view = $this->setViewParams( $view, $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->watchBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
-		}
-
-		/** client/html/account/watch/standard/template-body
-		 * Relative path to the HTML body template of the account watch 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/account/watch/standard/template-header
-		 */
-		$tplconf = 'client/html/account/watch/standard/template-body';
-		$default = 'account/watch/body-default.php';
-
-		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
-	 * @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 string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		try
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->watchHeader = $html;
-
-			/** client/html/account/watch/standard/template-header
-			 * Relative path to the HTML header template of the account watch client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the HTML code that is inserted into the HTML page header
-			 * of the rendered page in 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 head
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/account/watch/standard/template-body
-			 */
-			$tplconf = 'client/html/account/watch/standard/template-header';
-			$default = 'account/watch/header-default.php';
-
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
-
-
-	/**
-	 * 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( $type, $name = null )
-	{
-		/** client/html/account/watch/decorators/excludes
-		 * Excludes decorators added by the "common" option from the account watch 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/account/watch/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 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/account/watch/decorators/global
-		 * @see client/html/account/watch/decorators/local
-		 */
-
-		/** client/html/account/watch/decorators/global
-		 * Adds a list of globally available decorators only to the account watch 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/account/watch/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 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/account/watch/decorators/excludes
-		 * @see client/html/account/watch/decorators/local
-		 */
-
-		/** client/html/account/watch/decorators/local
-		 * Adds a list of local decorators only to the account watch 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\Account\Decorator\*") around the html client.
-		 *
-		 *  client/html/account/watch/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/account/watch/decorators/excludes
-		 * @see client/html/account/watch/decorators/global
-		 */
-
-		return $this->createSubClient( 'account/watch/' . $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()
-	{
-		$view = $this->getView();
-		$context = $this->getContext();
-		$userId = $context->getUserId();
-		$ids = (array) $view->param( 'wat_id', array() );
-
-		if( $userId != null && !empty( $ids ) )
-		{
-			$typeId = $this->getTypeItem( 'customer/lists/type', 'product', 'watch' )->getId();
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
-			$items = $this->getListItems( $manager, $ids, $typeId, $userId );
-
-			switch( $view->param( 'wat_action' ) )
-			{
-				case 'add':
-
-					/** client/html/account/watch/standard/maxitems
-					 * Maximum number of products that can be watched in parallel
-					 *
-					 * This option limits the number of products that can be watched
-					 * after the users added the products to their watch list.
-					 * It must be a positive integer value greater than 0.
-					 *
-					 * Note: It's recommended to set this value not too high as this
-					 * leads to a high memory consumption when the e-mails are generated
-					 * to notify the customers. The memory used will up to 100*maxitems
-					 * of the footprint of one product item including the associated
-					 * texts, prices and media.
-					 *
-					 * @param integer Number of products
-					 * @since 2014.09
-					 * @category User
-					 * @category Developer
-					 */
-					$max = $context->getConfig()->get( 'client/html/account/watch/standard/maxitems', 100 );
-					$cnt = count( $ids );
-
-					if( $this->checkLimit( $manager, $typeId, $userId, $max, $cnt ) === false )
-					{
-						$error = sprintf( $context->getI18n()->dt( 'client', 'You can only watch up to %1$s products' ), $max );
-						$view->watchErrorList = $view->get( 'watchErrorList', array() ) + array( $error );
-						break;
-					}
-
-					$this->addItems( $manager, $items, $ids, $typeId, $userId );
-					break;
-
-				case 'edit':
-
-					$config = array(
-						'timeframe' => $view->param( 'wat_timeframe', 7 ),
-						'pricevalue' => $view->param( 'wat_pricevalue', '0.00' ),
-						'price' => $view->param( 'wat_price', 0 ),
-						'stock' => $view->param( 'wat_stock', 0 ),
-						'currency' => $context->getLocale()->getCurrencyId(),
-					);
-					$this->editItems( $manager, $items, $ids, $config );
-					break;
-
-				case 'delete':
-
-					$this->deleteItems( $manager, $items, $ids );
-					break;
-			}
-		}
-
-		parent::process();
-	}
-
-
-	/**
-	 * Tests if the maximum number of entries per user is already reached
-	 *
-	 * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
-	 * @param string $typeId List type ID of the referenced items
-	 * @param string $userId Unique user ID
-	 * @param integer $max Maximum number of items that are allowed
-	 * @param integer $cnt Number of items that should be added
-	 * @return boolean True if items can be added, false if not
-	 */
-	protected function checkLimit( \Aimeos\MShop\Common\Manager\Iface $manager, $typeId, $userId, $max, $cnt )
-	{
-		$search = $manager->createSearch();
-		$expr = array(
-			$search->compare( '==', 'customer.lists.parentid', $userId ),
-			$search->compare( '==', 'customer.lists.typeid', $typeId ),
-			$search->compare( '==', 'customer.lists.domain', 'product' ),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSlice( 0, 0 );
-
-		$total = 0;
-		$manager->searchItems( $search, array(), $total );
-
-		if( $total + $cnt > $max ) {
-			return false;
-		}
-
-		return true;
-	}
-
-
-	/**
-	 * Adds one or more list items to the given user
-	 *
-	 * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
-	 * @param array $listItems Associative list of the reference IDs as keys and the list items as values
-	 * @param array $ids List of referenced IDs
-	 * @param string $typeId List type ID of the referenced items
-	 * @param string $userId Unique user ID
-	 */
-	protected function addItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, $typeId, $userId )
-	{
-		$item = $manager->createItem();
-		$item->setParentId( $userId );
-		$item->setTypeId( $typeId );
-		$item->setDomain( 'product' );
-		$item->setStatus( 1 );
-
-		foreach( $ids as $id )
-		{
-			if( !isset( $listItems[$id] ) )
-			{
-				$item->setId( null );
-				$item->setRefId( $id );
-
-				$manager->saveItem( $item );
-				$manager->moveItem( $item->getId() );
-			}
-		}
-	}
-
-
-	/**
-	 * Removes the list items for the given reference IDs
-	 *
-	 * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
-	 * @param array $listItems Associative list of the reference IDs as keys and the list items as values
-	 * @param array $ids List of referenced IDs
-	 */
-	protected function deleteItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids )
-	{
-		$listIds = array();
-
-		foreach( $ids as $id )
-		{
-			if( isset( $listItems[$id] ) ) {
-				$listIds[] = $listItems[$id]->getId();
-			}
-		}
-
-		$manager->deleteItems( $listIds );
-	}
-
-
-	/**
-	 * Updates the list items for the given reference IDs
-	 *
-	 * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
-	 * @param array $listItems Associative list of the reference IDs as keys and the list items as values
-	 * @param array $ids List of referenced IDs
-	 * @param array $config Configuration settins with "timeframe", "pricevalue", "price", "stock" and "currency"
-	 */
-	protected function editItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, array $config )
-	{
-		foreach( $ids as $id )
-		{
-			if( isset( $listItems[$id] ) )
-			{
-				$item = $listItems[$id];
-				$time = time() + ( $config['timeframe'] + 1 ) * 86400;
-
-				$item->setDateEnd( date( 'Y-m-d 00:00:00', $time ) );
-				$item->setConfig( $config );
-
-				$manager->saveItem( $item );
-			}
-		}
-	}
-
-
-	/**
-	 * Returns the list items associated to the given user ID
-	 *
-	 * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
-	 * @param array $refIds IDs of the referenced items
-	 * @param string $typeId List type ID of the referenced items
-	 * @param string $userId Unique user ID
-	 * @return array Associative list of the reference IDs as keys and the list items as values
-	 */
-	protected function getListItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $refIds, $typeId, $userId )
-	{
-		$search = $manager->createSearch();
-		$expr = array(
-			$search->compare( '==', 'customer.lists.parentid', $userId ),
-			$search->compare( '==', 'customer.lists.refid', $refIds ),
-			$search->compare( '==', 'customer.lists.domain', 'product' ),
-			$search->compare( '==', 'customer.lists.typeid', $typeId ),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-
-		$items = array();
-		foreach( $manager->searchItems( $search ) as $item ) {
-			$items[$item->getRefId()] = $item;
-		}
-
-		return $items;
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Returns the sanitized page from the parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return integer Page number starting from 1
-	 */
-	protected function getProductListPage( \Aimeos\MW\View\Iface $view )
-	{
-		$page = (int) $view->param( 'wat_page', 1 );
-		return ( $page < 1 ? 1 : $page );
-	}
-
-
-	/**
-	 * Returns the sanitized page size from the parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return integer Page size
-	 */
-	protected function getProductListSize( \Aimeos\MW\View\Iface $view )
-	{
-		/** client/html/account/watch/size
-		 * The number of products shown in a list page for watch products
-		 *
-		 * Limits the number of products that is shown in the list pages to the
-		 * given value. If more products are available, the products are split
-		 * into bunches which will be shown on their own list page. The user is
-		 * able to move to the next page (or previous one if it's not the first)
-		 * to display the next (or previous) products.
-		 *
-		 * The value must be an integer number from 1 to 100. Negative values as
-		 * well as values above 100 are not allowed. The value can be overwritten
-		 * per request if the "l_size" parameter is part of the URL.
-		 *
-		 * @param integer Number of products
-		 * @since 2014.09
-		 * @category User
-		 * @category Developer
-		 * @see client/html/catalog/lists/size
-		 */
-		$defaultSize = $this->getContext()->getConfig()->get( 'client/html/account/watch/size', 48 );
-
-		$size = (int) $view->param( 'watch-size', $defaultSize );
-		return ( $size < 1 || $size > 100 ? $defaultSize : $size );
-	}
-
-
-	/**
-	 * 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
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$total = 0;
-			$productIds = array();
-			$context = $this->getContext();
-			$typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'watch' );
-
-			$size = $this->getProductListSize( $view );
-			$current = $this->getProductListPage( $view );
-			$last = ( $total != 0 ? ceil( $total / $size ) : 1 );
-
-
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
-
-			$search = $manager->createSearch();
-			$expr = array(
-				$search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
-				$search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
-				$search->compare( '==', 'customer.lists.domain', 'product' ),
-			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( array( $search->sort( '-', 'customer.lists.position' ) ) );
-			$search->setSlice( ( $current - 1 ) * $size, $size );
-
-			$view->watchListItems = $manager->searchItems( $search, array(), $total );
-
-
-			/** client/html/account/watch/domains
-			 * A list of domain names whose items should be available in the account watch view template
-			 *
-			 * The templates rendering product details usually add the images,
-			 * prices and texts associated to the product item. If you want to
-			 * display additional or less content, you can configure your own
-			 * list of domains (attribute, media, price, product, text, etc. are
-			 * domains) whose items are fetched from the storage. Please keep
-			 * in mind that the more domains you add to the configuration, the
-			 * more time is required for fetching the content!
-			 *
-			 * @param array List of domain names
-			 * @since 2014.09
-			 * @category Developer
-			 * @see client/html/catalog/domains
-			 */
-			$default = array( 'text', 'price', 'media' );
-			$domains = $context->getConfig()->get( 'client/html/account/watch/domains', $default );
-
-			foreach( $view->watchListItems as $listItem ) {
-				$productIds[] = $listItem->getRefId();
-			}
-
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-			$view->watchProductItems = $controller->getProductItems( $productIds, $domains );
-			$view->watchPageFirst = 1;
-			$view->watchPagePrev = ( $current > 1 ? $current - 1 : 1 );
-			$view->watchPageNext = ( $current < $last ? $current + 1 : $last );
-			$view->watchPageLast = $last;
-			$view->watchPageCurr = $current;
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/account/watch/standard/subparts
+     * List of HTML sub-clients rendered within the account watch 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/account/watch/standard/subparts';
+    private $subPartNames = array();
+    private $cache;
+
+
+    /**
+     * 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
+     * @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 string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
+
+        try
+        {
+            $view = $this->setViewParams( $view, $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->watchBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+        }
+        catch( \Exception $e )
+        {
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+        }
+
+        /** client/html/account/watch/standard/template-body
+         * Relative path to the HTML body template of the account watch 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/account/watch/standard/template-header
+         */
+        $tplconf = 'client/html/account/watch/standard/template-body';
+        $default = 'account/watch/body-default.php';
+
+        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
+     * @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 string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->watchHeader = $html;
+
+            /** client/html/account/watch/standard/template-header
+             * Relative path to the HTML header template of the account watch client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the HTML code that is inserted into the HTML page header
+             * of the rendered page in 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 head
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/account/watch/standard/template-body
+             */
+            $tplconf = 'client/html/account/watch/standard/template-header';
+            $default = 'account/watch/header-default.php';
+
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
+
+
+    /**
+     * 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( $type, $name = null )
+    {
+        /** client/html/account/watch/decorators/excludes
+         * Excludes decorators added by the "common" option from the account watch 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/account/watch/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 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/account/watch/decorators/global
+         * @see client/html/account/watch/decorators/local
+         */
+
+        /** client/html/account/watch/decorators/global
+         * Adds a list of globally available decorators only to the account watch 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/account/watch/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 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/account/watch/decorators/excludes
+         * @see client/html/account/watch/decorators/local
+         */
+
+        /** client/html/account/watch/decorators/local
+         * Adds a list of local decorators only to the account watch 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\Account\Decorator\*") around the html client.
+         *
+         *  client/html/account/watch/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/account/watch/decorators/excludes
+         * @see client/html/account/watch/decorators/global
+         */
+
+        return $this->createSubClient( 'account/watch/' . $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()
+    {
+        $view = $this->getView();
+        $context = $this->getContext();
+        $userId = $context->getUserId();
+        $ids = (array) $view->param( 'wat_id', array() );
+
+        if( $userId != null && !empty( $ids ) )
+        {
+            $typeId = $this->getTypeItem( 'customer/lists/type', 'product', 'watch' )->getId();
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+            $items = $this->getListItems( $manager, $ids, $typeId, $userId );
+
+            switch( $view->param( 'wat_action' ) )
+            {
+                case 'add':
+
+                    /** client/html/account/watch/standard/maxitems
+                     * Maximum number of products that can be watched in parallel
+                     *
+                     * This option limits the number of products that can be watched
+                     * after the users added the products to their watch list.
+                     * It must be a positive integer value greater than 0.
+                     *
+                     * Note: It's recommended to set this value not too high as this
+                     * leads to a high memory consumption when the e-mails are generated
+                     * to notify the customers. The memory used will up to 100*maxitems
+                     * of the footprint of one product item including the associated
+                     * texts, prices and media.
+                     *
+                     * @param integer Number of products
+                     * @since 2014.09
+                     * @category User
+                     * @category Developer
+                     */
+                    $max = $context->getConfig()->get( 'client/html/account/watch/standard/maxitems', 100 );
+                    $cnt = count( $ids );
+
+                    if( $this->checkLimit( $manager, $typeId, $userId, $max, $cnt ) === false )
+                    {
+                        $error = sprintf( $context->getI18n()->dt( 'client', 'You can only watch up to %1$s products' ), $max );
+                        $view->watchErrorList = $view->get( 'watchErrorList', array() ) + array( $error );
+                        break;
+                    }
+
+                    $this->addItems( $manager, $items, $ids, $typeId, $userId );
+                    break;
+
+                case 'edit':
+
+                    $config = array(
+                        'timeframe' => $view->param( 'wat_timeframe', 7 ),
+                        'pricevalue' => $view->param( 'wat_pricevalue', '0.00' ),
+                        'price' => $view->param( 'wat_price', 0 ),
+                        'stock' => $view->param( 'wat_stock', 0 ),
+                        'currency' => $context->getLocale()->getCurrencyId(),
+                    );
+                    $this->editItems( $manager, $items, $ids, $config );
+                    break;
+
+                case 'delete':
+
+                    $this->deleteItems( $manager, $items, $ids );
+                    break;
+            }
+        }
+
+        parent::process();
+    }
+
+
+    /**
+     * Tests if the maximum number of entries per user is already reached
+     *
+     * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
+     * @param string $typeId List type ID of the referenced items
+     * @param string $userId Unique user ID
+     * @param integer $max Maximum number of items that are allowed
+     * @param integer $cnt Number of items that should be added
+     * @return boolean True if items can be added, false if not
+     */
+    protected function checkLimit( \Aimeos\MShop\Common\Manager\Iface $manager, $typeId, $userId, $max, $cnt )
+    {
+        $search = $manager->createSearch();
+        $expr = array(
+            $search->compare( '==', 'customer.lists.parentid', $userId ),
+            $search->compare( '==', 'customer.lists.typeid', $typeId ),
+            $search->compare( '==', 'customer.lists.domain', 'product' ),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+        $search->setSlice( 0, 0 );
+
+        $total = 0;
+        $manager->searchItems( $search, array(), $total );
+
+        if( $total + $cnt > $max ) {
+            return false;
+        }
+
+        return true;
+    }
+
+
+    /**
+     * Adds one or more list items to the given user
+     *
+     * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
+     * @param array $listItems Associative list of the reference IDs as keys and the list items as values
+     * @param array $ids List of referenced IDs
+     * @param string $typeId List type ID of the referenced items
+     * @param string $userId Unique user ID
+     */
+    protected function addItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, $typeId, $userId )
+    {
+        $item = $manager->createItem();
+        $item->setParentId( $userId );
+        $item->setTypeId( $typeId );
+        $item->setDomain( 'product' );
+        $item->setStatus( 1 );
+
+        foreach( $ids as $id )
+        {
+            if( !isset( $listItems[$id] ) )
+            {
+                $item->setId( null );
+                $item->setRefId( $id );
+
+                $manager->saveItem( $item );
+                $manager->moveItem( $item->getId() );
+            }
+        }
+    }
+
+
+    /**
+     * Removes the list items for the given reference IDs
+     *
+     * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
+     * @param array $listItems Associative list of the reference IDs as keys and the list items as values
+     * @param array $ids List of referenced IDs
+     */
+    protected function deleteItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids )
+    {
+        $listIds = array();
+
+        foreach( $ids as $id )
+        {
+            if( isset( $listItems[$id] ) ) {
+                $listIds[] = $listItems[$id]->getId();
+            }
+        }
+
+        $manager->deleteItems( $listIds );
+    }
+
+
+    /**
+     * Updates the list items for the given reference IDs
+     *
+     * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
+     * @param array $listItems Associative list of the reference IDs as keys and the list items as values
+     * @param array $ids List of referenced IDs
+     * @param array $config Configuration settins with "timeframe", "pricevalue", "price", "stock" and "currency"
+     */
+    protected function editItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, array $config )
+    {
+        foreach( $ids as $id )
+        {
+            if( isset( $listItems[$id] ) )
+            {
+                $item = $listItems[$id];
+                $time = time() + ( $config['timeframe'] + 1 ) * 86400;
+
+                $item->setDateEnd( date( 'Y-m-d 00:00:00', $time ) );
+                $item->setConfig( $config );
+
+                $manager->saveItem( $item );
+            }
+        }
+    }
+
+
+    /**
+     * Returns the list items associated to the given user ID
+     *
+     * @param \Aimeos\MShop\Common\Manager\Iface $manager Customer list manager
+     * @param array $refIds IDs of the referenced items
+     * @param string $typeId List type ID of the referenced items
+     * @param string $userId Unique user ID
+     * @return array Associative list of the reference IDs as keys and the list items as values
+     */
+    protected function getListItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $refIds, $typeId, $userId )
+    {
+        $search = $manager->createSearch();
+        $expr = array(
+            $search->compare( '==', 'customer.lists.parentid', $userId ),
+            $search->compare( '==', 'customer.lists.refid', $refIds ),
+            $search->compare( '==', 'customer.lists.domain', 'product' ),
+            $search->compare( '==', 'customer.lists.typeid', $typeId ),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+
+        $items = array();
+        foreach( $manager->searchItems( $search ) as $item ) {
+            $items[$item->getRefId()] = $item;
+        }
+
+        return $items;
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Returns the sanitized page from the parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return integer Page number starting from 1
+     */
+    protected function getProductListPage( \Aimeos\MW\View\Iface $view )
+    {
+        $page = (int) $view->param( 'wat_page', 1 );
+        return ( $page < 1 ? 1 : $page );
+    }
+
+
+    /**
+     * Returns the sanitized page size from the parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return integer Page size
+     */
+    protected function getProductListSize( \Aimeos\MW\View\Iface $view )
+    {
+        /** client/html/account/watch/size
+         * The number of products shown in a list page for watch products
+         *
+         * Limits the number of products that is shown in the list pages to the
+         * given value. If more products are available, the products are split
+         * into bunches which will be shown on their own list page. The user is
+         * able to move to the next page (or previous one if it's not the first)
+         * to display the next (or previous) products.
+         *
+         * The value must be an integer number from 1 to 100. Negative values as
+         * well as values above 100 are not allowed. The value can be overwritten
+         * per request if the "l_size" parameter is part of the URL.
+         *
+         * @param integer Number of products
+         * @since 2014.09
+         * @category User
+         * @category Developer
+         * @see client/html/catalog/lists/size
+         */
+        $defaultSize = $this->getContext()->getConfig()->get( 'client/html/account/watch/size', 48 );
+
+        $size = (int) $view->param( 'watch-size', $defaultSize );
+        return ( $size < 1 || $size > 100 ? $defaultSize : $size );
+    }
+
+
+    /**
+     * 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
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $total = 0;
+            $productIds = array();
+            $context = $this->getContext();
+            $typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'watch' );
+
+            $size = $this->getProductListSize( $view );
+            $current = $this->getProductListPage( $view );
+            $last = ( $total != 0 ? ceil( $total / $size ) : 1 );
+
+
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+
+            $search = $manager->createSearch();
+            $expr = array(
+                $search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
+                $search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
+                $search->compare( '==', 'customer.lists.domain', 'product' ),
+            );
+            $search->setConditions( $search->combine( '&&', $expr ) );
+            $search->setSortations( array( $search->sort( '-', 'customer.lists.position' ) ) );
+            $search->setSlice( ( $current - 1 ) * $size, $size );
+
+            $view->watchListItems = $manager->searchItems( $search, array(), $total );
+
+
+            /** client/html/account/watch/domains
+             * A list of domain names whose items should be available in the account watch view template
+             *
+             * The templates rendering product details usually add the images,
+             * prices and texts associated to the product item. If you want to
+             * display additional or less content, you can configure your own
+             * list of domains (attribute, media, price, product, text, etc. are
+             * domains) whose items are fetched from the storage. Please keep
+             * in mind that the more domains you add to the configuration, the
+             * more time is required for fetching the content!
+             *
+             * @param array List of domain names
+             * @since 2014.09
+             * @category Developer
+             * @see client/html/catalog/domains
+             */
+            $default = array( 'text', 'price', 'media' );
+            $domains = $context->getConfig()->get( 'client/html/account/watch/domains', $default );
+
+            foreach( $view->watchListItems as $listItem ) {
+                $productIds[] = $listItem->getRefId();
+            }
+
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+            $view->watchProductItems = $controller->getProductItems( $productIds, $domains );
+            $view->watchPageFirst = 1;
+            $view->watchPagePrev = ( $current > 1 ? $current - 1 : 1 );
+            $view->watchPageNext = ( $current < $last ? $current + 1 : $last );
+            $view->watchPageLast = $last;
+            $view->watchPageCurr = $current;
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +111 added lines, -111 removed lines

@@ -68,42 +68,42 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
 		$context = $this->getContext();
 		$view = $this->getView();
 
 		try
 		{
-			$view = $this->setViewParams( $view, $tags, $expire );
+			$view = $this->setViewParams($view, $tags, $expire);
 
 			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+			foreach ($this->getSubClients() as $subclient) {
+				$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 			}
 			$view->watchBody = $html;
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
+			$view->watchErrorList = $view->get('watchErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->watchErrorList = $view->get('watchErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
+			$view->watchErrorList = $view->get('watchErrorList', array()) + $error;
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->watchErrorList = $view->get( 'watchErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->watchErrorList = $view->get('watchErrorList', array()) + $error;
 		}
 
 		/** client/html/account/watch/standard/template-body
@@ -129,7 +129,7 @@ 
 		$tplconf = 'client/html/account/watch/standard/template-body';
 		$default = 'account/watch/body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -141,15 +141,15 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
 		try
 		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
+			$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+			foreach ($this->getSubClients() as $subclient) {
+				$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 			}
 			$view->watchHeader = $html;
 
@@ -177,11 +177,11 @@ 
 			$tplconf = 'client/html/account/watch/standard/template-header';
 			$default = 'account/watch/header-default.php';
 
-			return $view->render( $view->config( $tplconf, $default ) );
+			return $view->render($view->config($tplconf, $default));
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+			$this->getContext()->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 		}
 	}
 
@@ -193,7 +193,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/account/watch/decorators/excludes
 		 * Excludes decorators added by the "common" option from the account watch html client
@@ -269,7 +269,7 @@ 
 		 * @see client/html/account/watch/decorators/global
 		 */
 
-		return $this->createSubClient( 'account/watch/' . $type, $name );
+		return $this->createSubClient('account/watch/'.$type, $name);
 	}
 
 
@@ -283,15 +283,15 @@ 
 		$view = $this->getView();
 		$context = $this->getContext();
 		$userId = $context->getUserId();
-		$ids = (array) $view->param( 'wat_id', array() );
+		$ids = (array) $view->param('wat_id', array());
 
-		if( $userId != null && !empty( $ids ) )
+		if ($userId != null && !empty($ids))
 		{
-			$typeId = $this->getTypeItem( 'customer/lists/type', 'product', 'watch' )->getId();
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
-			$items = $this->getListItems( $manager, $ids, $typeId, $userId );
+			$typeId = $this->getTypeItem('customer/lists/type', 'product', 'watch')->getId();
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'customer/lists');
+			$items = $this->getListItems($manager, $ids, $typeId, $userId);
 
-			switch( $view->param( 'wat_action' ) )
+			switch ($view->param('wat_action'))
 			{
 				case 'add':
 
@@ -313,34 +313,34 @@ 
 					 * @category User
 					 * @category Developer
 					 */
-					$max = $context->getConfig()->get( 'client/html/account/watch/standard/maxitems', 100 );
-					$cnt = count( $ids );
+					$max = $context->getConfig()->get('client/html/account/watch/standard/maxitems', 100);
+					$cnt = count($ids);
 
-					if( $this->checkLimit( $manager, $typeId, $userId, $max, $cnt ) === false )
+					if ($this->checkLimit($manager, $typeId, $userId, $max, $cnt) === false)
 					{
-						$error = sprintf( $context->getI18n()->dt( 'client', 'You can only watch up to %1$s products' ), $max );
-						$view->watchErrorList = $view->get( 'watchErrorList', array() ) + array( $error );
+						$error = sprintf($context->getI18n()->dt('client', 'You can only watch up to %1$s products'), $max);
+						$view->watchErrorList = $view->get('watchErrorList', array()) + array($error);
 						break;
 					}
 
-					$this->addItems( $manager, $items, $ids, $typeId, $userId );
+					$this->addItems($manager, $items, $ids, $typeId, $userId);
 					break;
 
 				case 'edit':
 
 					$config = array(
-						'timeframe' => $view->param( 'wat_timeframe', 7 ),
-						'pricevalue' => $view->param( 'wat_pricevalue', '0.00' ),
-						'price' => $view->param( 'wat_price', 0 ),
-						'stock' => $view->param( 'wat_stock', 0 ),
+						'timeframe' => $view->param('wat_timeframe', 7),
+						'pricevalue' => $view->param('wat_pricevalue', '0.00'),
+						'price' => $view->param('wat_price', 0),
+						'stock' => $view->param('wat_stock', 0),
 						'currency' => $context->getLocale()->getCurrencyId(),
 					);
-					$this->editItems( $manager, $items, $ids, $config );
+					$this->editItems($manager, $items, $ids, $config);
 					break;
 
 				case 'delete':
 
-					$this->deleteItems( $manager, $items, $ids );
+					$this->deleteItems($manager, $items, $ids);
 					break;
 			}
 		}
@@ -359,21 +359,21 @@ 
 	 * @param integer $cnt Number of items that should be added
 	 * @return boolean True if items can be added, false if not
 	 */
-	protected function checkLimit( \Aimeos\MShop\Common\Manager\Iface $manager, $typeId, $userId, $max, $cnt )
+	protected function checkLimit(\Aimeos\MShop\Common\Manager\Iface $manager, $typeId, $userId, $max, $cnt)
 	{
 		$search = $manager->createSearch();
 		$expr = array(
-			$search->compare( '==', 'customer.lists.parentid', $userId ),
-			$search->compare( '==', 'customer.lists.typeid', $typeId ),
-			$search->compare( '==', 'customer.lists.domain', 'product' ),
+			$search->compare('==', 'customer.lists.parentid', $userId),
+			$search->compare('==', 'customer.lists.typeid', $typeId),
+			$search->compare('==', 'customer.lists.domain', 'product'),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSlice( 0, 0 );
+		$search->setConditions($search->combine('&&', $expr));
+		$search->setSlice(0, 0);
 
 		$total = 0;
-		$manager->searchItems( $search, array(), $total );
+		$manager->searchItems($search, array(), $total);
 
-		if( $total + $cnt > $max ) {
+		if ($total + $cnt > $max) {
 			return false;
 		}
 
@@ -390,23 +390,23 @@ 
 	 * @param string $typeId List type ID of the referenced items
 	 * @param string $userId Unique user ID
 	 */
-	protected function addItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, $typeId, $userId )
+	protected function addItems(\Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, $typeId, $userId)
 	{
 		$item = $manager->createItem();
-		$item->setParentId( $userId );
-		$item->setTypeId( $typeId );
-		$item->setDomain( 'product' );
-		$item->setStatus( 1 );
+		$item->setParentId($userId);
+		$item->setTypeId($typeId);
+		$item->setDomain('product');
+		$item->setStatus(1);
 
-		foreach( $ids as $id )
+		foreach ($ids as $id)
 		{
-			if( !isset( $listItems[$id] ) )
+			if (!isset($listItems[$id]))
 			{
-				$item->setId( null );
-				$item->setRefId( $id );
+				$item->setId(null);
+				$item->setRefId($id);
 
-				$manager->saveItem( $item );
-				$manager->moveItem( $item->getId() );
+				$manager->saveItem($item);
+				$manager->moveItem($item->getId());
 			}
 		}
 	}
@@ -419,18 +419,18 @@ 
 	 * @param array $listItems Associative list of the reference IDs as keys and the list items as values
 	 * @param array $ids List of referenced IDs
 	 */
-	protected function deleteItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids )
+	protected function deleteItems(\Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids)
 	{
 		$listIds = array();
 
-		foreach( $ids as $id )
+		foreach ($ids as $id)
 		{
-			if( isset( $listItems[$id] ) ) {
+			if (isset($listItems[$id])) {
 				$listIds[] = $listItems[$id]->getId();
 			}
 		}
 
-		$manager->deleteItems( $listIds );
+		$manager->deleteItems($listIds);
 	}
 
 
@@ -442,19 +442,19 @@ 
 	 * @param array $ids List of referenced IDs
 	 * @param array $config Configuration settins with "timeframe", "pricevalue", "price", "stock" and "currency"
 	 */
-	protected function editItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, array $config )
+	protected function editItems(\Aimeos\MShop\Common\Manager\Iface $manager, array $listItems, array $ids, array $config)
 	{
-		foreach( $ids as $id )
+		foreach ($ids as $id)
 		{
-			if( isset( $listItems[$id] ) )
+			if (isset($listItems[$id]))
 			{
 				$item = $listItems[$id];
-				$time = time() + ( $config['timeframe'] + 1 ) * 86400;
+				$time = time() + ($config['timeframe'] + 1) * 86400;
 
-				$item->setDateEnd( date( 'Y-m-d 00:00:00', $time ) );
-				$item->setConfig( $config );
+				$item->setDateEnd(date('Y-m-d 00:00:00', $time));
+				$item->setConfig($config);
 
-				$manager->saveItem( $item );
+				$manager->saveItem($item);
 			}
 		}
 	}
@@ -469,19 +469,19 @@ 
 	 * @param string $userId Unique user ID
 	 * @return array Associative list of the reference IDs as keys and the list items as values
 	 */
-	protected function getListItems( \Aimeos\MShop\Common\Manager\Iface $manager, array $refIds, $typeId, $userId )
+	protected function getListItems(\Aimeos\MShop\Common\Manager\Iface $manager, array $refIds, $typeId, $userId)
 	{
 		$search = $manager->createSearch();
 		$expr = array(
-			$search->compare( '==', 'customer.lists.parentid', $userId ),
-			$search->compare( '==', 'customer.lists.refid', $refIds ),
-			$search->compare( '==', 'customer.lists.domain', 'product' ),
-			$search->compare( '==', 'customer.lists.typeid', $typeId ),
+			$search->compare('==', 'customer.lists.parentid', $userId),
+			$search->compare('==', 'customer.lists.refid', $refIds),
+			$search->compare('==', 'customer.lists.domain', 'product'),
+			$search->compare('==', 'customer.lists.typeid', $typeId),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
+		$search->setConditions($search->combine('&&', $expr));
 
 		$items = array();
-		foreach( $manager->searchItems( $search ) as $item ) {
+		foreach ($manager->searchItems($search) as $item) {
 			$items[$item->getRefId()] = $item;
 		}
 
@@ -496,7 +496,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -506,10 +506,10 @@ 
 	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
 	 * @return integer Page number starting from 1
 	 */
-	protected function getProductListPage( \Aimeos\MW\View\Iface $view )
+	protected function getProductListPage(\Aimeos\MW\View\Iface $view)
 	{
-		$page = (int) $view->param( 'wat_page', 1 );
-		return ( $page < 1 ? 1 : $page );
+		$page = (int) $view->param('wat_page', 1);
+		return ($page < 1 ? 1 : $page);
 	}
 
 
@@ -519,7 +519,7 @@ 
 	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
 	 * @return integer Page size
 	 */
-	protected function getProductListSize( \Aimeos\MW\View\Iface $view )
+	protected function getProductListSize(\Aimeos\MW\View\Iface $view)
 	{
 		/** client/html/account/watch/size
 		 * The number of products shown in a list page for watch products
@@ -540,10 +540,10 @@ 
 		 * @category Developer
 		 * @see client/html/catalog/lists/size
 		 */
-		$defaultSize = $this->getContext()->getConfig()->get( 'client/html/account/watch/size', 48 );
+		$defaultSize = $this->getContext()->getConfig()->get('client/html/account/watch/size', 48);
 
-		$size = (int) $view->param( 'watch-size', $defaultSize );
-		return ( $size < 1 || $size > 100 ? $defaultSize : $size );
+		$size = (int) $view->param('watch-size', $defaultSize);
+		return ($size < 1 || $size > 100 ? $defaultSize : $size);
 	}
 
 
@@ -555,33 +555,33 @@ 
 	 * @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
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$total = 0;
 			$productIds = array();
 			$context = $this->getContext();
-			$typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'watch' );
+			$typeItem = $this->getTypeItem('customer/lists/type', 'product', 'watch');
 
-			$size = $this->getProductListSize( $view );
-			$current = $this->getProductListPage( $view );
-			$last = ( $total != 0 ? ceil( $total / $size ) : 1 );
+			$size = $this->getProductListSize($view);
+			$current = $this->getProductListPage($view);
+			$last = ($total != 0 ? ceil($total / $size) : 1);
 
 
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'customer/lists');
 
 			$search = $manager->createSearch();
 			$expr = array(
-				$search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
-				$search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
-				$search->compare( '==', 'customer.lists.domain', 'product' ),
+				$search->compare('==', 'customer.lists.parentid', $context->getUserId()),
+				$search->compare('==', 'customer.lists.typeid', $typeItem->getId()),
+				$search->compare('==', 'customer.lists.domain', 'product'),
 			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( array( $search->sort( '-', 'customer.lists.position' ) ) );
-			$search->setSlice( ( $current - 1 ) * $size, $size );
+			$search->setConditions($search->combine('&&', $expr));
+			$search->setSortations(array($search->sort('-', 'customer.lists.position')));
+			$search->setSlice(($current - 1) * $size, $size);
 
-			$view->watchListItems = $manager->searchItems( $search, array(), $total );
+			$view->watchListItems = $manager->searchItems($search, array(), $total);
 
 
 			/** client/html/account/watch/domains
@@ -600,19 +600,19 @@ 
 			 * @category Developer
 			 * @see client/html/catalog/domains
 			 */
-			$default = array( 'text', 'price', 'media' );
-			$domains = $context->getConfig()->get( 'client/html/account/watch/domains', $default );
+			$default = array('text', 'price', 'media');
+			$domains = $context->getConfig()->get('client/html/account/watch/domains', $default);
 
-			foreach( $view->watchListItems as $listItem ) {
+			foreach ($view->watchListItems as $listItem) {
 				$productIds[] = $listItem->getRefId();
 			}
 
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+			$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
 
-			$view->watchProductItems = $controller->getProductItems( $productIds, $domains );
+			$view->watchProductItems = $controller->getProductItems($productIds, $domains);
 			$view->watchPageFirst = 1;
-			$view->watchPagePrev = ( $current > 1 ? $current - 1 : 1 );
-			$view->watchPageNext = ( $current < $last ? $current + 1 : $last );
+			$view->watchPagePrev = ($current > 1 ? $current - 1 : 1);
+			$view->watchPageNext = ($current < $last ? $current + 1 : $last);
 			$view->watchPageLast = $last;
 			$view->watchPageCurr = $current;
 

client/html/src/Client/Html/Base.php

Indentation +674 added lines, -674 removed lines

@@ -19,679 +19,679 @@
  * @subpackage Html
  */
 abstract class Base
-	implements \Aimeos\Client\Html\Iface
+    implements \Aimeos\Client\Html\Iface
 {
-	private $view;
-	private $cache;
-	private $context;
-	private $subclients;
-	private $templatePaths;
-
-
-	/**
-	 * Initializes the class instance.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object
-	 * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
-	 * 	and a list of relative paths inside the core or the extension as values
-	 */
-	public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
-	{
-		$this->context = $context;
-		$this->templatePaths = $templatePaths;
-	}
-
-
-	/**
-	 * Returns the view object that will generate the HTML output.
-	 *
-	 * @return \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 */
-	public function getView()
-	{
-		if( !isset( $this->view ) ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'No view available' ) );
-		}
-
-		return $this->view;
-	}
-
-
-	/**
-	 * Modifies the cached body content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified body content
-	 */
-	public function modifyBody( $content, $uid )
-	{
-		$view = $this->getView();
-
-		foreach( $this->getSubClients() as $subclient )
-		{
-			$subclient->setView( $view );
-			$content = $subclient->modifyBody( $content, $uid );
-		}
-
-		return $content;
-	}
-
-
-	/**
-	 * Modifies the cached header content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified header content
-	 */
-	public function modifyHeader( $content, $uid )
-	{
-		$view = $this->getView();
-
-		foreach( $this->getSubClients() as $subclient )
-		{
-			$subclient->setView( $view );
-			$content = $subclient->modifyHeader( $content, $uid );
-		}
-
-		return $content;
-	}
-
-
-	/**
-	 * 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.
-	 *
-	 * @return boolean False if processing is stopped, otherwise all processing was completed successfully
-	 */
-	public function process()
-	{
-		$view = $this->getView();
-
-		foreach( $this->getSubClients() as $subclient )
-		{
-			$subclient->setView( $view );
-
-			if( $subclient->process() === false ) {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-
-	/**
-	 * Sets the view object that will generate the HTML output.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @return \Aimeos\Client\Html\Iface Reference to this object for fluent calls
-	 */
-	public function setView( \Aimeos\MW\View\Iface $view )
-	{
-		$this->view = $view;
-		return $this;
-	}
-
-
-	/**
-	 * Adds the decorators to the client object
-	 *
-	 * @param \Aimeos\Client\Html\Iface $client Client object
-	 * @param array $templatePaths List of file system paths where the templates are stored
-	 * @param array $decorators List of decorator name that should be wrapped around the client
-	 * @param string $classprefix Decorator class prefix, e.g. "\Aimeos\Client\Html\Catalog\Decorator\"
-	 * @return \Aimeos\Client\Html\Iface Client object
-	 */
-	protected function addDecorators( \Aimeos\Client\Html\Iface $client, array $templatePaths,
-		array $decorators, $classprefix )
-	{
-		$iface = '\\Aimeos\\Client\\Html\\Common\\Decorator\\Iface';
-
-		foreach( $decorators as $name )
-		{
-			if( ctype_alnum( $name ) === false )
-			{
-				$classname = is_string( $name ) ? $classprefix . $name : '<not a string>';
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid class name "%1$s"', $classname ) );
-			}
-
-			$classname = $classprefix . $name;
-
-			if( class_exists( $classname ) === false ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not found', $classname ) );
-			}
-
-			$client = new $classname( $client, $this->context, $this->templatePaths );
-
-			if( !( $client instanceof $iface ) ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement "%2$s"', $classname, $iface ) );
-			}
-		}
-
-		return $client;
-	}
-
-
-	/**
-	 * Adds the decorators to the client object
-	 *
-	 * @param \Aimeos\Client\Html\Iface $client Client object
-	 * @param array $templatePaths List of file system paths where the templates are stored
-	 * @param string $path Client string in lower case, e.g. "catalog/detail/basic"
-	 * @return \Aimeos\Client\Html\Iface Client object
-	 */
-	protected function addClientDecorators( \Aimeos\Client\Html\Iface $client, array $templatePaths, $path )
-	{
-		if( !is_string( $path ) || $path === '' ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid domain "%1$s"', $path ) );
-		}
-
-		$localClass = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
-		$config = $this->context->getConfig();
-
-		$decorators = $config->get( 'client/html/common/decorators/default', array() );
-		$excludes = $config->get( 'client/html/' . $path . '/decorators/excludes', array() );
-
-		foreach( $decorators as $key => $name )
-		{
-			if( in_array( $name, $excludes ) ) {
-				unset( $decorators[$key] );
-			}
-		}
-
-		$classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
-		$client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
-
-		$classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
-		$decorators = $config->get( 'client/html/' . $path . '/decorators/global', array() );
-		$client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
-
-		$classprefix = '\\Aimeos\\Client\\Html\\' . $localClass . '\\Decorator\\';
-		$decorators = $config->get( 'client/html/' . $path . '/decorators/local', array() );
-		$client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
-
-		return $client;
-	}
-
-
-	/**
-	 * Adds the cache tags to the given list and sets a new expiration date if necessary based on the given item.
-	 *
-	 * @param array|\Aimeos\MShop\Common\Item\Iface $items Item or list of items, maybe with associated list items
-	 * @param string $domain Name of the domain the item is from
-	 * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
-	 * @param array &$tags List of tags the new tags will be added to
-	 */
-	protected function addMetaItem( $items, $domain, &$expire, array &$tags )
-	{
-		/** client/html/common/cache/tag-all
-		 * Adds tags for all items used in a cache entry
-		 *
-		 * Each cache entry storing rendered parts for the HTML header or body
-		 * can be tagged with information which items like texts, media, etc.
-		 * are used in the HTML. This allows removing only those cache entries
-		 * whose content has really changed and only that entries have to be
-		 * rebuild the next time.
-		 *
-		 * The standard behavior stores only tags for each used domain, e.g. if
-		 * a text is used, only the tag "text" is added. If you change a text
-		 * in the administration interface, all cache entries with the tag
-		 * "text" will be removed from the cache. This effectively wipes out
-		 * almost all cached entries, which have to be rebuild with the next
-		 * request.
-		 *
-		 * Important: As a list or detail view can use several hundred items,
-		 * this configuration option will also add this number of tags to the
-		 * cache entry. When using a cache adapter that can't insert all tags
-		 * at once, this slows down the initial cache insert (and therefore the
-		 * page speed) drastically! It's only recommended to enable this option
-		 * if you use the DB, Mysql or Redis adapter that can insert all tags
-		 * at once.
-		 *
-		 * @param boolean True to add tags for all items, false to use only a domain tag
-		 * @since 2014.07
-		 * @category Developer
-		 * @category User
-		 * @see client/html/common/cache/force
-		 * @see madmin/cache/manager/name
-		 * @see madmin/cache/name
-		 */
-		$tagAll = $this->context->getConfig()->get( 'client/html/common/cache/tag-all', false );
-
-		if( !is_array( $items ) ) {
-			$items = array( $items );
-		}
-
-		if( $tagAll !== true && !empty( $items ) ) {
-			$tags[] = $domain;
-		}
-
-		foreach( $items as $item ) {
-			$this->addMetaItemSingle( $item, $domain, $expire, $tags, $tagAll );
-		}
-	}
-
-
-	/**
-	 * Adds expire date and tags for a single item.
-	 *
-	 * @param \Aimeos\MShop\Common\Item\Iface $item Item, maybe with associated list items
-	 * @param string $domain Name of the domain the item is from
-	 * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
-	 * @param array &$tags List of tags the new tags will be added to
-	 * @param boolean $tagAll True of tags for all items should be added, false if only for the main item
-	 */
-	private function addMetaItemSingle( \Aimeos\MShop\Common\Item\Iface $item, $domain, &$expire, array &$tags, $tagAll )
-	{
-		$expires = array();
-		$domain = str_replace( '/', '_', $domain ); // maximum compatiblity
-
-		if( $tagAll === true ) {
-			$tags[] = $domain . '-' . $item->getId();
-		}
-
-		if( $item instanceof \Aimeos\MShop\Common\Item\Time\Iface && ( $date = $item->getDateEnd() ) !== null ) {
-			$expires[] = $date;
-		}
-
-		if( $item instanceof \Aimeos\MShop\Common\Item\ListRef\Iface ) {
-			$this->addMetaItemRef( $item, $expires, $tags, $tagAll );
-		}
-
-		if( !empty( $expires ) ) {
-			$expire = min( $expires );
-		}
-	}
-
-
-	/**
-	 * Adds expire date and tags for referenced items
-	 *
-	 * @param \Aimeos\MShop\Common\Item\ListRef\Iface $item Item with associated list items
-	 * @param array &$expire Expiration date that will be overwritten if an earlier date is found
-	 * @param array &$tags List of tags the new tags will be added to
-	 * @param boolean $tagAll True of tags for all items should be added, false if only for the main item
-	 */
-	private function addMetaItemRef( \Aimeos\MShop\Common\Item\ListRef\Iface $item, array &$expires, array &$tags, $tagAll )
-	{
-		foreach( $item->getListItems() as $listitem )
-		{
-			if( $tagAll === true ) {
-				$tags[] = str_replace( '/', '_', $listitem->getDomain() ) . '-' . $listitem->getRefId();
-			}
-
-			if( ( $date = $listitem->getDateEnd() ) !== null ) {
-				$expires[] = $date;
-			}
-		}
-	}
-
-
-	/**
-	 * Adds a new expiration date if a list item is activated in the future.
-	 *
-	 * @param array|string $ids Item ID or list of item IDs from the given domain
-	 * @param string $domain Name of the domain the item IDs are from
-	 * @param string|null &$expire Expiration date that will be overwritten if an start date in the future is available
-	 */
-	protected function addMetaList( $ids, $domain, &$expire )
-	{
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), $domain . '/lists' );
-
-		$search = $manager->createSearch();
-		$expr = array(
-			$search->compare( '==', $domain . '.lists.parentid', $ids ),
-			$search->compare( '>', $domain . '.lists.datestart', date( 'Y-m-d H:i:00' ) ),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSortations( array( $search->sort( '+', $domain . '.lists.datestart' ) ) );
-		$search->setSlice( 0, 1 );
-
-		foreach( $manager->searchItems( $search ) as $listItem ) {
-			$expire = $this->expires( $expire, $listItem->getDateStart() );
-		}
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $path Name of the sub-part in lower case (can contain a path like catalog/filter/tree)
-	 * @param string|null $name Name of the implementation, will be from configuration (or Default) if null
-	 * @return \Aimeos\Client\Html\Iface Sub-part object
-	 */
-	protected function createSubClient( $path, $name )
-	{
-		$path = strtolower( $path );
-
-		if( $name === null ) {
-			$name = $this->context->getConfig()->get( 'client/html/' . $path . '/name', 'Standard' );
-		}
-
-		if( empty( $name ) || ctype_alnum( $name ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s"', $name ) );
-		}
-
-		$subnames = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
-
-		$classname = '\\Aimeos\\Client\\Html\\' . $subnames . '\\' . $name;
-		$interface = '\\Aimeos\\Client\\Html\\Iface';
-
-		if( class_exists( $classname ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $classname ) );
-		}
-
-		$object = new $classname( $this->context, $this->templatePaths );
-
-		if( ( $object instanceof $interface ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement interface "%2$s"', $classname, $interface ) );
-		}
-
-		return $this->addClientDecorators( $object, $this->templatePaths, $path );
-	}
-
-
-	/**
-	 * Returns the minimal expiration date.
-	 *
-	 * @param string|null $first First expiration date or null
-	 * @param string|null $second Second expiration date or null
-	 * @return string|null Expiration date
-	 */
-	protected function expires( $first, $second )
-	{
-		return ( $first !== null ? ( $second !== null ? min( $first, $second ) : $first ) : $second );
-	}
-
-
-	/**
-	 * Returns the parameters used by the html client.
-	 *
-	 * @param array $params Associative list of all parameters
-	 * @param array $prefixes List of prefixes the parameters must start with
-	 * @return array Associative list of parameters used by the html client
-	 */
-	protected function getClientParams( array $params, array $prefixes = array( 'f', 'l', 'd', 'a' ) )
-	{
-		$list = array();
-
-		foreach( $params as $key => $value )
-		{
-			if( in_array( $key[0], $prefixes ) && $key[1] === '_' ) {
-				$list[$key] = $value;
-			}
-		}
-
-		return $list;
-	}
-
-
-	/**
-	 * Returns the context object.
-	 *
-	 * @return \Aimeos\MShop\Context\Item\Iface Context object
-	 */
-	protected function getContext()
-	{
-		return $this->context;
-	}
-
-
-	/**
-	 * Generates an unique hash from based on the input suitable to be used as part of the cache key
-	 *
-	 * @param array $prefixes List of prefixes the parameters must start with
-	 * @param string $key Unique identifier if the content is placed more than once on the same page
-	 * @param array $config Multi-dimensional array of configuration options used by the client and sub-clients
-	 * @return string Unique hash
-	 */
-	protected function getParamHash( array $prefixes = array( 'f', 'l', 'd' ), $key = '', array $config = array() )
-	{
-		$locale = $this->getContext()->getLocale();
-		$params = $this->getClientParams( $this->getView()->param(), $prefixes );
-		ksort( $params );
-
-		if( ( $pstr = json_encode( $params ) ) === false || ( $cstr = json_encode( $config ) ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( 'Unable to encode parameters or configuration options' );
-		}
-
-		return md5( $key . $pstr . $cstr . $locale->getLanguageId() . $locale->getCurrencyId() );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	abstract protected function getSubClientNames();
-
-
-	/**
-	 * Returns the configured sub-clients or the ones named in the default parameter if none are configured.
-	 *
-	 * @return array List of sub-clients implementing \Aimeos\Client\Html\Iface	ordered in the same way as the names
-	 */
-	protected function getSubClients()
-	{
-		if( !isset( $this->subclients ) )
-		{
-			$this->subclients = array();
-
-			foreach( $this->getSubClientNames() as $name ) {
-				$this->subclients[] = $this->getSubClient( $name );
-			}
-		}
-
-		return $this->subclients;
-	}
-
-
-	/**
-	 * Returns the paths where the layout templates can be found
-	 *
-	 * @return array List of template paths
-	 * @since 2015.09
-	 */
-	protected function getTemplatePaths()
-	{
-		return $this->templatePaths;
-	}
-
-
-	/**
-	 * Returns the attribute type item specified by the code.
-	 *
-	 * @param string $prefix Domain prefix for the manager, e.g. "media/type"
-	 * @param string $domain Domain of the type item
-	 * @param string $code Code of the type item
-	 * @return \Aimeos\MShop\Common\Item\Type\Iface Type item
-	 * @throws \Aimeos\Controller\Jobs\Exception If no item is found
-	 */
-	protected function getTypeItem( $prefix, $domain, $code )
-	{
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), $prefix );
-		$prefix = str_replace( '/', '.', $prefix );
-
-		$search = $manager->createSearch();
-		$expr = array(
-				$search->compare( '==', $prefix . '.domain', $domain ),
-				$search->compare( '==', $prefix . '.code', $code ),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$result = $manager->searchItems( $search );
-
-		if( ( $item = reset( $result ) ) === false )
-		{
-			$msg = sprintf( 'No type item for "%1$s/%2$s" in "%3$s" found', $domain, $code, $prefix );
-			throw new \Aimeos\Controller\Jobs\Exception( $msg );
-		}
-
-		return $item;
-	}
-
-
-	/**
-	 * Returns the cache entry for the given unique ID and type.
-	 *
-	 * @param string $type Type of the cache entry, i.e. "body" or "header"
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param string[] $prefixes List of prefixes of all parameters that are relevant for generating the output
-	 * @param string $confkey Configuration key prefix that matches all relevant settings for the component
-	 * @return string Cached entry or empty string if not available
-	 */
-	protected function getCached( $type, $uid, array $prefixes, $confkey )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$context = $this->getContext();
-			$config = $context->getConfig();
-
-			/** client/html/common/cache/force
-			 * Enforces content caching regardless of user logins
-			 *
-			 * Caching the component output is normally disabled as soon as the
-			 * user has logged in. This enables displaying user or user group
-			 * specific content without mixing standard and user specific output.
-			 *
-			 * If you don't have any user or user group specific content
-			 * (products, categories, attributes, media, prices, texts, etc.),
-			 * you can enforce content caching nevertheless to keep response
-			 * times as low as possible.
-			 *
-			 * @param boolean True to cache output regardless of login, false for no caching
-			 * @since 2015.08
-			 * @category Developer
-			 * @category User
-			 * @see client/html/common/cache/tag-all
-			 */
-			$force = $config->get( 'client/html/common/cache/force', false );
-
-			if( $force == false && $context->getUserId() !== null ) {
-				return null;
-			}
-
-			$cfg = $config->get( $confkey, array() );
-
-			$keys = array(
-				'body' => $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':body', $cfg ),
-				'header' => $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':header', $cfg ),
-			);
-
-			$entries = $context->getCache()->getList( $keys );
-			$this->cache = array();
-
-			foreach( $keys as $key => $hash ) {
-				$this->cache[$key] = ( array_key_exists( $hash, $entries ) ? $entries[$hash] : null );
-			}
-		}
-
-		return ( array_key_exists( $type, $this->cache ) ? $this->cache[$type] : null );
-	}
-
-
-	/**
-	 * Returns the cache entry for the given type and unique ID.
-	 *
-	 * @param string $type Type of the cache entry, i.e. "body" or "header"
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param string[] $prefixes List of prefixes of all parameters that are relevant for generating the output
-	 * @param string $confkey Configuration key prefix that matches all relevant settings for the component
-	 * @param string $value Value string that should be stored for the given key
-	 * @param array $tags List of tag strings that should be assoicated to the
-	 * 	given value in the cache
-	 * @param string|null $expire Date/time string in "YYYY-MM-DD HH:mm:ss"
-	 * 	format when the cache entry expires
-	 */
-	protected function setCached( $type, $uid, array $prefixes, $confkey, $value, array $tags, $expire )
-	{
-		$context = $this->getContext();
-		$config = $context->getConfig();
-
-		$force = $config->get( 'client/html/common/cache/force', false );
-
-		if( $force == false && $context->getUserId() !== null ) {
-			return;
-		}
-
-		try
-		{
-			$cfg = $config->get( $confkey, array() );
-			$key = $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':' . $type, $cfg );
-
-			$context->getCache()->set( $key, $value, array_unique( $tags ), $expire );
-		}
-		catch( \Exception $e )
-		{
-			$msg = sprintf( 'Unable to set cache entry: %1$s', $e->getMessage() );
-			$context->getLogger()->log( $msg, \Aimeos\MW\Logger\Base::NOTICE );
-		}
-	}
-
-
-	/**
-	 * Replaces the section in the content that is enclosed by the marker.
-	 *
-	 * @param string $content Cached content
-	 * @param string $section New section content
-	 * @param string $marker Name of the section marker without "<!-- " and " -->" parts
-	 */
-	protected function replaceSection( $content, $section, $marker )
-	{
-		$start = 0;
-		$len = strlen( $section );
-		$marker = '<!-- ' . $marker . ' -->';
-
-		while( ( $start = @strpos( $content, $marker, $start ) ) !== false )
-		{
-			if( ( $end = strpos( $content, $marker, $start + 1 ) ) !== false ) {
-				$content = substr_replace( $content, $section, $start, $end - $start + strlen( $marker ) );
-			}
-
-			$start += 2 * strlen( $marker ) + $len;
-		}
-
-		return $content;
-	}
-
-
-	/**
-	 * 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
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		return $view;
-	}
-
-
-	/**
-	 * Translates the plugin error codes to human readable error strings.
-	 *
-	 * @param array $codes Associative list of scope and object as key and error code as value
-	 * @return array List of translated error messages
-	 */
-	protected function translatePluginErrorCodes( array $codes )
-	{
-		$errors = array();
-		$i18n = $this->context->getI18n();
-
-		foreach( $codes as $scope => $list )
-		{
-			foreach( $list as $object => $errcode )
-			{
-				$key = $scope . ( $scope !== 'product' ? '.' . $object : '' ) . '.' . $errcode;
-				$errors[] = $i18n->dt( 'mshop/code', $key );
-			}
-		}
-
-		return $errors;
-	}
+    private $view;
+    private $cache;
+    private $context;
+    private $subclients;
+    private $templatePaths;
+
+
+    /**
+     * Initializes the class instance.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context object
+     * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
+     * 	and a list of relative paths inside the core or the extension as values
+     */
+    public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
+    {
+        $this->context = $context;
+        $this->templatePaths = $templatePaths;
+    }
+
+
+    /**
+     * Returns the view object that will generate the HTML output.
+     *
+     * @return \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     */
+    public function getView()
+    {
+        if( !isset( $this->view ) ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'No view available' ) );
+        }
+
+        return $this->view;
+    }
+
+
+    /**
+     * Modifies the cached body content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified body content
+     */
+    public function modifyBody( $content, $uid )
+    {
+        $view = $this->getView();
+
+        foreach( $this->getSubClients() as $subclient )
+        {
+            $subclient->setView( $view );
+            $content = $subclient->modifyBody( $content, $uid );
+        }
+
+        return $content;
+    }
+
+
+    /**
+     * Modifies the cached header content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified header content
+     */
+    public function modifyHeader( $content, $uid )
+    {
+        $view = $this->getView();
+
+        foreach( $this->getSubClients() as $subclient )
+        {
+            $subclient->setView( $view );
+            $content = $subclient->modifyHeader( $content, $uid );
+        }
+
+        return $content;
+    }
+
+
+    /**
+     * 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.
+     *
+     * @return boolean False if processing is stopped, otherwise all processing was completed successfully
+     */
+    public function process()
+    {
+        $view = $this->getView();
+
+        foreach( $this->getSubClients() as $subclient )
+        {
+            $subclient->setView( $view );
+
+            if( $subclient->process() === false ) {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+
+    /**
+     * Sets the view object that will generate the HTML output.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @return \Aimeos\Client\Html\Iface Reference to this object for fluent calls
+     */
+    public function setView( \Aimeos\MW\View\Iface $view )
+    {
+        $this->view = $view;
+        return $this;
+    }
+
+
+    /**
+     * Adds the decorators to the client object
+     *
+     * @param \Aimeos\Client\Html\Iface $client Client object
+     * @param array $templatePaths List of file system paths where the templates are stored
+     * @param array $decorators List of decorator name that should be wrapped around the client
+     * @param string $classprefix Decorator class prefix, e.g. "\Aimeos\Client\Html\Catalog\Decorator\"
+     * @return \Aimeos\Client\Html\Iface Client object
+     */
+    protected function addDecorators( \Aimeos\Client\Html\Iface $client, array $templatePaths,
+        array $decorators, $classprefix )
+    {
+        $iface = '\\Aimeos\\Client\\Html\\Common\\Decorator\\Iface';
+
+        foreach( $decorators as $name )
+        {
+            if( ctype_alnum( $name ) === false )
+            {
+                $classname = is_string( $name ) ? $classprefix . $name : '<not a string>';
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid class name "%1$s"', $classname ) );
+            }
+
+            $classname = $classprefix . $name;
+
+            if( class_exists( $classname ) === false ) {
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not found', $classname ) );
+            }
+
+            $client = new $classname( $client, $this->context, $this->templatePaths );
+
+            if( !( $client instanceof $iface ) ) {
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement "%2$s"', $classname, $iface ) );
+            }
+        }
+
+        return $client;
+    }
+
+
+    /**
+     * Adds the decorators to the client object
+     *
+     * @param \Aimeos\Client\Html\Iface $client Client object
+     * @param array $templatePaths List of file system paths where the templates are stored
+     * @param string $path Client string in lower case, e.g. "catalog/detail/basic"
+     * @return \Aimeos\Client\Html\Iface Client object
+     */
+    protected function addClientDecorators( \Aimeos\Client\Html\Iface $client, array $templatePaths, $path )
+    {
+        if( !is_string( $path ) || $path === '' ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid domain "%1$s"', $path ) );
+        }
+
+        $localClass = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
+        $config = $this->context->getConfig();
+
+        $decorators = $config->get( 'client/html/common/decorators/default', array() );
+        $excludes = $config->get( 'client/html/' . $path . '/decorators/excludes', array() );
+
+        foreach( $decorators as $key => $name )
+        {
+            if( in_array( $name, $excludes ) ) {
+                unset( $decorators[$key] );
+            }
+        }
+
+        $classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
+        $client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
+
+        $classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
+        $decorators = $config->get( 'client/html/' . $path . '/decorators/global', array() );
+        $client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
+
+        $classprefix = '\\Aimeos\\Client\\Html\\' . $localClass . '\\Decorator\\';
+        $decorators = $config->get( 'client/html/' . $path . '/decorators/local', array() );
+        $client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
+
+        return $client;
+    }
+
+
+    /**
+     * Adds the cache tags to the given list and sets a new expiration date if necessary based on the given item.
+     *
+     * @param array|\Aimeos\MShop\Common\Item\Iface $items Item or list of items, maybe with associated list items
+     * @param string $domain Name of the domain the item is from
+     * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
+     * @param array &$tags List of tags the new tags will be added to
+     */
+    protected function addMetaItem( $items, $domain, &$expire, array &$tags )
+    {
+        /** client/html/common/cache/tag-all
+         * Adds tags for all items used in a cache entry
+         *
+         * Each cache entry storing rendered parts for the HTML header or body
+         * can be tagged with information which items like texts, media, etc.
+         * are used in the HTML. This allows removing only those cache entries
+         * whose content has really changed and only that entries have to be
+         * rebuild the next time.
+         *
+         * The standard behavior stores only tags for each used domain, e.g. if
+         * a text is used, only the tag "text" is added. If you change a text
+         * in the administration interface, all cache entries with the tag
+         * "text" will be removed from the cache. This effectively wipes out
+         * almost all cached entries, which have to be rebuild with the next
+         * request.
+         *
+         * Important: As a list or detail view can use several hundred items,
+         * this configuration option will also add this number of tags to the
+         * cache entry. When using a cache adapter that can't insert all tags
+         * at once, this slows down the initial cache insert (and therefore the
+         * page speed) drastically! It's only recommended to enable this option
+         * if you use the DB, Mysql or Redis adapter that can insert all tags
+         * at once.
+         *
+         * @param boolean True to add tags for all items, false to use only a domain tag
+         * @since 2014.07
+         * @category Developer
+         * @category User
+         * @see client/html/common/cache/force
+         * @see madmin/cache/manager/name
+         * @see madmin/cache/name
+         */
+        $tagAll = $this->context->getConfig()->get( 'client/html/common/cache/tag-all', false );
+
+        if( !is_array( $items ) ) {
+            $items = array( $items );
+        }
+
+        if( $tagAll !== true && !empty( $items ) ) {
+            $tags[] = $domain;
+        }
+
+        foreach( $items as $item ) {
+            $this->addMetaItemSingle( $item, $domain, $expire, $tags, $tagAll );
+        }
+    }
+
+
+    /**
+     * Adds expire date and tags for a single item.
+     *
+     * @param \Aimeos\MShop\Common\Item\Iface $item Item, maybe with associated list items
+     * @param string $domain Name of the domain the item is from
+     * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
+     * @param array &$tags List of tags the new tags will be added to
+     * @param boolean $tagAll True of tags for all items should be added, false if only for the main item
+     */
+    private function addMetaItemSingle( \Aimeos\MShop\Common\Item\Iface $item, $domain, &$expire, array &$tags, $tagAll )
+    {
+        $expires = array();
+        $domain = str_replace( '/', '_', $domain ); // maximum compatiblity
+
+        if( $tagAll === true ) {
+            $tags[] = $domain . '-' . $item->getId();
+        }
+
+        if( $item instanceof \Aimeos\MShop\Common\Item\Time\Iface && ( $date = $item->getDateEnd() ) !== null ) {
+            $expires[] = $date;
+        }
+
+        if( $item instanceof \Aimeos\MShop\Common\Item\ListRef\Iface ) {
+            $this->addMetaItemRef( $item, $expires, $tags, $tagAll );
+        }
+
+        if( !empty( $expires ) ) {
+            $expire = min( $expires );
+        }
+    }
+
+
+    /**
+     * Adds expire date and tags for referenced items
+     *
+     * @param \Aimeos\MShop\Common\Item\ListRef\Iface $item Item with associated list items
+     * @param array &$expire Expiration date that will be overwritten if an earlier date is found
+     * @param array &$tags List of tags the new tags will be added to
+     * @param boolean $tagAll True of tags for all items should be added, false if only for the main item
+     */
+    private function addMetaItemRef( \Aimeos\MShop\Common\Item\ListRef\Iface $item, array &$expires, array &$tags, $tagAll )
+    {
+        foreach( $item->getListItems() as $listitem )
+        {
+            if( $tagAll === true ) {
+                $tags[] = str_replace( '/', '_', $listitem->getDomain() ) . '-' . $listitem->getRefId();
+            }
+
+            if( ( $date = $listitem->getDateEnd() ) !== null ) {
+                $expires[] = $date;
+            }
+        }
+    }
+
+
+    /**
+     * Adds a new expiration date if a list item is activated in the future.
+     *
+     * @param array|string $ids Item ID or list of item IDs from the given domain
+     * @param string $domain Name of the domain the item IDs are from
+     * @param string|null &$expire Expiration date that will be overwritten if an start date in the future is available
+     */
+    protected function addMetaList( $ids, $domain, &$expire )
+    {
+        $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), $domain . '/lists' );
+
+        $search = $manager->createSearch();
+        $expr = array(
+            $search->compare( '==', $domain . '.lists.parentid', $ids ),
+            $search->compare( '>', $domain . '.lists.datestart', date( 'Y-m-d H:i:00' ) ),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+        $search->setSortations( array( $search->sort( '+', $domain . '.lists.datestart' ) ) );
+        $search->setSlice( 0, 1 );
+
+        foreach( $manager->searchItems( $search ) as $listItem ) {
+            $expire = $this->expires( $expire, $listItem->getDateStart() );
+        }
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $path Name of the sub-part in lower case (can contain a path like catalog/filter/tree)
+     * @param string|null $name Name of the implementation, will be from configuration (or Default) if null
+     * @return \Aimeos\Client\Html\Iface Sub-part object
+     */
+    protected function createSubClient( $path, $name )
+    {
+        $path = strtolower( $path );
+
+        if( $name === null ) {
+            $name = $this->context->getConfig()->get( 'client/html/' . $path . '/name', 'Standard' );
+        }
+
+        if( empty( $name ) || ctype_alnum( $name ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s"', $name ) );
+        }
+
+        $subnames = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
+
+        $classname = '\\Aimeos\\Client\\Html\\' . $subnames . '\\' . $name;
+        $interface = '\\Aimeos\\Client\\Html\\Iface';
+
+        if( class_exists( $classname ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $classname ) );
+        }
+
+        $object = new $classname( $this->context, $this->templatePaths );
+
+        if( ( $object instanceof $interface ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement interface "%2$s"', $classname, $interface ) );
+        }
+
+        return $this->addClientDecorators( $object, $this->templatePaths, $path );
+    }
+
+
+    /**
+     * Returns the minimal expiration date.
+     *
+     * @param string|null $first First expiration date or null
+     * @param string|null $second Second expiration date or null
+     * @return string|null Expiration date
+     */
+    protected function expires( $first, $second )
+    {
+        return ( $first !== null ? ( $second !== null ? min( $first, $second ) : $first ) : $second );
+    }
+
+
+    /**
+     * Returns the parameters used by the html client.
+     *
+     * @param array $params Associative list of all parameters
+     * @param array $prefixes List of prefixes the parameters must start with
+     * @return array Associative list of parameters used by the html client
+     */
+    protected function getClientParams( array $params, array $prefixes = array( 'f', 'l', 'd', 'a' ) )
+    {
+        $list = array();
+
+        foreach( $params as $key => $value )
+        {
+            if( in_array( $key[0], $prefixes ) && $key[1] === '_' ) {
+                $list[$key] = $value;
+            }
+        }
+
+        return $list;
+    }
+
+
+    /**
+     * Returns the context object.
+     *
+     * @return \Aimeos\MShop\Context\Item\Iface Context object
+     */
+    protected function getContext()
+    {
+        return $this->context;
+    }
+
+
+    /**
+     * Generates an unique hash from based on the input suitable to be used as part of the cache key
+     *
+     * @param array $prefixes List of prefixes the parameters must start with
+     * @param string $key Unique identifier if the content is placed more than once on the same page
+     * @param array $config Multi-dimensional array of configuration options used by the client and sub-clients
+     * @return string Unique hash
+     */
+    protected function getParamHash( array $prefixes = array( 'f', 'l', 'd' ), $key = '', array $config = array() )
+    {
+        $locale = $this->getContext()->getLocale();
+        $params = $this->getClientParams( $this->getView()->param(), $prefixes );
+        ksort( $params );
+
+        if( ( $pstr = json_encode( $params ) ) === false || ( $cstr = json_encode( $config ) ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( 'Unable to encode parameters or configuration options' );
+        }
+
+        return md5( $key . $pstr . $cstr . $locale->getLanguageId() . $locale->getCurrencyId() );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    abstract protected function getSubClientNames();
+
+
+    /**
+     * Returns the configured sub-clients or the ones named in the default parameter if none are configured.
+     *
+     * @return array List of sub-clients implementing \Aimeos\Client\Html\Iface	ordered in the same way as the names
+     */
+    protected function getSubClients()
+    {
+        if( !isset( $this->subclients ) )
+        {
+            $this->subclients = array();
+
+            foreach( $this->getSubClientNames() as $name ) {
+                $this->subclients[] = $this->getSubClient( $name );
+            }
+        }
+
+        return $this->subclients;
+    }
+
+
+    /**
+     * Returns the paths where the layout templates can be found
+     *
+     * @return array List of template paths
+     * @since 2015.09
+     */
+    protected function getTemplatePaths()
+    {
+        return $this->templatePaths;
+    }
+
+
+    /**
+     * Returns the attribute type item specified by the code.
+     *
+     * @param string $prefix Domain prefix for the manager, e.g. "media/type"
+     * @param string $domain Domain of the type item
+     * @param string $code Code of the type item
+     * @return \Aimeos\MShop\Common\Item\Type\Iface Type item
+     * @throws \Aimeos\Controller\Jobs\Exception If no item is found
+     */
+    protected function getTypeItem( $prefix, $domain, $code )
+    {
+        $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), $prefix );
+        $prefix = str_replace( '/', '.', $prefix );
+
+        $search = $manager->createSearch();
+        $expr = array(
+                $search->compare( '==', $prefix . '.domain', $domain ),
+                $search->compare( '==', $prefix . '.code', $code ),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+        $result = $manager->searchItems( $search );
+
+        if( ( $item = reset( $result ) ) === false )
+        {
+            $msg = sprintf( 'No type item for "%1$s/%2$s" in "%3$s" found', $domain, $code, $prefix );
+            throw new \Aimeos\Controller\Jobs\Exception( $msg );
+        }
+
+        return $item;
+    }
+
+
+    /**
+     * Returns the cache entry for the given unique ID and type.
+     *
+     * @param string $type Type of the cache entry, i.e. "body" or "header"
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param string[] $prefixes List of prefixes of all parameters that are relevant for generating the output
+     * @param string $confkey Configuration key prefix that matches all relevant settings for the component
+     * @return string Cached entry or empty string if not available
+     */
+    protected function getCached( $type, $uid, array $prefixes, $confkey )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $context = $this->getContext();
+            $config = $context->getConfig();
+
+            /** client/html/common/cache/force
+             * Enforces content caching regardless of user logins
+             *
+             * Caching the component output is normally disabled as soon as the
+             * user has logged in. This enables displaying user or user group
+             * specific content without mixing standard and user specific output.
+             *
+             * If you don't have any user or user group specific content
+             * (products, categories, attributes, media, prices, texts, etc.),
+             * you can enforce content caching nevertheless to keep response
+             * times as low as possible.
+             *
+             * @param boolean True to cache output regardless of login, false for no caching
+             * @since 2015.08
+             * @category Developer
+             * @category User
+             * @see client/html/common/cache/tag-all
+             */
+            $force = $config->get( 'client/html/common/cache/force', false );
+
+            if( $force == false && $context->getUserId() !== null ) {
+                return null;
+            }
+
+            $cfg = $config->get( $confkey, array() );
+
+            $keys = array(
+                'body' => $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':body', $cfg ),
+                'header' => $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':header', $cfg ),
+            );
+
+            $entries = $context->getCache()->getList( $keys );
+            $this->cache = array();
+
+            foreach( $keys as $key => $hash ) {
+                $this->cache[$key] = ( array_key_exists( $hash, $entries ) ? $entries[$hash] : null );
+            }
+        }
+
+        return ( array_key_exists( $type, $this->cache ) ? $this->cache[$type] : null );
+    }
+
+
+    /**
+     * Returns the cache entry for the given type and unique ID.
+     *
+     * @param string $type Type of the cache entry, i.e. "body" or "header"
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param string[] $prefixes List of prefixes of all parameters that are relevant for generating the output
+     * @param string $confkey Configuration key prefix that matches all relevant settings for the component
+     * @param string $value Value string that should be stored for the given key
+     * @param array $tags List of tag strings that should be assoicated to the
+     * 	given value in the cache
+     * @param string|null $expire Date/time string in "YYYY-MM-DD HH:mm:ss"
+     * 	format when the cache entry expires
+     */
+    protected function setCached( $type, $uid, array $prefixes, $confkey, $value, array $tags, $expire )
+    {
+        $context = $this->getContext();
+        $config = $context->getConfig();
+
+        $force = $config->get( 'client/html/common/cache/force', false );
+
+        if( $force == false && $context->getUserId() !== null ) {
+            return;
+        }
+
+        try
+        {
+            $cfg = $config->get( $confkey, array() );
+            $key = $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':' . $type, $cfg );
+
+            $context->getCache()->set( $key, $value, array_unique( $tags ), $expire );
+        }
+        catch( \Exception $e )
+        {
+            $msg = sprintf( 'Unable to set cache entry: %1$s', $e->getMessage() );
+            $context->getLogger()->log( $msg, \Aimeos\MW\Logger\Base::NOTICE );
+        }
+    }
+
+
+    /**
+     * Replaces the section in the content that is enclosed by the marker.
+     *
+     * @param string $content Cached content
+     * @param string $section New section content
+     * @param string $marker Name of the section marker without "<!-- " and " -->" parts
+     */
+    protected function replaceSection( $content, $section, $marker )
+    {
+        $start = 0;
+        $len = strlen( $section );
+        $marker = '<!-- ' . $marker . ' -->';
+
+        while( ( $start = @strpos( $content, $marker, $start ) ) !== false )
+        {
+            if( ( $end = strpos( $content, $marker, $start + 1 ) ) !== false ) {
+                $content = substr_replace( $content, $section, $start, $end - $start + strlen( $marker ) );
+            }
+
+            $start += 2 * strlen( $marker ) + $len;
+        }
+
+        return $content;
+    }
+
+
+    /**
+     * 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
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        return $view;
+    }
+
+
+    /**
+     * Translates the plugin error codes to human readable error strings.
+     *
+     * @param array $codes Associative list of scope and object as key and error code as value
+     * @return array List of translated error messages
+     */
+    protected function translatePluginErrorCodes( array $codes )
+    {
+        $errors = array();
+        $i18n = $this->context->getI18n();
+
+        foreach( $codes as $scope => $list )
+        {
+            foreach( $list as $object => $errcode )
+            {
+                $key = $scope . ( $scope !== 'product' ? '.' . $object : '' ) . '.' . $errcode;
+                $errors[] = $i18n->dt( 'mshop/code', $key );
+            }
+        }
+
+        return $errors;
+    }
 }

Spacing +143 added lines, -143 removed lines

@@ -35,7 +35,7 @@ 
 	 * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
 	 * 	and a list of relative paths inside the core or the extension as values
 	 */
-	public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
+	public function __construct(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths)
 	{
 		$this->context = $context;
 		$this->templatePaths = $templatePaths;
@@ -49,8 +49,8 @@ 
 	 */
 	public function getView()
 	{
-		if( !isset( $this->view ) ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'No view available' ) );
+		if (!isset($this->view)) {
+			throw new \Aimeos\Client\Html\Exception(sprintf('No view available'));
 		}
 
 		return $this->view;
@@ -64,14 +64,14 @@ 
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @return string Modified body content
 	 */
-	public function modifyBody( $content, $uid )
+	public function modifyBody($content, $uid)
 	{
 		$view = $this->getView();
 
-		foreach( $this->getSubClients() as $subclient )
+		foreach ($this->getSubClients() as $subclient)
 		{
-			$subclient->setView( $view );
-			$content = $subclient->modifyBody( $content, $uid );
+			$subclient->setView($view);
+			$content = $subclient->modifyBody($content, $uid);
 		}
 
 		return $content;
@@ -85,14 +85,14 @@ 
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @return string Modified header content
 	 */
-	public function modifyHeader( $content, $uid )
+	public function modifyHeader($content, $uid)
 	{
 		$view = $this->getView();
 
-		foreach( $this->getSubClients() as $subclient )
+		foreach ($this->getSubClients() as $subclient)
 		{
-			$subclient->setView( $view );
-			$content = $subclient->modifyHeader( $content, $uid );
+			$subclient->setView($view);
+			$content = $subclient->modifyHeader($content, $uid);
 		}
 
 		return $content;
@@ -110,11 +110,11 @@ 
 	{
 		$view = $this->getView();
 
-		foreach( $this->getSubClients() as $subclient )
+		foreach ($this->getSubClients() as $subclient)
 		{
-			$subclient->setView( $view );
+			$subclient->setView($view);
 
-			if( $subclient->process() === false ) {
+			if ($subclient->process() === false) {
 				return false;
 			}
 		}
@@ -129,7 +129,7 @@ 
 	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
 	 * @return \Aimeos\Client\Html\Iface Reference to this object for fluent calls
 	 */
-	public function setView( \Aimeos\MW\View\Iface $view )
+	public function setView(\Aimeos\MW\View\Iface $view)
 	{
 		$this->view = $view;
 		return $this;
@@ -145,29 +145,29 @@ 
 	 * @param string $classprefix Decorator class prefix, e.g. "\Aimeos\Client\Html\Catalog\Decorator\"
 	 * @return \Aimeos\Client\Html\Iface Client object
 	 */
-	protected function addDecorators( \Aimeos\Client\Html\Iface $client, array $templatePaths,
-		array $decorators, $classprefix )
+	protected function addDecorators(\Aimeos\Client\Html\Iface $client, array $templatePaths,
+		array $decorators, $classprefix)
 	{
 		$iface = '\\Aimeos\\Client\\Html\\Common\\Decorator\\Iface';
 
-		foreach( $decorators as $name )
+		foreach ($decorators as $name)
 		{
-			if( ctype_alnum( $name ) === false )
+			if (ctype_alnum($name) === false)
 			{
-				$classname = is_string( $name ) ? $classprefix . $name : '<not a string>';
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid class name "%1$s"', $classname ) );
+				$classname = is_string($name) ? $classprefix.$name : '<not a string>';
+				throw new \Aimeos\Client\Html\Exception(sprintf('Invalid class name "%1$s"', $classname));
 			}
 
-			$classname = $classprefix . $name;
+			$classname = $classprefix.$name;
 
-			if( class_exists( $classname ) === false ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not found', $classname ) );
+			if (class_exists($classname) === false) {
+				throw new \Aimeos\Client\Html\Exception(sprintf('Class "%1$s" not found', $classname));
 			}
 
-			$client = new $classname( $client, $this->context, $this->templatePaths );
+			$client = new $classname($client, $this->context, $this->templatePaths);
 
-			if( !( $client instanceof $iface ) ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement "%2$s"', $classname, $iface ) );
+			if (!($client instanceof $iface)) {
+				throw new \Aimeos\Client\Html\Exception(sprintf('Class "%1$s" does not implement "%2$s"', $classname, $iface));
 			}
 		}
 
@@ -183,35 +183,35 @@ 
 	 * @param string $path Client string in lower case, e.g. "catalog/detail/basic"
 	 * @return \Aimeos\Client\Html\Iface Client object
 	 */
-	protected function addClientDecorators( \Aimeos\Client\Html\Iface $client, array $templatePaths, $path )
+	protected function addClientDecorators(\Aimeos\Client\Html\Iface $client, array $templatePaths, $path)
 	{
-		if( !is_string( $path ) || $path === '' ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid domain "%1$s"', $path ) );
+		if (!is_string($path) || $path === '') {
+			throw new \Aimeos\Client\Html\Exception(sprintf('Invalid domain "%1$s"', $path));
 		}
 
-		$localClass = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
+		$localClass = str_replace(' ', '\\', ucwords(str_replace('/', ' ', $path)));
 		$config = $this->context->getConfig();
 
-		$decorators = $config->get( 'client/html/common/decorators/default', array() );
-		$excludes = $config->get( 'client/html/' . $path . '/decorators/excludes', array() );
+		$decorators = $config->get('client/html/common/decorators/default', array());
+		$excludes = $config->get('client/html/'.$path.'/decorators/excludes', array());
 
-		foreach( $decorators as $key => $name )
+		foreach ($decorators as $key => $name)
 		{
-			if( in_array( $name, $excludes ) ) {
-				unset( $decorators[$key] );
+			if (in_array($name, $excludes)) {
+				unset($decorators[$key]);
 			}
 		}
 
 		$classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
-		$client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
+		$client = $this->addDecorators($client, $templatePaths, $decorators, $classprefix);
 
 		$classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
-		$decorators = $config->get( 'client/html/' . $path . '/decorators/global', array() );
-		$client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
+		$decorators = $config->get('client/html/'.$path.'/decorators/global', array());
+		$client = $this->addDecorators($client, $templatePaths, $decorators, $classprefix);
 
-		$classprefix = '\\Aimeos\\Client\\Html\\' . $localClass . '\\Decorator\\';
-		$decorators = $config->get( 'client/html/' . $path . '/decorators/local', array() );
-		$client = $this->addDecorators( $client, $templatePaths, $decorators, $classprefix );
+		$classprefix = '\\Aimeos\\Client\\Html\\'.$localClass.'\\Decorator\\';
+		$decorators = $config->get('client/html/'.$path.'/decorators/local', array());
+		$client = $this->addDecorators($client, $templatePaths, $decorators, $classprefix);
 
 		return $client;
 	}
@@ -225,7 +225,7 @@ 
 	 * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
 	 * @param array &$tags List of tags the new tags will be added to
 	 */
-	protected function addMetaItem( $items, $domain, &$expire, array &$tags )
+	protected function addMetaItem($items, $domain, &$expire, array &$tags)
 	{
 		/** client/html/common/cache/tag-all
 		 * Adds tags for all items used in a cache entry
@@ -259,18 +259,18 @@ 
 		 * @see madmin/cache/manager/name
 		 * @see madmin/cache/name
 		 */
-		$tagAll = $this->context->getConfig()->get( 'client/html/common/cache/tag-all', false );
+		$tagAll = $this->context->getConfig()->get('client/html/common/cache/tag-all', false);
 
-		if( !is_array( $items ) ) {
-			$items = array( $items );
+		if (!is_array($items)) {
+			$items = array($items);
 		}
 
-		if( $tagAll !== true && !empty( $items ) ) {
+		if ($tagAll !== true && !empty($items)) {
 			$tags[] = $domain;
 		}
 
-		foreach( $items as $item ) {
-			$this->addMetaItemSingle( $item, $domain, $expire, $tags, $tagAll );
+		foreach ($items as $item) {
+			$this->addMetaItemSingle($item, $domain, $expire, $tags, $tagAll);
 		}
 	}
 
@@ -284,25 +284,25 @@ 
 	 * @param array &$tags List of tags the new tags will be added to
 	 * @param boolean $tagAll True of tags for all items should be added, false if only for the main item
 	 */
-	private function addMetaItemSingle( \Aimeos\MShop\Common\Item\Iface $item, $domain, &$expire, array &$tags, $tagAll )
+	private function addMetaItemSingle(\Aimeos\MShop\Common\Item\Iface $item, $domain, &$expire, array &$tags, $tagAll)
 	{
 		$expires = array();
-		$domain = str_replace( '/', '_', $domain ); // maximum compatiblity
+		$domain = str_replace('/', '_', $domain); // maximum compatiblity
 
-		if( $tagAll === true ) {
-			$tags[] = $domain . '-' . $item->getId();
+		if ($tagAll === true) {
+			$tags[] = $domain.'-'.$item->getId();
 		}
 
-		if( $item instanceof \Aimeos\MShop\Common\Item\Time\Iface && ( $date = $item->getDateEnd() ) !== null ) {
+		if ($item instanceof \Aimeos\MShop\Common\Item\Time\Iface && ($date = $item->getDateEnd()) !== null) {
 			$expires[] = $date;
 		}
 
-		if( $item instanceof \Aimeos\MShop\Common\Item\ListRef\Iface ) {
-			$this->addMetaItemRef( $item, $expires, $tags, $tagAll );
+		if ($item instanceof \Aimeos\MShop\Common\Item\ListRef\Iface) {
+			$this->addMetaItemRef($item, $expires, $tags, $tagAll);
 		}
 
-		if( !empty( $expires ) ) {
-			$expire = min( $expires );
+		if (!empty($expires)) {
+			$expire = min($expires);
 		}
 	}
 
@@ -315,15 +315,15 @@ 
 	 * @param array &$tags List of tags the new tags will be added to
 	 * @param boolean $tagAll True of tags for all items should be added, false if only for the main item
 	 */
-	private function addMetaItemRef( \Aimeos\MShop\Common\Item\ListRef\Iface $item, array &$expires, array &$tags, $tagAll )
+	private function addMetaItemRef(\Aimeos\MShop\Common\Item\ListRef\Iface $item, array &$expires, array &$tags, $tagAll)
 	{
-		foreach( $item->getListItems() as $listitem )
+		foreach ($item->getListItems() as $listitem)
 		{
-			if( $tagAll === true ) {
-				$tags[] = str_replace( '/', '_', $listitem->getDomain() ) . '-' . $listitem->getRefId();
+			if ($tagAll === true) {
+				$tags[] = str_replace('/', '_', $listitem->getDomain()).'-'.$listitem->getRefId();
 			}
 
-			if( ( $date = $listitem->getDateEnd() ) !== null ) {
+			if (($date = $listitem->getDateEnd()) !== null) {
 				$expires[] = $date;
 			}
 		}
@@ -337,21 +337,21 @@ 
 	 * @param string $domain Name of the domain the item IDs are from
 	 * @param string|null &$expire Expiration date that will be overwritten if an start date in the future is available
 	 */
-	protected function addMetaList( $ids, $domain, &$expire )
+	protected function addMetaList($ids, $domain, &$expire)
 	{
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), $domain . '/lists' );
+		$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), $domain.'/lists');
 
 		$search = $manager->createSearch();
 		$expr = array(
-			$search->compare( '==', $domain . '.lists.parentid', $ids ),
-			$search->compare( '>', $domain . '.lists.datestart', date( 'Y-m-d H:i:00' ) ),
+			$search->compare('==', $domain.'.lists.parentid', $ids),
+			$search->compare('>', $domain.'.lists.datestart', date('Y-m-d H:i:00')),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSortations( array( $search->sort( '+', $domain . '.lists.datestart' ) ) );
-		$search->setSlice( 0, 1 );
+		$search->setConditions($search->combine('&&', $expr));
+		$search->setSortations(array($search->sort('+', $domain.'.lists.datestart')));
+		$search->setSlice(0, 1);
 
-		foreach( $manager->searchItems( $search ) as $listItem ) {
-			$expire = $this->expires( $expire, $listItem->getDateStart() );
+		foreach ($manager->searchItems($search) as $listItem) {
+			$expire = $this->expires($expire, $listItem->getDateStart());
 		}
 	}
 
@@ -363,34 +363,34 @@ 
 	 * @param string|null $name Name of the implementation, will be from configuration (or Default) if null
 	 * @return \Aimeos\Client\Html\Iface Sub-part object
 	 */
-	protected function createSubClient( $path, $name )
+	protected function createSubClient($path, $name)
 	{
-		$path = strtolower( $path );
+		$path = strtolower($path);
 
-		if( $name === null ) {
-			$name = $this->context->getConfig()->get( 'client/html/' . $path . '/name', 'Standard' );
+		if ($name === null) {
+			$name = $this->context->getConfig()->get('client/html/'.$path.'/name', 'Standard');
 		}
 
-		if( empty( $name ) || ctype_alnum( $name ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s"', $name ) );
+		if (empty($name) || ctype_alnum($name) === false) {
+			throw new \Aimeos\Client\Html\Exception(sprintf('Invalid characters in client name "%1$s"', $name));
 		}
 
-		$subnames = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
+		$subnames = str_replace(' ', '\\', ucwords(str_replace('/', ' ', $path)));
 
-		$classname = '\\Aimeos\\Client\\Html\\' . $subnames . '\\' . $name;
+		$classname = '\\Aimeos\\Client\\Html\\'.$subnames.'\\'.$name;
 		$interface = '\\Aimeos\\Client\\Html\\Iface';
 
-		if( class_exists( $classname ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $classname ) );
+		if (class_exists($classname) === false) {
+			throw new \Aimeos\Client\Html\Exception(sprintf('Class "%1$s" not available', $classname));
 		}
 
-		$object = new $classname( $this->context, $this->templatePaths );
+		$object = new $classname($this->context, $this->templatePaths);
 
-		if( ( $object instanceof $interface ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement interface "%2$s"', $classname, $interface ) );
+		if (($object instanceof $interface) === false) {
+			throw new \Aimeos\Client\Html\Exception(sprintf('Class "%1$s" does not implement interface "%2$s"', $classname, $interface));
 		}
 
-		return $this->addClientDecorators( $object, $this->templatePaths, $path );
+		return $this->addClientDecorators($object, $this->templatePaths, $path);
 	}
 
 
@@ -401,9 +401,9 @@ 
 	 * @param string|null $second Second expiration date or null
 	 * @return string|null Expiration date
 	 */
-	protected function expires( $first, $second )
+	protected function expires($first, $second)
 	{
-		return ( $first !== null ? ( $second !== null ? min( $first, $second ) : $first ) : $second );
+		return ($first !== null ? ($second !== null ? min($first, $second) : $first) : $second);
 	}
 
 
@@ -414,13 +414,13 @@ 
 	 * @param array $prefixes List of prefixes the parameters must start with
 	 * @return array Associative list of parameters used by the html client
 	 */
-	protected function getClientParams( array $params, array $prefixes = array( 'f', 'l', 'd', 'a' ) )
+	protected function getClientParams(array $params, array $prefixes = array('f', 'l', 'd', 'a'))
 	{
 		$list = array();
 
-		foreach( $params as $key => $value )
+		foreach ($params as $key => $value)
 		{
-			if( in_array( $key[0], $prefixes ) && $key[1] === '_' ) {
+			if (in_array($key[0], $prefixes) && $key[1] === '_') {
 				$list[$key] = $value;
 			}
 		}
@@ -448,17 +448,17 @@ 
 	 * @param array $config Multi-dimensional array of configuration options used by the client and sub-clients
 	 * @return string Unique hash
 	 */
-	protected function getParamHash( array $prefixes = array( 'f', 'l', 'd' ), $key = '', array $config = array() )
+	protected function getParamHash(array $prefixes = array('f', 'l', 'd'), $key = '', array $config = array())
 	{
 		$locale = $this->getContext()->getLocale();
-		$params = $this->getClientParams( $this->getView()->param(), $prefixes );
-		ksort( $params );
+		$params = $this->getClientParams($this->getView()->param(), $prefixes);
+		ksort($params);
 
-		if( ( $pstr = json_encode( $params ) ) === false || ( $cstr = json_encode( $config ) ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( 'Unable to encode parameters or configuration options' );
+		if (($pstr = json_encode($params)) === false || ($cstr = json_encode($config)) === false) {
+			throw new \Aimeos\Client\Html\Exception('Unable to encode parameters or configuration options');
 		}
 
-		return md5( $key . $pstr . $cstr . $locale->getLanguageId() . $locale->getCurrencyId() );
+		return md5($key.$pstr.$cstr.$locale->getLanguageId().$locale->getCurrencyId());
 	}
 
 
@@ -477,12 +477,12 @@ 
 	 */
 	protected function getSubClients()
 	{
-		if( !isset( $this->subclients ) )
+		if (!isset($this->subclients))
 		{
 			$this->subclients = array();
 
-			foreach( $this->getSubClientNames() as $name ) {
-				$this->subclients[] = $this->getSubClient( $name );
+			foreach ($this->getSubClientNames() as $name) {
+				$this->subclients[] = $this->getSubClient($name);
 			}
 		}
 
@@ -511,23 +511,23 @@ 
 	 * @return \Aimeos\MShop\Common\Item\Type\Iface Type item
 	 * @throws \Aimeos\Controller\Jobs\Exception If no item is found
 	 */
-	protected function getTypeItem( $prefix, $domain, $code )
+	protected function getTypeItem($prefix, $domain, $code)
 	{
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), $prefix );
-		$prefix = str_replace( '/', '.', $prefix );
+		$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), $prefix);
+		$prefix = str_replace('/', '.', $prefix);
 
 		$search = $manager->createSearch();
 		$expr = array(
-				$search->compare( '==', $prefix . '.domain', $domain ),
-				$search->compare( '==', $prefix . '.code', $code ),
+				$search->compare('==', $prefix.'.domain', $domain),
+				$search->compare('==', $prefix.'.code', $code),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$result = $manager->searchItems( $search );
+		$search->setConditions($search->combine('&&', $expr));
+		$result = $manager->searchItems($search);
 
-		if( ( $item = reset( $result ) ) === false )
+		if (($item = reset($result)) === false)
 		{
-			$msg = sprintf( 'No type item for "%1$s/%2$s" in "%3$s" found', $domain, $code, $prefix );
-			throw new \Aimeos\Controller\Jobs\Exception( $msg );
+			$msg = sprintf('No type item for "%1$s/%2$s" in "%3$s" found', $domain, $code, $prefix);
+			throw new \Aimeos\Controller\Jobs\Exception($msg);
 		}
 
 		return $item;
@@ -543,9 +543,9 @@ 
 	 * @param string $confkey Configuration key prefix that matches all relevant settings for the component
 	 * @return string Cached entry or empty string if not available
 	 */
-	protected function getCached( $type, $uid, array $prefixes, $confkey )
+	protected function getCached($type, $uid, array $prefixes, $confkey)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$context = $this->getContext();
 			$config = $context->getConfig();
@@ -568,28 +568,28 @@ 
 			 * @category User
 			 * @see client/html/common/cache/tag-all
 			 */
-			$force = $config->get( 'client/html/common/cache/force', false );
+			$force = $config->get('client/html/common/cache/force', false);
 
-			if( $force == false && $context->getUserId() !== null ) {
+			if ($force == false && $context->getUserId() !== null) {
 				return null;
 			}
 
-			$cfg = $config->get( $confkey, array() );
+			$cfg = $config->get($confkey, array());
 
 			$keys = array(
-				'body' => $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':body', $cfg ),
-				'header' => $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':header', $cfg ),
+				'body' => $this->getParamHash($prefixes, $uid.':'.$confkey.':body', $cfg),
+				'header' => $this->getParamHash($prefixes, $uid.':'.$confkey.':header', $cfg),
 			);
 
-			$entries = $context->getCache()->getList( $keys );
+			$entries = $context->getCache()->getList($keys);
 			$this->cache = array();
 
-			foreach( $keys as $key => $hash ) {
-				$this->cache[$key] = ( array_key_exists( $hash, $entries ) ? $entries[$hash] : null );
+			foreach ($keys as $key => $hash) {
+				$this->cache[$key] = (array_key_exists($hash, $entries) ? $entries[$hash] : null);
 			}
 		}
 
-		return ( array_key_exists( $type, $this->cache ) ? $this->cache[$type] : null );
+		return (array_key_exists($type, $this->cache) ? $this->cache[$type] : null);
 	}
 
 
@@ -606,28 +606,28 @@ 
 	 * @param string|null $expire Date/time string in "YYYY-MM-DD HH:mm:ss"
 	 * 	format when the cache entry expires
 	 */
-	protected function setCached( $type, $uid, array $prefixes, $confkey, $value, array $tags, $expire )
+	protected function setCached($type, $uid, array $prefixes, $confkey, $value, array $tags, $expire)
 	{
 		$context = $this->getContext();
 		$config = $context->getConfig();
 
-		$force = $config->get( 'client/html/common/cache/force', false );
+		$force = $config->get('client/html/common/cache/force', false);
 
-		if( $force == false && $context->getUserId() !== null ) {
+		if ($force == false && $context->getUserId() !== null) {
 			return;
 		}
 
 		try
 		{
-			$cfg = $config->get( $confkey, array() );
-			$key = $this->getParamHash( $prefixes, $uid . ':' . $confkey . ':' . $type, $cfg );
+			$cfg = $config->get($confkey, array());
+			$key = $this->getParamHash($prefixes, $uid.':'.$confkey.':'.$type, $cfg);
 
-			$context->getCache()->set( $key, $value, array_unique( $tags ), $expire );
+			$context->getCache()->set($key, $value, array_unique($tags), $expire);
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$msg = sprintf( 'Unable to set cache entry: %1$s', $e->getMessage() );
-			$context->getLogger()->log( $msg, \Aimeos\MW\Logger\Base::NOTICE );
+			$msg = sprintf('Unable to set cache entry: %1$s', $e->getMessage());
+			$context->getLogger()->log($msg, \Aimeos\MW\Logger\Base::NOTICE);
 		}
 	}
 
@@ -639,19 +639,19 @@ 
 	 * @param string $section New section content
 	 * @param string $marker Name of the section marker without "<!-- " and " -->" parts
 	 */
-	protected function replaceSection( $content, $section, $marker )
+	protected function replaceSection($content, $section, $marker)
 	{
 		$start = 0;
-		$len = strlen( $section );
-		$marker = '<!-- ' . $marker . ' -->';
+		$len = strlen($section);
+		$marker = '<!-- '.$marker.' -->';
 
-		while( ( $start = @strpos( $content, $marker, $start ) ) !== false )
+		while (($start = @strpos($content, $marker, $start)) !== false)
 		{
-			if( ( $end = strpos( $content, $marker, $start + 1 ) ) !== false ) {
-				$content = substr_replace( $content, $section, $start, $end - $start + strlen( $marker ) );
+			if (($end = strpos($content, $marker, $start + 1)) !== false) {
+				$content = substr_replace($content, $section, $start, $end - $start + strlen($marker));
 			}
 
-			$start += 2 * strlen( $marker ) + $len;
+			$start += 2 * strlen($marker) + $len;
 		}
 
 		return $content;
@@ -666,7 +666,7 @@ 
 	 * @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
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
 		return $view;
 	}
@@ -678,17 +678,17 @@ 
 	 * @param array $codes Associative list of scope and object as key and error code as value
 	 * @return array List of translated error messages
 	 */
-	protected function translatePluginErrorCodes( array $codes )
+	protected function translatePluginErrorCodes(array $codes)
 	{
 		$errors = array();
 		$i18n = $this->context->getI18n();
 
-		foreach( $codes as $scope => $list )
+		foreach ($codes as $scope => $list)
 		{
-			foreach( $list as $object => $errcode )
+			foreach ($list as $object => $errcode)
 			{
-				$key = $scope . ( $scope !== 'product' ? '.' . $object : '' ) . '.' . $errcode;
-				$errors[] = $i18n->dt( 'mshop/code', $key );
+				$key = $scope.($scope !== 'product' ? '.'.$object : '').'.'.$errcode;
+				$errors[] = $i18n->dt('mshop/code', $key);
 			}
 		}
 

client/html/src/Client/Html/Catalog/Filter/Tree/Standard.php

Indentation +470 added lines, -470 removed lines

@@ -19,475 +19,475 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/filter/tree/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog filter tree 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/catalog/filter/tree/standard/subparts';
-	private $subPartNames = array();
-	private $tags = array();
-	private $expire;
-	private $cache;
-
-
-	/**
-	 * 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
-	 * @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 string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->treeBody = $html;
-
-		/** client/html/catalog/filter/tree/standard/template-body
-		 * Relative path to the HTML body template of the catalog filter tree 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/catalog/filter/tree/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/filter/tree/standard/template-body';
-		$default = 'catalog/filter/tree-body-default.php';
-
-		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
-	 * @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 string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->treeHeader = $html;
-
-		/** client/html/catalog/filter/tree/standard/template-header
-		 * Relative path to the HTML header template of the catalog filter tree client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in 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 head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/filter/tree/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/filter/tree/standard/template-header';
-		$default = 'catalog/filter/tree-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * 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( $type, $name = null )
-	{
-		/** client/html/catalog/filter/tree/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog filter tree 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/catalog/filter/tree/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/catalog/filter/tree/decorators/global
-		 * @see client/html/catalog/filter/tree/decorators/local
-		 */
-
-		/** client/html/catalog/filter/tree/decorators/global
-		 * Adds a list of globally available decorators only to the catalog filter tree 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/catalog/filter/tree/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/catalog/filter/tree/decorators/excludes
-		 * @see client/html/catalog/filter/tree/decorators/local
-		 */
-
-		/** client/html/catalog/filter/tree/decorators/local
-		 * Adds a list of local decorators only to the catalog filter tree 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\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/tree/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\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/catalog/filter/tree/decorators/excludes
-		 * @see client/html/catalog/filter/tree/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/filter/tree/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		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
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$catItems = array();
-			$context = $this->getContext();
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-			$currentid = (string) $view->param( 'f_catid', '' );
-			$currentid = ( $currentid != '' ? $currentid : null );
-
-			/** client/html/catalog/filter/tree/startid
-			 * The ID of the category node that should be the root of the displayed category tree
-			 *
-			 * If you want to display only a part of your category tree, you can
-			 * configure the ID of the category node from which rendering the
-			 * remaining sub-tree should start.
-			 *
-			 * In most cases you can set this value via the administration interface
-			 * of the shop application. In that case you often can configure the
-			 * start ID individually for each catalog filter.
-			 *
-			 * @param string Category ID
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/filter/tree/levels-always
-			 * @see client/html/catalog/filter/tree/levels-only
-			 * @see client/html/catalog/filter/tree/domains
-			 */
-			$startid = $view->config( 'client/html/catalog/filter/tree/startid', '' );
-			$startid = ( $startid != '' ? $startid : null );
-
-			/** client/html/catalog/filter/tree/domains
-			 * List of domain names whose items should be fetched with the filter categories
-			 *
-			 * The templates rendering the categories in the catalog filter usually
-			 * add the images and texts associated to each item. If you want to
-			 * display additional content, you can configure your own list of
-			 * domains (attribute, media, price, product, text, etc. are domains)
-			 * whose items are fetched from the storage. Please keep in mind that
-			 * the more domains you add to the configuration, the more time is
-			 * required for fetching the content!
-			 *
-			 * @param array List of domain item names
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/filter/tree/startid
-			 * @see client/html/catalog/filter/tree/levels-always
-			 * @see client/html/catalog/filter/tree/levels-only
-			 */
-			$ref = $view->config( 'client/html/catalog/filter/tree/domains', array( 'text', 'media' ) );
-
-
-			if( $currentid !== null ) {
-				$catItems = $this->filterCatalogPath( $controller->getCatalogPath( $currentid ), $startid );
-			}
-
-			if( ( $node = reset( $catItems ) ) === false )
-			{
-				$node = $controller->getCatalogTree( $startid, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
-				$catItems = array( $node->getId() => $node );
-			}
-
-
-			$catIds = array_keys( $catItems );
-			$search = $this->addSearchConditions( $controller->createCatalogFilter(), $catIds, $node->getId() );
-			$level = \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE;
-
-			$view->treeCatalogPath = $catItems;
-			$view->treeCatalogTree = $controller->getCatalogTree( $startid, $ref, $level, $search );
-			$view->treeCatalogIds = $this->getCatalogIds( $view->treeCatalogTree, $catItems, $currentid );
-			$view->treeFilterParams = $this->getClientParams( $view->param(), array( 'f' ) );
-
-			$this->addMetaItemCatalog( $view->treeCatalogTree, $this->expire, $this->tags );
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Adds the cache tags to the given list and sets a new expiration date if necessary based on the given catalog tree.
-	 *
-	 * @param \Aimeos\MShop\Catalog\Item\Iface $tree Tree node, maybe with sub-nodes
-	 * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
-	 * @param array &$tags List of tags the new tags will be added to
-	 */
-	protected function addMetaItemCatalog( \Aimeos\MShop\Catalog\Item\Iface $tree, &$expire, array &$tags = array() )
-	{
-		$this->addMetaItem( $tree, 'catalog', $expire, $tags );
-
-		foreach( $tree->getChildren() as $child ) {
-			$this->addMetaItemCatalog( $child, $expire, $tags );
-		}
-	}
-
-
-	/**
-	 * Adds the conditions for searching the catalog nodes
-	 *
-	 * @param \Aimeos\MW\Criteria\Iface $search Search object
-	 * @return \Aimeos\MW\Criteria\Iface Enhanced search object
-	 */
-	protected function addSearchConditions( \Aimeos\MW\Criteria\Iface $search, array $catIds, $catId )
-	{
-		$config = $this->getContext()->getConfig();
-
-		$expr = $search->compare( '==', 'catalog.parentid', $catIds );
-		$expr = $search->combine( '||', array( $expr, $search->compare( '==', 'catalog.id', $catId ) ) );
-
-		/** client/html/catalog/filter/tree/levels-always
-		 * The number of levels in the category tree that should be always displayed
-		 *
-		 * Usually, only the root node and the first level of the category
-		 * tree is shown in the frontend. Only if the user clicks on a
-		 * node in the first level, the page reloads and the sub-nodes of
-		 * the chosen category are rendered as well.
-		 *
-		 * Using this configuration option you can enforce the given number
-		 * of levels to be always displayed. The root node uses level 0, the
-		 * categories below level 1 and so on.
-		 *
-		 * In most cases you can set this value via the administration interface
-		 * of the shop application. In that case you often can configure the
-		 * levels individually for each catalog filter.
-		 *
-		 * @param integer Number of tree levels
-		 * @since 2014.03
-		 * @category User
-		 * @category Developer
-		 * @see client/html/catalog/filter/tree/startid
-		 * @see client/html/catalog/filter/tree/levels-only
-		 * @see client/html/catalog/filter/tree/domains
-		*/
-		if( ( $levels = $config->get( 'client/html/catalog/filter/tree/levels-always' ) ) != null ) {
-			$expr = $search->combine( '||', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
-		}
-
-		/** client/html/catalog/filter/tree/levels-only
-		 * No more than this number of levels in the category tree should be displayed
-		 *
-		 * If the user clicks on a category node, the page reloads and the
-		 * sub-nodes of the chosen category are rendered as well.
-		 * Using this configuration option you can enforce that no more than
-		 * the given number of levels will be displayed at all. The root
-		 * node uses level 0, the categories below level 1 and so on.
-		 *
-		 * In most cases you can set this value via the administration interface
-		 * of the shop application. In that case you often can configure the
-		 * levels individually for each catalog filter.
-		 *
-		 * @param integer Number of tree levels
-		 * @since 2014.03
-		 * @category User
-		 * @category Developer
-		 * @see client/html/catalog/filter/tree/startid
-		 * @see client/html/catalog/filter/tree/levels-always
-		 * @see client/html/catalog/filter/tree/domains
-		 */
-		if( ( $levels = $config->get( 'client/html/catalog/filter/tree/levels-only' ) ) != null ) {
-			$expr = $search->combine( '&&', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
-		}
-
-		$search->setConditions( $expr );
-
-		return $search;
-	}
-
-
-	/**
-	 * Returns the category IDs of the given catalog tree.
-	 *
-	 * Only the IDs of the children of the current category are returned.
-	 *
-	 * @param \Aimeos\MShop\Catalog\Item\Iface $tree Catalog node as entry point of the tree
-	 * @param array $path Associative list of category IDs as keys and the catalog
-	 * 	nodes from the currently selected category up to the root node
-	 * @param string $currentId Currently selected category
-	 * @return array List of category IDs
-	 */
-	protected function getCatalogIds( \Aimeos\MShop\Catalog\Item\Iface $tree, array $path, $currentId )
-	{
-		if( $tree->getId() == $currentId )
-		{
-			$ids = array();
-			foreach( $tree->getChildren() as $item ) {
-				$ids[] = $item->getId();
-			}
-
-			return $ids;
-		}
-
-		foreach( $tree->getChildren() as $child )
-		{
-			if( isset( $path[$child->getId()] ) ) {
-				return $this->getCatalogIds( $child, $path, $currentId );
-			}
-		}
-
-		return array();
-	}
-
-
-	/**
-	 * Filters the items in the path to the root of the catalog tree
-	 *
-	 * @param array $catItems Associative list of catalog IDs as keys and items implementing \Aimeos\Catalog\Item\Iface as values
-	 * @param string $startid Catalog ID the subtree starts from
-	 * @return array Filtered associative list of catalog items
-	 */
-	protected function filterCatalogPath( array $catItems, $startid )
-	{
-		if( $startid )
-		{
-			foreach( $catItems as $key => $item )
-			{
-				if( $key == $startid ) {
-					break;
-				}
-				unset( $catItems[$key] );
-			}
-		}
-
-		return $catItems;
-	}
+    /** client/html/catalog/filter/tree/standard/subparts
+     * List of HTML sub-clients rendered within the catalog filter tree 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/catalog/filter/tree/standard/subparts';
+    private $subPartNames = array();
+    private $tags = array();
+    private $expire;
+    private $cache;
+
+
+    /**
+     * 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
+     * @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 string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->treeBody = $html;
+
+        /** client/html/catalog/filter/tree/standard/template-body
+         * Relative path to the HTML body template of the catalog filter tree 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/catalog/filter/tree/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/filter/tree/standard/template-body';
+        $default = 'catalog/filter/tree-body-default.php';
+
+        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
+     * @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 string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->treeHeader = $html;
+
+        /** client/html/catalog/filter/tree/standard/template-header
+         * Relative path to the HTML header template of the catalog filter tree client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in 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 head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/filter/tree/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/filter/tree/standard/template-header';
+        $default = 'catalog/filter/tree-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * 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( $type, $name = null )
+    {
+        /** client/html/catalog/filter/tree/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog filter tree 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/catalog/filter/tree/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/catalog/filter/tree/decorators/global
+         * @see client/html/catalog/filter/tree/decorators/local
+         */
+
+        /** client/html/catalog/filter/tree/decorators/global
+         * Adds a list of globally available decorators only to the catalog filter tree 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/catalog/filter/tree/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/catalog/filter/tree/decorators/excludes
+         * @see client/html/catalog/filter/tree/decorators/local
+         */
+
+        /** client/html/catalog/filter/tree/decorators/local
+         * Adds a list of local decorators only to the catalog filter tree 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\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/tree/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\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/catalog/filter/tree/decorators/excludes
+         * @see client/html/catalog/filter/tree/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/filter/tree/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        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
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $catItems = array();
+            $context = $this->getContext();
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+            $currentid = (string) $view->param( 'f_catid', '' );
+            $currentid = ( $currentid != '' ? $currentid : null );
+
+            /** client/html/catalog/filter/tree/startid
+             * The ID of the category node that should be the root of the displayed category tree
+             *
+             * If you want to display only a part of your category tree, you can
+             * configure the ID of the category node from which rendering the
+             * remaining sub-tree should start.
+             *
+             * In most cases you can set this value via the administration interface
+             * of the shop application. In that case you often can configure the
+             * start ID individually for each catalog filter.
+             *
+             * @param string Category ID
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/filter/tree/levels-always
+             * @see client/html/catalog/filter/tree/levels-only
+             * @see client/html/catalog/filter/tree/domains
+             */
+            $startid = $view->config( 'client/html/catalog/filter/tree/startid', '' );
+            $startid = ( $startid != '' ? $startid : null );
+
+            /** client/html/catalog/filter/tree/domains
+             * List of domain names whose items should be fetched with the filter categories
+             *
+             * The templates rendering the categories in the catalog filter usually
+             * add the images and texts associated to each item. If you want to
+             * display additional content, you can configure your own list of
+             * domains (attribute, media, price, product, text, etc. are domains)
+             * whose items are fetched from the storage. Please keep in mind that
+             * the more domains you add to the configuration, the more time is
+             * required for fetching the content!
+             *
+             * @param array List of domain item names
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/filter/tree/startid
+             * @see client/html/catalog/filter/tree/levels-always
+             * @see client/html/catalog/filter/tree/levels-only
+             */
+            $ref = $view->config( 'client/html/catalog/filter/tree/domains', array( 'text', 'media' ) );
+
+
+            if( $currentid !== null ) {
+                $catItems = $this->filterCatalogPath( $controller->getCatalogPath( $currentid ), $startid );
+            }
+
+            if( ( $node = reset( $catItems ) ) === false )
+            {
+                $node = $controller->getCatalogTree( $startid, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
+                $catItems = array( $node->getId() => $node );
+            }
+
+
+            $catIds = array_keys( $catItems );
+            $search = $this->addSearchConditions( $controller->createCatalogFilter(), $catIds, $node->getId() );
+            $level = \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE;
+
+            $view->treeCatalogPath = $catItems;
+            $view->treeCatalogTree = $controller->getCatalogTree( $startid, $ref, $level, $search );
+            $view->treeCatalogIds = $this->getCatalogIds( $view->treeCatalogTree, $catItems, $currentid );
+            $view->treeFilterParams = $this->getClientParams( $view->param(), array( 'f' ) );
+
+            $this->addMetaItemCatalog( $view->treeCatalogTree, $this->expire, $this->tags );
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Adds the cache tags to the given list and sets a new expiration date if necessary based on the given catalog tree.
+     *
+     * @param \Aimeos\MShop\Catalog\Item\Iface $tree Tree node, maybe with sub-nodes
+     * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
+     * @param array &$tags List of tags the new tags will be added to
+     */
+    protected function addMetaItemCatalog( \Aimeos\MShop\Catalog\Item\Iface $tree, &$expire, array &$tags = array() )
+    {
+        $this->addMetaItem( $tree, 'catalog', $expire, $tags );
+
+        foreach( $tree->getChildren() as $child ) {
+            $this->addMetaItemCatalog( $child, $expire, $tags );
+        }
+    }
+
+
+    /**
+     * Adds the conditions for searching the catalog nodes
+     *
+     * @param \Aimeos\MW\Criteria\Iface $search Search object
+     * @return \Aimeos\MW\Criteria\Iface Enhanced search object
+     */
+    protected function addSearchConditions( \Aimeos\MW\Criteria\Iface $search, array $catIds, $catId )
+    {
+        $config = $this->getContext()->getConfig();
+
+        $expr = $search->compare( '==', 'catalog.parentid', $catIds );
+        $expr = $search->combine( '||', array( $expr, $search->compare( '==', 'catalog.id', $catId ) ) );
+
+        /** client/html/catalog/filter/tree/levels-always
+         * The number of levels in the category tree that should be always displayed
+         *
+         * Usually, only the root node and the first level of the category
+         * tree is shown in the frontend. Only if the user clicks on a
+         * node in the first level, the page reloads and the sub-nodes of
+         * the chosen category are rendered as well.
+         *
+         * Using this configuration option you can enforce the given number
+         * of levels to be always displayed. The root node uses level 0, the
+         * categories below level 1 and so on.
+         *
+         * In most cases you can set this value via the administration interface
+         * of the shop application. In that case you often can configure the
+         * levels individually for each catalog filter.
+         *
+         * @param integer Number of tree levels
+         * @since 2014.03
+         * @category User
+         * @category Developer
+         * @see client/html/catalog/filter/tree/startid
+         * @see client/html/catalog/filter/tree/levels-only
+         * @see client/html/catalog/filter/tree/domains
+         */
+        if( ( $levels = $config->get( 'client/html/catalog/filter/tree/levels-always' ) ) != null ) {
+            $expr = $search->combine( '||', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
+        }
+
+        /** client/html/catalog/filter/tree/levels-only
+         * No more than this number of levels in the category tree should be displayed
+         *
+         * If the user clicks on a category node, the page reloads and the
+         * sub-nodes of the chosen category are rendered as well.
+         * Using this configuration option you can enforce that no more than
+         * the given number of levels will be displayed at all. The root
+         * node uses level 0, the categories below level 1 and so on.
+         *
+         * In most cases you can set this value via the administration interface
+         * of the shop application. In that case you often can configure the
+         * levels individually for each catalog filter.
+         *
+         * @param integer Number of tree levels
+         * @since 2014.03
+         * @category User
+         * @category Developer
+         * @see client/html/catalog/filter/tree/startid
+         * @see client/html/catalog/filter/tree/levels-always
+         * @see client/html/catalog/filter/tree/domains
+         */
+        if( ( $levels = $config->get( 'client/html/catalog/filter/tree/levels-only' ) ) != null ) {
+            $expr = $search->combine( '&&', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
+        }
+
+        $search->setConditions( $expr );
+
+        return $search;
+    }
+
+
+    /**
+     * Returns the category IDs of the given catalog tree.
+     *
+     * Only the IDs of the children of the current category are returned.
+     *
+     * @param \Aimeos\MShop\Catalog\Item\Iface $tree Catalog node as entry point of the tree
+     * @param array $path Associative list of category IDs as keys and the catalog
+     * 	nodes from the currently selected category up to the root node
+     * @param string $currentId Currently selected category
+     * @return array List of category IDs
+     */
+    protected function getCatalogIds( \Aimeos\MShop\Catalog\Item\Iface $tree, array $path, $currentId )
+    {
+        if( $tree->getId() == $currentId )
+        {
+            $ids = array();
+            foreach( $tree->getChildren() as $item ) {
+                $ids[] = $item->getId();
+            }
+
+            return $ids;
+        }
+
+        foreach( $tree->getChildren() as $child )
+        {
+            if( isset( $path[$child->getId()] ) ) {
+                return $this->getCatalogIds( $child, $path, $currentId );
+            }
+        }
+
+        return array();
+    }
+
+
+    /**
+     * Filters the items in the path to the root of the catalog tree
+     *
+     * @param array $catItems Associative list of catalog IDs as keys and items implementing \Aimeos\Catalog\Item\Iface as values
+     * @param string $startid Catalog ID the subtree starts from
+     * @return array Filtered associative list of catalog items
+     */
+    protected function filterCatalogPath( array $catItems, $startid )
+    {
+        if( $startid )
+        {
+            foreach( $catItems as $key => $item )
+            {
+                if( $key == $startid ) {
+                    break;
+                }
+                unset( $catItems[$key] );
+            }
+        }
+
+        return $catItems;
+    }
 }

Spacing +57 added lines, -57 removed lines

@@ -70,13 +70,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->treeBody = $html;
 
@@ -103,7 +103,7 @@ 
 		$tplconf = 'client/html/catalog/filter/tree/standard/template-body';
 		$default = 'catalog/filter/tree-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -115,13 +115,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->treeHeader = $html;
 
@@ -149,7 +149,7 @@ 
 		$tplconf = 'client/html/catalog/filter/tree/standard/template-header';
 		$default = 'catalog/filter/tree-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -160,7 +160,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/filter/tree/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog filter tree html client
@@ -236,7 +236,7 @@ 
 		 * @see client/html/catalog/filter/tree/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/filter/tree/' . $type, $name );
+		return $this->createSubClient('catalog/filter/tree/'.$type, $name);
 	}
 
 
@@ -247,7 +247,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -259,16 +259,16 @@ 
 	 * @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
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$catItems = array();
 			$context = $this->getContext();
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+			$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
 
-			$currentid = (string) $view->param( 'f_catid', '' );
-			$currentid = ( $currentid != '' ? $currentid : null );
+			$currentid = (string) $view->param('f_catid', '');
+			$currentid = ($currentid != '' ? $currentid : null);
 
 			/** client/html/catalog/filter/tree/startid
 			 * The ID of the category node that should be the root of the displayed category tree
@@ -289,8 +289,8 @@ 
 			 * @see client/html/catalog/filter/tree/levels-only
 			 * @see client/html/catalog/filter/tree/domains
 			 */
-			$startid = $view->config( 'client/html/catalog/filter/tree/startid', '' );
-			$startid = ( $startid != '' ? $startid : null );
+			$startid = $view->config('client/html/catalog/filter/tree/startid', '');
+			$startid = ($startid != '' ? $startid : null);
 
 			/** client/html/catalog/filter/tree/domains
 			 * List of domain names whose items should be fetched with the filter categories
@@ -310,36 +310,36 @@ 
 			 * @see client/html/catalog/filter/tree/levels-always
 			 * @see client/html/catalog/filter/tree/levels-only
 			 */
-			$ref = $view->config( 'client/html/catalog/filter/tree/domains', array( 'text', 'media' ) );
+			$ref = $view->config('client/html/catalog/filter/tree/domains', array('text', 'media'));
 
 
-			if( $currentid !== null ) {
-				$catItems = $this->filterCatalogPath( $controller->getCatalogPath( $currentid ), $startid );
+			if ($currentid !== null) {
+				$catItems = $this->filterCatalogPath($controller->getCatalogPath($currentid), $startid);
 			}
 
-			if( ( $node = reset( $catItems ) ) === false )
+			if (($node = reset($catItems)) === false)
 			{
-				$node = $controller->getCatalogTree( $startid, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
-				$catItems = array( $node->getId() => $node );
+				$node = $controller->getCatalogTree($startid, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE);
+				$catItems = array($node->getId() => $node);
 			}
 
 
-			$catIds = array_keys( $catItems );
-			$search = $this->addSearchConditions( $controller->createCatalogFilter(), $catIds, $node->getId() );
+			$catIds = array_keys($catItems);
+			$search = $this->addSearchConditions($controller->createCatalogFilter(), $catIds, $node->getId());
 			$level = \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE;
 
 			$view->treeCatalogPath = $catItems;
-			$view->treeCatalogTree = $controller->getCatalogTree( $startid, $ref, $level, $search );
-			$view->treeCatalogIds = $this->getCatalogIds( $view->treeCatalogTree, $catItems, $currentid );
-			$view->treeFilterParams = $this->getClientParams( $view->param(), array( 'f' ) );
+			$view->treeCatalogTree = $controller->getCatalogTree($startid, $ref, $level, $search);
+			$view->treeCatalogIds = $this->getCatalogIds($view->treeCatalogTree, $catItems, $currentid);
+			$view->treeFilterParams = $this->getClientParams($view->param(), array('f'));
 
-			$this->addMetaItemCatalog( $view->treeCatalogTree, $this->expire, $this->tags );
+			$this->addMetaItemCatalog($view->treeCatalogTree, $this->expire, $this->tags);
 
 			$this->cache = $view;
 		}
 
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
+		$expire = $this->expires($this->expire, $expire);
+		$tags = array_merge($tags, $this->tags);
 
 		return $this->cache;
 	}
@@ -352,12 +352,12 @@ 
 	 * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
 	 * @param array &$tags List of tags the new tags will be added to
 	 */
-	protected function addMetaItemCatalog( \Aimeos\MShop\Catalog\Item\Iface $tree, &$expire, array &$tags = array() )
+	protected function addMetaItemCatalog(\Aimeos\MShop\Catalog\Item\Iface $tree, &$expire, array &$tags = array())
 	{
-		$this->addMetaItem( $tree, 'catalog', $expire, $tags );
+		$this->addMetaItem($tree, 'catalog', $expire, $tags);
 
-		foreach( $tree->getChildren() as $child ) {
-			$this->addMetaItemCatalog( $child, $expire, $tags );
+		foreach ($tree->getChildren() as $child) {
+			$this->addMetaItemCatalog($child, $expire, $tags);
 		}
 	}
 
@@ -368,12 +368,12 @@ 
 	 * @param \Aimeos\MW\Criteria\Iface $search Search object
 	 * @return \Aimeos\MW\Criteria\Iface Enhanced search object
 	 */
-	protected function addSearchConditions( \Aimeos\MW\Criteria\Iface $search, array $catIds, $catId )
+	protected function addSearchConditions(\Aimeos\MW\Criteria\Iface $search, array $catIds, $catId)
 	{
 		$config = $this->getContext()->getConfig();
 
-		$expr = $search->compare( '==', 'catalog.parentid', $catIds );
-		$expr = $search->combine( '||', array( $expr, $search->compare( '==', 'catalog.id', $catId ) ) );
+		$expr = $search->compare('==', 'catalog.parentid', $catIds);
+		$expr = $search->combine('||', array($expr, $search->compare('==', 'catalog.id', $catId)));
 
 		/** client/html/catalog/filter/tree/levels-always
 		 * The number of levels in the category tree that should be always displayed
@@ -399,8 +399,8 @@ 
 		 * @see client/html/catalog/filter/tree/levels-only
 		 * @see client/html/catalog/filter/tree/domains
 		*/
-		if( ( $levels = $config->get( 'client/html/catalog/filter/tree/levels-always' ) ) != null ) {
-			$expr = $search->combine( '||', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
+		if (($levels = $config->get('client/html/catalog/filter/tree/levels-always')) != null) {
+			$expr = $search->combine('||', array($expr, $search->compare('<=', 'catalog.level', $levels)));
 		}
 
 		/** client/html/catalog/filter/tree/levels-only
@@ -424,11 +424,11 @@ 
 		 * @see client/html/catalog/filter/tree/levels-always
 		 * @see client/html/catalog/filter/tree/domains
 		 */
-		if( ( $levels = $config->get( 'client/html/catalog/filter/tree/levels-only' ) ) != null ) {
-			$expr = $search->combine( '&&', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
+		if (($levels = $config->get('client/html/catalog/filter/tree/levels-only')) != null) {
+			$expr = $search->combine('&&', array($expr, $search->compare('<=', 'catalog.level', $levels)));
 		}
 
-		$search->setConditions( $expr );
+		$search->setConditions($expr);
 
 		return $search;
 	}
@@ -445,22 +445,22 @@ 
 	 * @param string $currentId Currently selected category
 	 * @return array List of category IDs
 	 */
-	protected function getCatalogIds( \Aimeos\MShop\Catalog\Item\Iface $tree, array $path, $currentId )
+	protected function getCatalogIds(\Aimeos\MShop\Catalog\Item\Iface $tree, array $path, $currentId)
 	{
-		if( $tree->getId() == $currentId )
+		if ($tree->getId() == $currentId)
 		{
 			$ids = array();
-			foreach( $tree->getChildren() as $item ) {
+			foreach ($tree->getChildren() as $item) {
 				$ids[] = $item->getId();
 			}
 
 			return $ids;
 		}
 
-		foreach( $tree->getChildren() as $child )
+		foreach ($tree->getChildren() as $child)
 		{
-			if( isset( $path[$child->getId()] ) ) {
-				return $this->getCatalogIds( $child, $path, $currentId );
+			if (isset($path[$child->getId()])) {
+				return $this->getCatalogIds($child, $path, $currentId);
 			}
 		}
 
@@ -475,16 +475,16 @@ 
 	 * @param string $startid Catalog ID the subtree starts from
 	 * @return array Filtered associative list of catalog items
 	 */
-	protected function filterCatalogPath( array $catItems, $startid )
+	protected function filterCatalogPath(array $catItems, $startid)
 	{
-		if( $startid )
+		if ($startid)
 		{
-			foreach( $catItems as $key => $item )
+			foreach ($catItems as $key => $item)
 			{
-				if( $key == $startid ) {
+				if ($key == $startid) {
 					break;
 				}
-				unset( $catItems[$key] );
+				unset($catItems[$key]);
 			}
 		}
 

client/html/tests/Client/Html/Catalog/Filter/Tree/StandardTest.php

Indentation +73 added lines, -73 removed lines

@@ -10,106 +10,106 @@
  */
 class StandardTest extends \PHPUnit_Framework_TestCase
 {
-	private $context;
-	private $object;
+    private $context;
+    private $object;
 
 
-	protected function setUp()
-	{
-		$paths = \TestHelperHtml::getHtmlTemplatePaths();
-		$this->context = \TestHelperHtml::getContext();
+    protected function setUp()
+    {
+        $paths = \TestHelperHtml::getHtmlTemplatePaths();
+        $this->context = \TestHelperHtml::getContext();
 
-		$this->object = new \Aimeos\Client\Html\Catalog\Filter\Tree\Standard( $this->context, $paths );
-		$this->object->setView( \TestHelperHtml::getView() );
-	}
+        $this->object = new \Aimeos\Client\Html\Catalog\Filter\Tree\Standard( $this->context, $paths );
+        $this->object->setView( \TestHelperHtml::getView() );
+    }
 
 
-	protected function tearDown()
-	{
-		unset( $this->context, $this->object );
-	}
+    protected function tearDown()
+    {
+        unset( $this->context, $this->object );
+    }
 
 
-	public function testGetHeader()
-	{
-		$tags = array();
-		$expire = null;
-		$output = $this->object->getHeader( 1, $tags, $expire );
+    public function testGetHeader()
+    {
+        $tags = array();
+        $expire = null;
+        $output = $this->object->getHeader( 1, $tags, $expire );
 
-		$this->assertNotNull( $output );
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 3, count( $tags ) );
-	}
+        $this->assertNotNull( $output );
+        $this->assertEquals( '2022-01-01 00:00:00', $expire );
+        $this->assertEquals( 3, count( $tags ) );
+    }
 
 
-	public function testGetBody()
-	{
-		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
-		$node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_LIST );
+    public function testGetBody()
+    {
+        $catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
+        $node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_LIST );
 
-		$view = $this->object->getView();
-		$helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getChild( 1 )->getId() ) );
-		$view->addHelper( 'param', $helper );
+        $view = $this->object->getView();
+        $helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getChild( 1 )->getId() ) );
+        $view->addHelper( 'param', $helper );
 
-		$tags = array();
-		$expire = null;
-		$output = $this->object->getBody( 1, $tags, $expire );
+        $tags = array();
+        $expire = null;
+        $output = $this->object->getBody( 1, $tags, $expire );
 
-		$this->assertContains( 'Groups', $output );
-		$this->assertContains( 'Neu', $output );
-		$this->assertContains( 'level-2', $output );
+        $this->assertContains( 'Groups', $output );
+        $this->assertContains( 'Neu', $output );
+        $this->assertContains( 'level-2', $output );
 
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 5, count( $tags ) );
-	}
+        $this->assertEquals( '2022-01-01 00:00:00', $expire );
+        $this->assertEquals( 5, count( $tags ) );
+    }
 
 
-	public function testGetBodyLevelsAlways()
-	{
-		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
-		$node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
+    public function testGetBodyLevelsAlways()
+    {
+        $catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
+        $node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
 
-		$this->context->getConfig()->set( 'client/html/catalog/filter/tree/levels-always', 2 );
+        $this->context->getConfig()->set( 'client/html/catalog/filter/tree/levels-always', 2 );
 
-		$view = $this->object->getView();
-		$helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getId() ) );
-		$view->addHelper( 'param', $helper );
+        $view = $this->object->getView();
+        $helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getId() ) );
+        $view->addHelper( 'param', $helper );
 
-		$tags = array();
-		$expire = null;
-		$output = $this->object->getBody( 1, $tags, $expire );
+        $tags = array();
+        $expire = null;
+        $output = $this->object->getBody( 1, $tags, $expire );
 
-		$this->assertContains( 'level-2', $output );
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 8, count( $tags ) );
-	}
+        $this->assertContains( 'level-2', $output );
+        $this->assertEquals( '2022-01-01 00:00:00', $expire );
+        $this->assertEquals( 8, count( $tags ) );
+    }
 
 
-	public function testGetBodyLevelsOnly()
-	{
-		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
-		$node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE );
+    public function testGetBodyLevelsOnly()
+    {
+        $catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
+        $node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE );
 
-		$this->context->getConfig()->set( 'client/html/catalog/filter/tree/levels-only', 1 );
+        $this->context->getConfig()->set( 'client/html/catalog/filter/tree/levels-only', 1 );
 
-		$view = $this->object->getView();
-		$helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getChild( 0 )->getId() ) );
-		$view->addHelper( 'param', $helper );
+        $view = $this->object->getView();
+        $helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getChild( 0 )->getId() ) );
+        $view->addHelper( 'param', $helper );
 
-		$tags = array();
-		$expire = null;
-		$output = $this->object->getBody( 1, $tags, $expire );
+        $tags = array();
+        $expire = null;
+        $output = $this->object->getBody( 1, $tags, $expire );
 
-		$this->assertNotContains( 'level-2', $output );
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 3, count( $tags ) );
-	}
+        $this->assertNotContains( 'level-2', $output );
+        $this->assertEquals( '2022-01-01 00:00:00', $expire );
+        $this->assertEquals( 3, count( $tags ) );
+    }
 
 
-	public function testGetSubClient()
-	{
-		$this->setExpectedException( '\\Aimeos\\Client\\Html\\Exception' );
-		$this->object->getSubClient( 'invalid', 'invalid' );
-	}
+    public function testGetSubClient()
+    {
+        $this->setExpectedException( '\\Aimeos\\Client\\Html\\Exception' );
+        $this->object->getSubClient( 'invalid', 'invalid' );
+    }
 
 }

Spacing +37 added lines, -37 removed lines

@@ -19,14 +19,14 @@ 
 		$paths = \TestHelperHtml::getHtmlTemplatePaths();
 		$this->context = \TestHelperHtml::getContext();
 
-		$this->object = new \Aimeos\Client\Html\Catalog\Filter\Tree\Standard( $this->context, $paths );
-		$this->object->setView( \TestHelperHtml::getView() );
+		$this->object = new \Aimeos\Client\Html\Catalog\Filter\Tree\Standard($this->context, $paths);
+		$this->object->setView(\TestHelperHtml::getView());
 	}
 
 
 	protected function tearDown()
 	{
-		unset( $this->context, $this->object );
+		unset($this->context, $this->object);
 	}
 
 
@@ -34,82 +34,82 @@ 
 	{
 		$tags = array();
 		$expire = null;
-		$output = $this->object->getHeader( 1, $tags, $expire );
+		$output = $this->object->getHeader(1, $tags, $expire);
 
-		$this->assertNotNull( $output );
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 3, count( $tags ) );
+		$this->assertNotNull($output);
+		$this->assertEquals('2022-01-01 00:00:00', $expire);
+		$this->assertEquals(3, count($tags));
 	}
 
 
 	public function testGetBody()
 	{
-		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
-		$node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_LIST );
+		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager(\TestHelperHtml::getContext());
+		$node = $catalogManager->getTree(null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_LIST);
 
 		$view = $this->object->getView();
-		$helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getChild( 1 )->getId() ) );
-		$view->addHelper( 'param', $helper );
+		$helper = new \Aimeos\MW\View\Helper\Param\Standard($view, array('f_catid' => $node->getChild(1)->getId()));
+		$view->addHelper('param', $helper);
 
 		$tags = array();
 		$expire = null;
-		$output = $this->object->getBody( 1, $tags, $expire );
+		$output = $this->object->getBody(1, $tags, $expire);
 
-		$this->assertContains( 'Groups', $output );
-		$this->assertContains( 'Neu', $output );
-		$this->assertContains( 'level-2', $output );
+		$this->assertContains('Groups', $output);
+		$this->assertContains('Neu', $output);
+		$this->assertContains('level-2', $output);
 
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 5, count( $tags ) );
+		$this->assertEquals('2022-01-01 00:00:00', $expire);
+		$this->assertEquals(5, count($tags));
 	}
 
 
 	public function testGetBodyLevelsAlways()
 	{
-		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
-		$node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
+		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager(\TestHelperHtml::getContext());
+		$node = $catalogManager->getTree(null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE);
 
-		$this->context->getConfig()->set( 'client/html/catalog/filter/tree/levels-always', 2 );
+		$this->context->getConfig()->set('client/html/catalog/filter/tree/levels-always', 2);
 
 		$view = $this->object->getView();
-		$helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getId() ) );
-		$view->addHelper( 'param', $helper );
+		$helper = new \Aimeos\MW\View\Helper\Param\Standard($view, array('f_catid' => $node->getId()));
+		$view->addHelper('param', $helper);
 
 		$tags = array();
 		$expire = null;
-		$output = $this->object->getBody( 1, $tags, $expire );
+		$output = $this->object->getBody(1, $tags, $expire);
 
-		$this->assertContains( 'level-2', $output );
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 8, count( $tags ) );
+		$this->assertContains('level-2', $output);
+		$this->assertEquals('2022-01-01 00:00:00', $expire);
+		$this->assertEquals(8, count($tags));
 	}
 
 
 	public function testGetBodyLevelsOnly()
 	{
-		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager( \TestHelperHtml::getContext() );
-		$node = $catalogManager->getTree( null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE );
+		$catalogManager = \Aimeos\MShop\Catalog\Manager\Factory::createManager(\TestHelperHtml::getContext());
+		$node = $catalogManager->getTree(null, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE);
 
-		$this->context->getConfig()->set( 'client/html/catalog/filter/tree/levels-only', 1 );
+		$this->context->getConfig()->set('client/html/catalog/filter/tree/levels-only', 1);
 
 		$view = $this->object->getView();
-		$helper = new \Aimeos\MW\View\Helper\Param\Standard( $view, array( 'f_catid' => $node->getChild( 0 )->getId() ) );
-		$view->addHelper( 'param', $helper );
+		$helper = new \Aimeos\MW\View\Helper\Param\Standard($view, array('f_catid' => $node->getChild(0)->getId()));
+		$view->addHelper('param', $helper);
 
 		$tags = array();
 		$expire = null;
-		$output = $this->object->getBody( 1, $tags, $expire );
+		$output = $this->object->getBody(1, $tags, $expire);
 
-		$this->assertNotContains( 'level-2', $output );
-		$this->assertEquals( '2022-01-01 00:00:00', $expire );
-		$this->assertEquals( 3, count( $tags ) );
+		$this->assertNotContains('level-2', $output);
+		$this->assertEquals('2022-01-01 00:00:00', $expire);
+		$this->assertEquals(3, count($tags));
 	}
 
 
 	public function testGetSubClient()
 	{
-		$this->setExpectedException( '\\Aimeos\\Client\\Html\\Exception' );
-		$this->object->getSubClient( 'invalid', 'invalid' );
+		$this->setExpectedException('\\Aimeos\\Client\\Html\\Exception');
+		$this->object->getSubClient('invalid', 'invalid');
 	}
 
 }