aimeos / ai-client-html

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

Indentation +340 added lines, -340 removed lines

@@ -23,345 +23,345 @@
  * @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/payment/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout standard payment 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/payment/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 )
-	{
-		$view = $this->getView();
-		$step = $view->get( 'standardStepActive' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
-
-		if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
-			return '';
-		}
-
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->paymentBody = $html;
-
-		/** client/html/checkout/standard/payment/standard/template-body
-		 * Relative path to the HTML body template of the checkout standard payment 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/payment/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/standard/payment/standard/template-body';
-		$default = 'checkout/standard/payment-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->getView();
-		$step = $view->get( 'standardStepActive' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
-
-		if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
-			return '';
-		}
-
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->paymentHeader = $html;
-
-		/** client/html/checkout/standard/payment/standard/template-header
-		 * Relative path to the HTML header template of the checkout standard payment 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/payment/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/standard/payment/standard/template-header';
-		$default = 'checkout/standard/payment-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/payment/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout standard payment 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/payment/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/payment/decorators/global
-		 * @see client/html/checkout/standard/payment/decorators/local
-		 */
-
-		/** client/html/checkout/standard/payment/decorators/global
-		 * Adds a list of globally available decorators only to the checkout standard payment 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/payment/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/payment/decorators/excludes
-		 * @see client/html/checkout/standard/payment/decorators/local
-		 */
-
-		/** client/html/checkout/standard/payment/decorators/local
-		 * Adds a list of local decorators only to the checkout standard payment 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/payment/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/payment/decorators/excludes
-		 * @see client/html/checkout/standard/payment/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/standard/payment/' . $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();
-
-		try
-		{
-			$context = $this->getContext();
-			$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-
-			// only start if there's something to do
-			if( ( $serviceId = $view->param( 'c_paymentoption', null ) ) !== null )
-			{
-				$serviceCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'service' );
-
-				$attributes = $view->param( 'c_payment/' . $serviceId, array() );
-				$errors = $serviceCtrl->checkServiceAttributes( 'payment', $serviceId, $attributes );
-
-				foreach( $errors as $key => $msg )
-				{
-					if( $msg === null ) {
-						unset( $errors[$key] );
-					}
-				}
-
-				if( count( $errors ) === 0 ) {
-					$basketCtrl->setService( 'payment', $serviceId, $attributes );
-				} else {
-					$view->standardStepActive = 'payment';
-				}
-
-				$view->paymentError = $errors;
-			}
-
-
-			parent::process();
-
-
-			// Test if payment service is available
-			$services = $basketCtrl->get()->getServices();
-			if( !isset( $view->standardStepActive ) && !array_key_exists( 'payment', $services ) )
-			{
-				$view->standardStepActive = 'payment';
-				return false;
-			}
-		}
-		catch( \Exception $e )
-		{
-			$view->standardStepActive = 'payment';
-			throw $e;
-		}
-	}
-
-
-	/**
-	 * 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' );
-			$serviceCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'service' );
-
-			$basket = $basketCntl->get();
-
-			$services = $serviceCntl->getServices( 'payment', $basket );
-			$serviceAttributes = $servicePrices = array();
-
-			foreach( $services as $id => $service )
-			{
-				$serviceAttributes[$id] = $serviceCntl->getServiceAttributes( 'payment', $id, $basket );
-				$servicePrices[$id] = $serviceCntl->getServicePrice( 'payment', $id, $basket );
-			}
-
-			$view->paymentServices = $services;
-			$view->paymentServiceAttributes = $serviceAttributes;
-			$view->paymentServicePrices = $servicePrices;
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/checkout/standard/payment/standard/subparts
+     * List of HTML sub-clients rendered within the checkout standard payment 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/payment/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 )
+    {
+        $view = $this->getView();
+        $step = $view->get( 'standardStepActive' );
+        $onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+
+        if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
+            return '';
+        }
+
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->paymentBody = $html;
+
+        /** client/html/checkout/standard/payment/standard/template-body
+         * Relative path to the HTML body template of the checkout standard payment 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/payment/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/standard/payment/standard/template-body';
+        $default = 'checkout/standard/payment-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->getView();
+        $step = $view->get( 'standardStepActive' );
+        $onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+
+        if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
+            return '';
+        }
+
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->paymentHeader = $html;
+
+        /** client/html/checkout/standard/payment/standard/template-header
+         * Relative path to the HTML header template of the checkout standard payment 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/payment/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/standard/payment/standard/template-header';
+        $default = 'checkout/standard/payment-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/payment/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout standard payment 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/payment/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/payment/decorators/global
+         * @see client/html/checkout/standard/payment/decorators/local
+         */
+
+        /** client/html/checkout/standard/payment/decorators/global
+         * Adds a list of globally available decorators only to the checkout standard payment 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/payment/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/payment/decorators/excludes
+         * @see client/html/checkout/standard/payment/decorators/local
+         */
+
+        /** client/html/checkout/standard/payment/decorators/local
+         * Adds a list of local decorators only to the checkout standard payment 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/payment/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/payment/decorators/excludes
+         * @see client/html/checkout/standard/payment/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/standard/payment/' . $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();
+
+        try
+        {
+            $context = $this->getContext();
+            $basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+
+            // only start if there's something to do
+            if( ( $serviceId = $view->param( 'c_paymentoption', null ) ) !== null )
+            {
+                $serviceCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'service' );
+
+                $attributes = $view->param( 'c_payment/' . $serviceId, array() );
+                $errors = $serviceCtrl->checkServiceAttributes( 'payment', $serviceId, $attributes );
+
+                foreach( $errors as $key => $msg )
+                {
+                    if( $msg === null ) {
+                        unset( $errors[$key] );
+                    }
+                }
+
+                if( count( $errors ) === 0 ) {
+                    $basketCtrl->setService( 'payment', $serviceId, $attributes );
+                } else {
+                    $view->standardStepActive = 'payment';
+                }
+
+                $view->paymentError = $errors;
+            }
+
+
+            parent::process();
+
+
+            // Test if payment service is available
+            $services = $basketCtrl->get()->getServices();
+            if( !isset( $view->standardStepActive ) && !array_key_exists( 'payment', $services ) )
+            {
+                $view->standardStepActive = 'payment';
+                return false;
+            }
+        }
+        catch( \Exception $e )
+        {
+            $view->standardStepActive = 'payment';
+            throw $e;
+        }
+    }
+
+
+    /**
+     * 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' );
+            $serviceCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'service' );
+
+            $basket = $basketCntl->get();
+
+            $services = $serviceCntl->getServices( 'payment', $basket );
+            $serviceAttributes = $servicePrices = array();
+
+            foreach( $services as $id => $service )
+            {
+                $serviceAttributes[$id] = $serviceCntl->getServiceAttributes( 'payment', $id, $basket );
+                $servicePrices[$id] = $serviceCntl->getServicePrice( 'payment', $id, $basket );
+            }
+
+            $view->paymentServices = $services;
+            $view->paymentServiceAttributes = $serviceAttributes;
+            $view->paymentServicePrices = $servicePrices;
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +40 added lines, -40 removed lines

@@ -13,7 +13,7 @@ 
 
 
 // Strings for translation
-sprintf( 'payment' );
+sprintf('payment');
 
 
 /**
@@ -72,21 +72,21 @@ 
 	 * @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->getView();
-		$step = $view->get( 'standardStepActive' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+		$step = $view->get('standardStepActive');
+		$onepage = $view->config('client/html/checkout/standard/onepage', array());
 
-		if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
+		if ($step != 'payment' && !(in_array('payment', $onepage) && in_array($step, $onepage))) {
 			return '';
 		}
 
-		$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->paymentBody = $html;
 
@@ -113,7 +113,7 @@ 
 		$tplconf = 'client/html/checkout/standard/payment/standard/template-body';
 		$default = 'checkout/standard/payment-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -125,21 +125,21 @@ 
 	 * @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->getView();
-		$step = $view->get( 'standardStepActive' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+		$step = $view->get('standardStepActive');
+		$onepage = $view->config('client/html/checkout/standard/onepage', array());
 
-		if( $step != 'payment' && !( in_array( 'payment', $onepage ) && in_array( $step, $onepage ) ) ) {
+		if ($step != 'payment' && !(in_array('payment', $onepage) && in_array($step, $onepage))) {
 			return '';
 		}
 
-		$view = $this->setViewParams( $view, $tags, $expire );
+		$view = $this->setViewParams($view, $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->paymentHeader = $html;
 
@@ -167,7 +167,7 @@ 
 		$tplconf = 'client/html/checkout/standard/payment/standard/template-header';
 		$default = 'checkout/standard/payment-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -178,7 +178,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/payment/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout standard payment html client
@@ -254,7 +254,7 @@ 
 		 * @see client/html/checkout/standard/payment/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/standard/payment/' . $type, $name );
+		return $this->createSubClient('checkout/standard/payment/'.$type, $name);
 	}
 
 
@@ -270,25 +270,25 @@ 
 		try
 		{
 			$context = $this->getContext();
-			$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+			$basketCtrl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
 
 			// only start if there's something to do
-			if( ( $serviceId = $view->param( 'c_paymentoption', null ) ) !== null )
+			if (($serviceId = $view->param('c_paymentoption', null)) !== null)
 			{
-				$serviceCtrl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'service' );
+				$serviceCtrl = \Aimeos\Controller\Frontend\Factory::createController($context, 'service');
 
-				$attributes = $view->param( 'c_payment/' . $serviceId, array() );
-				$errors = $serviceCtrl->checkServiceAttributes( 'payment', $serviceId, $attributes );
+				$attributes = $view->param('c_payment/'.$serviceId, array());
+				$errors = $serviceCtrl->checkServiceAttributes('payment', $serviceId, $attributes);
 
-				foreach( $errors as $key => $msg )
+				foreach ($errors as $key => $msg)
 				{
-					if( $msg === null ) {
-						unset( $errors[$key] );
+					if ($msg === null) {
+						unset($errors[$key]);
 					}
 				}
 
-				if( count( $errors ) === 0 ) {
-					$basketCtrl->setService( 'payment', $serviceId, $attributes );
+				if (count($errors) === 0) {
+					$basketCtrl->setService('payment', $serviceId, $attributes);
 				} else {
 					$view->standardStepActive = 'payment';
 				}
@@ -302,13 +302,13 @@ 
 
 			// Test if payment service is available
 			$services = $basketCtrl->get()->getServices();
-			if( !isset( $view->standardStepActive ) && !array_key_exists( 'payment', $services ) )
+			if (!isset($view->standardStepActive) && !array_key_exists('payment', $services))
 			{
 				$view->standardStepActive = 'payment';
 				return false;
 			}
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
 			$view->standardStepActive = 'payment';
 			throw $e;
@@ -323,7 +323,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -335,24 +335,24 @@ 
 	 * @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' );
-			$serviceCntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'service' );
+			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController($context, 'basket');
+			$serviceCntl = \Aimeos\Controller\Frontend\Factory::createController($context, 'service');
 
 			$basket = $basketCntl->get();
 
-			$services = $serviceCntl->getServices( 'payment', $basket );
+			$services = $serviceCntl->getServices('payment', $basket);
 			$serviceAttributes = $servicePrices = array();
 
-			foreach( $services as $id => $service )
+			foreach ($services as $id => $service)
 			{
-				$serviceAttributes[$id] = $serviceCntl->getServiceAttributes( 'payment', $id, $basket );
-				$servicePrices[$id] = $serviceCntl->getServicePrice( 'payment', $id, $basket );
+				$serviceAttributes[$id] = $serviceCntl->getServiceAttributes('payment', $id, $basket);
+				$servicePrices[$id] = $serviceCntl->getServicePrice('payment', $id, $basket);
 			}
 
 			$view->paymentServices = $services;

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @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
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

Braces +1 added lines, -2 removed lines

@@ -303,8 +303,7 @@
 				$view->standardStepActive = 'address';
 				return false;
 			}
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$this->getView()->standardStepActive = 'address';
 			throw $e;

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

Indentation +760 added lines, -760 removed lines

@@ -19,765 +19,765 @@
  * @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;
-			}
-
-			$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
-			{
-				$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
-
-				$search = $customerManager->createSearch( true );
-				$expr = array(
-					$search->compare( '==', 'customer.id', $option ),
-					$search->getConditions(),
-				);
-				$search->setConditions( $search->combine( '&&', $expr ) );
-
-				$items = $customerManager->searchItems( $search );
-
-				if( ( $item = reset( $items ) ) === false || $option != $context->getUserId() ) {
-					throw new \Aimeos\Client\Html\Exception( sprintf( 'Customer with ID "%1$s" not found', $option ) );
-				}
-
-				$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 );
-			}
-
-			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
-		 */
-
-		/** 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();
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
-
-		foreach( $params as $key => $value )
-		{
-			if( isset( $allFields[$key] ) )
-			{
-				$name = substr( $key, 19 );
-				$regex = $view->config( 'client/html/checkout/standard/address/validate/' . $name );
-
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
-				{
-					$msg = $view->translate( 'client', 'Billing address part "%1$s" is invalid' );
-					$invalid[$key] = sprintf( $msg, $name );
-					unset( $params[$key] );
-				}
-			}
-			else
-			{
-				unset( $params[$key] );
-			}
-		}
-
-
-		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'] = '';
-		}
-
-		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;
-	}
-
-
-	/**
-	 * 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' );
-
-			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;
-	}
+    /** 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;
+            }
+
+            $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
+            {
+                $customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
+
+                $search = $customerManager->createSearch( true );
+                $expr = array(
+                    $search->compare( '==', 'customer.id', $option ),
+                    $search->getConditions(),
+                );
+                $search->setConditions( $search->combine( '&&', $expr ) );
+
+                $items = $customerManager->searchItems( $search );
+
+                if( ( $item = reset( $items ) ) === false || $option != $context->getUserId() ) {
+                    throw new \Aimeos\Client\Html\Exception( sprintf( 'Customer with ID "%1$s" not found', $option ) );
+                }
+
+                $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 );
+            }
+
+            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
+         */
+
+        /** 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();
+        $allFields = array_flip( array_merge( $mandatory, $optional ) );
+
+        foreach( $params as $key => $value )
+        {
+            if( isset( $allFields[$key] ) )
+            {
+                $name = substr( $key, 19 );
+                $regex = $view->config( 'client/html/checkout/standard/address/validate/' . $name );
+
+                if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+                {
+                    $msg = $view->translate( 'client', 'Billing address part "%1$s" is invalid' );
+                    $invalid[$key] = sprintf( $msg, $name );
+                    unset( $params[$key] );
+                }
+            }
+            else
+            {
+                unset( $params[$key] );
+            }
+        }
+
+
+        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'] = '';
+        }
+
+        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;
+    }
+
+
+    /**
+     * 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' );
+
+            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;
+    }
 }
\ No newline at end of file

Spacing +73 added lines, -73 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,12 +267,12 @@ 
 		try
 		{
 			// only start if there's something to do
-			if( $view->param( 'ca_billingoption', null ) === null ) {
+			if ($view->param('ca_billingoption', null) === null) {
 				return;
 			}
 
 			$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
@@ -294,70 +294,70 @@ 
 			 * @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
 			{
-				$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', $option ),
+					$search->compare('==', 'customer.id', $option),
 					$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 || $option != $context->getUserId() ) {
-					throw new \Aimeos\Client\Html\Exception( sprintf( 'Customer with ID "%1$s" not found', $option ) );
+				if (($item = reset($items)) === false || $option != $context->getUserId()) {
+					throw new \Aimeos\Client\Html\Exception(sprintf('Customer with ID "%1$s" not found', $option));
 				}
 
 				$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);
 			}
 
 			parent::process();
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
 			$view->billingError = $e->getErrorList();
 			throw $e;
@@ -371,7 +371,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();
 
@@ -413,7 +413,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
@@ -453,7 +453,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
@@ -615,45 +615,45 @@ 
 		 */
 
 		$invalid = array();
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
+		$allFields = array_flip(array_merge($mandatory, $optional));
 
-		foreach( $params as $key => $value )
+		foreach ($params as $key => $value)
 		{
-			if( isset( $allFields[$key] ) )
+			if (isset($allFields[$key]))
 			{
-				$name = substr( $key, 19 );
-				$regex = $view->config( 'client/html/checkout/standard/address/validate/' . $name );
+				$name = substr($key, 19);
+				$regex = $view->config('client/html/checkout/standard/address/validate/'.$name);
 
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+				if ($regex && preg_match('/'.$regex.'/', $value) !== 1)
 				{
-					$msg = $view->translate( 'client', 'Billing address part "%1$s" is invalid' );
-					$invalid[$key] = sprintf( $msg, $name );
-					unset( $params[$key] );
+					$msg = $view->translate('client', 'Billing address part "%1$s" is invalid');
+					$invalid[$key] = sprintf($msg, $name);
+					unset($params[$key]);
 				}
 			}
 			else
 			{
-				unset( $params[$key] );
+				unset($params[$key]);
 			}
 		}
 
 
-		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 {
 			$params['order.base.address.company'] = $params['order.base.address.vatid'] = '';
 		}
 
-		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]);
 			}
 		}
 
@@ -668,7 +668,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -680,17 +680,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;
 
@@ -733,13 +733,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
@@ -769,10 +769,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;

Braces +6 added lines, -7 removed lines

@@ -297,9 +297,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 )
@@ -309,8 +311,7 @@ 
 				}
 
 				$basketCtrl->setAddress( $type, $params );
-			}
-			else // existing address
+			} else // existing address
 			{
 				$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
 
@@ -356,8 +357,7 @@ 
 			}
 
 			parent::process();
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
 		{
 			$view->billingError = $e->getErrorList();
 			throw $e;
@@ -630,8 +630,7 @@ 
 					$invalid[$key] = sprintf( $msg, $name );
 					unset( $params[$key] );
 				}
-			}
-			else
+			} else
 			{
 				unset( $params[$key] );
 			}

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @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
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

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

Indentation +449 added lines, -449 removed lines

@@ -23,454 +23,454 @@
  * @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/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout standard address section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/checkout/standard/address/standard/subparts';
-
-	/** client/html/checkout/standard/address/billing/name
-	 * Name of the billing part used by the checkout standard address client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Billing\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
-
-	/** client/html/checkout/standard/address/delivery/name
-	 * Name of the delivery part used by the checkout standard address client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Delivery\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'billing', 'delivery' );
-
-	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->getView();
-		$step = $view->get( 'standardStepActive', 'address' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
-
-		if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
-			return '';
-		}
-
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->addressBody = $html;
-
-		/** client/html/checkout/standard/address/standard/template-body
-		 * Relative path to the HTML body template of the checkout standard address client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/standard/address/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/standard/address/standard/template-body';
-		$default = 'checkout/standard/address-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->getView();
-		$step = $view->get( 'standardStepActive' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
-
-		if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
-			return '';
-		}
-
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->addressHeader = $html;
-
-		/** client/html/checkout/standard/address/standard/template-header
-		 * Relative path to the HTML header template of the checkout standard address 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/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/standard/address/standard/template-header';
-		$default = 'checkout/standard/address-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/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout standard address html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/checkout/standard/address/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/standard/address/decorators/global
-		 * @see client/html/checkout/standard/address/decorators/local
-		 */
-
-		/** client/html/checkout/standard/address/decorators/global
-		 * Adds a list of globally available decorators only to the checkout standard address html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/checkout/standard/address/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/standard/address/decorators/excludes
-		 * @see client/html/checkout/standard/address/decorators/local
-		 */
-
-		/** client/html/checkout/standard/address/decorators/local
-		 * Adds a list of local decorators only to the checkout standard address html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
-		 *
-		 *  client/html/checkout/standard/address/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/standard/address/decorators/excludes
-		 * @see client/html/checkout/standard/address/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/standard/address/' . $type, $name );
-	}
-
-
-	/**
-	 * Processes the input, e.g. store given values.
-	 * A view must be available and this method doesn't generate any output
-	 * besides setting view variables.
-	 */
-	public function process()
-	{
-		$view = $this->getView();
-
-		try
-		{
-			parent::process();
-
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
-
-			// Test if addresses are available
-			$addresses = $basketCntl->get()->getAddresses();
-			if( !isset( $view->standardStepActive ) && count( $addresses ) === 0 )
-			{
-				$view->standardStepActive = 'address';
-				return false;
-			}
-		}
-		catch( \Exception $e )
-		{
-			$this->getView()->standardStepActive = 'address';
-			throw $e;
-		}
-
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		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();
-
-
-			$customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
-
-			$search = $customerManager->createSearch( true );
-			$expr = array(
-				$search->compare( '==', 'customer.id', $context->getUserId() ),
-				$search->getConditions(),
-			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-
-			$items = $customerManager->searchItems( $search );
-
-			if( ( $item = reset( $items ) ) !== false )
-			{
-				$deliveryAddressItems = array();
-
-				$orderAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/address' );
-				$customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
-
-				$search = $customerAddressManager->createSearch();
-				$search->setConditions( $search->compare( '==', 'customer.address.parentid', $item->getId() ) );
-
-				foreach( $customerAddressManager->searchItems( $search ) as $id => $address )
-				{
-					$deliveryAddressItem = $orderAddressManager->createItem();
-					$deliveryAddressItem->copyFrom( $address );
-
-					$deliveryAddressItems[$id] = $deliveryAddressItem;
-				}
-
-				$paymentAddressItem = $orderAddressManager->createItem();
-				$paymentAddressItem->copyFrom( $item->getPaymentAddress() );
-
-				$view->addressCustomerItem = $item;
-				$view->addressPaymentItem = $paymentAddressItem;
-				$view->addressDeliveryItems = $deliveryAddressItems;
-			}
-
-
-			$localeManager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
-			$locales = $localeManager->searchItems( $localeManager->createSearch( true ) );
-
-			$languages = array();
-			foreach( $locales as $locale ) {
-				$languages[$locale->getLanguageId()] = $locale->getLanguageId();
-			}
-
-			$view->addressLanguages = $languages;
-
-			/** client/html/checkout/standard/address/countries
-			 * List of available countries that that users can select from in the front-end
-			 *
-			 * This configration option is used whenever a list of countries is
-			 * shown in the front-end users can select from. It's used e.g.
-			 * if the customer should select the country he is living in the
-			 * checkout process. In case that the list is empty, no country
-			 * selection is shown.
-			 *
-			 * Each list entry must be a two letter ISO country code that is then
-			 * translated into its name. The codes have to be upper case
-			 * characters like "DE" for Germany or "GB" for Great Britain, e.g.
-			 *
-			 *  array( 'DE', 'GB', ... )
-			 *
-			 * To display the country selection, you have to add the key for the
-			 * country ID (order.base.address.languageid) to the "mandatory" or
-			 * "optional" configuration option for billing and delivery addresses.
-			 *
-			 * Until 2015-02, the configuration option was available as
-			 * "client/html/common/address/countries" starting from 2014-03.
-			 *
-			 * @param array List of two letter ISO country codes
-			 * @since 2015.02
-			 * @category User
-			 * @category Developer
-			 * @see client/html/checkout/standard/address/billing/mandatory
-			 * @see client/html/checkout/standard/address/billing/optional
-			 * @see client/html/checkout/standard/address/delivery/mandatory
-			 * @see client/html/checkout/standard/address/delivery/optional
-			 */
-			$view->addressCountries = $view->config( 'client/html/checkout/standard/address/countries', array() );
-
-			/** client/html/checkout/standard/address/states
-			 * List of available states that that users can select from in the front-end
-			 *
-			 * This configration option is used whenever a list of states is
-			 * shown in the front-end users can select from. It's used e.g.
-			 * if the customer should select the state he is living in the
-			 * checkout process. In case that the list is empty, no state
-			 * selection is shown.
-			 *
-			 * A two letter ISO country code must be the key for the list of
-			 * states that belong to this country. The list of states must then
-			 * contain the state code as key and its name as values, e.g.
-			 *
-			 *  array(
-			 *      'US' => array(
-			 *          'CA' => 'California',
-			 *          'NY' => 'New York',
-			 *          ...
-			 *      ),
-			 *      ...
-			 *  );
-			 *
-			 * The codes have to be upper case characters like "US" for the
-			 * United States or "DE" for Germany. The order of the country and
-			 * state codes determine the order of the states in the frontend and
-			 * the state codes are later used for per state tax calculation.
-			 *
-			 * To display the country selection, you have to add the key for the
-			 * state (order.base.address.state) to the "mandatory" or
-			 * "optional" configuration option for billing and delivery addresses.
-			 * You also need to add order.base.address.countryid as well because
-			 * it is required to display the states that belong to this country.
-			 *
-			 * Until 2015-02, the configuration option was available as
-			 * "client/html/common/address/states" starting from 2014-09.
-			 *
-			 * @param array Multi-dimensional list ISO country codes and state codes/names
-			 * @since 2015.02
-			 * @category User
-			 * @category Developer
-			 * @see client/html/checkout/standard/address/billing/mandatory
-			 * @see client/html/checkout/standard/address/billing/optional
-			 * @see client/html/checkout/standard/address/delivery/mandatory
-			 * @see client/html/checkout/standard/address/delivery/optional
-			 */
-			$view->addressStates = $view->config( 'client/html/checkout/standard/address/states', array() );
-
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/checkout/standard/address/standard/subparts
+     * List of HTML sub-clients rendered within the checkout standard address section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/checkout/standard/address/standard/subparts';
+
+    /** client/html/checkout/standard/address/billing/name
+     * Name of the billing part used by the checkout standard address client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Billing\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
+
+    /** client/html/checkout/standard/address/delivery/name
+     * Name of the delivery part used by the checkout standard address client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Checkout\Standard\Address\Delivery\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartNames = array( 'billing', 'delivery' );
+
+    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->getView();
+        $step = $view->get( 'standardStepActive', 'address' );
+        $onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+
+        if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
+            return '';
+        }
+
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->addressBody = $html;
+
+        /** client/html/checkout/standard/address/standard/template-body
+         * Relative path to the HTML body template of the checkout standard address client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/standard/address/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/standard/address/standard/template-body';
+        $default = 'checkout/standard/address-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->getView();
+        $step = $view->get( 'standardStepActive' );
+        $onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+
+        if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
+            return '';
+        }
+
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->addressHeader = $html;
+
+        /** client/html/checkout/standard/address/standard/template-header
+         * Relative path to the HTML header template of the checkout standard address 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/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/standard/address/standard/template-header';
+        $default = 'checkout/standard/address-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/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout standard address html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/checkout/standard/address/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/standard/address/decorators/global
+         * @see client/html/checkout/standard/address/decorators/local
+         */
+
+        /** client/html/checkout/standard/address/decorators/global
+         * Adds a list of globally available decorators only to the checkout standard address html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/checkout/standard/address/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/standard/address/decorators/excludes
+         * @see client/html/checkout/standard/address/decorators/local
+         */
+
+        /** client/html/checkout/standard/address/decorators/local
+         * Adds a list of local decorators only to the checkout standard address html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
+         *
+         *  client/html/checkout/standard/address/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/standard/address/decorators/excludes
+         * @see client/html/checkout/standard/address/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/standard/address/' . $type, $name );
+    }
+
+
+    /**
+     * Processes the input, e.g. store given values.
+     * A view must be available and this method doesn't generate any output
+     * besides setting view variables.
+     */
+    public function process()
+    {
+        $view = $this->getView();
+
+        try
+        {
+            parent::process();
+
+            $basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
+
+            // Test if addresses are available
+            $addresses = $basketCntl->get()->getAddresses();
+            if( !isset( $view->standardStepActive ) && count( $addresses ) === 0 )
+            {
+                $view->standardStepActive = 'address';
+                return false;
+            }
+        }
+        catch( \Exception $e )
+        {
+            $this->getView()->standardStepActive = 'address';
+            throw $e;
+        }
+
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        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();
+
+
+            $customerManager = \Aimeos\MShop\Factory::createManager( $context, 'customer' );
+
+            $search = $customerManager->createSearch( true );
+            $expr = array(
+                $search->compare( '==', 'customer.id', $context->getUserId() ),
+                $search->getConditions(),
+            );
+            $search->setConditions( $search->combine( '&&', $expr ) );
+
+            $items = $customerManager->searchItems( $search );
+
+            if( ( $item = reset( $items ) ) !== false )
+            {
+                $deliveryAddressItems = array();
+
+                $orderAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/address' );
+                $customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
+
+                $search = $customerAddressManager->createSearch();
+                $search->setConditions( $search->compare( '==', 'customer.address.parentid', $item->getId() ) );
+
+                foreach( $customerAddressManager->searchItems( $search ) as $id => $address )
+                {
+                    $deliveryAddressItem = $orderAddressManager->createItem();
+                    $deliveryAddressItem->copyFrom( $address );
+
+                    $deliveryAddressItems[$id] = $deliveryAddressItem;
+                }
+
+                $paymentAddressItem = $orderAddressManager->createItem();
+                $paymentAddressItem->copyFrom( $item->getPaymentAddress() );
+
+                $view->addressCustomerItem = $item;
+                $view->addressPaymentItem = $paymentAddressItem;
+                $view->addressDeliveryItems = $deliveryAddressItems;
+            }
+
+
+            $localeManager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
+            $locales = $localeManager->searchItems( $localeManager->createSearch( true ) );
+
+            $languages = array();
+            foreach( $locales as $locale ) {
+                $languages[$locale->getLanguageId()] = $locale->getLanguageId();
+            }
+
+            $view->addressLanguages = $languages;
+
+            /** client/html/checkout/standard/address/countries
+             * List of available countries that that users can select from in the front-end
+             *
+             * This configration option is used whenever a list of countries is
+             * shown in the front-end users can select from. It's used e.g.
+             * if the customer should select the country he is living in the
+             * checkout process. In case that the list is empty, no country
+             * selection is shown.
+             *
+             * Each list entry must be a two letter ISO country code that is then
+             * translated into its name. The codes have to be upper case
+             * characters like "DE" for Germany or "GB" for Great Britain, e.g.
+             *
+             *  array( 'DE', 'GB', ... )
+             *
+             * To display the country selection, you have to add the key for the
+             * country ID (order.base.address.languageid) to the "mandatory" or
+             * "optional" configuration option for billing and delivery addresses.
+             *
+             * Until 2015-02, the configuration option was available as
+             * "client/html/common/address/countries" starting from 2014-03.
+             *
+             * @param array List of two letter ISO country codes
+             * @since 2015.02
+             * @category User
+             * @category Developer
+             * @see client/html/checkout/standard/address/billing/mandatory
+             * @see client/html/checkout/standard/address/billing/optional
+             * @see client/html/checkout/standard/address/delivery/mandatory
+             * @see client/html/checkout/standard/address/delivery/optional
+             */
+            $view->addressCountries = $view->config( 'client/html/checkout/standard/address/countries', array() );
+
+            /** client/html/checkout/standard/address/states
+             * List of available states that that users can select from in the front-end
+             *
+             * This configration option is used whenever a list of states is
+             * shown in the front-end users can select from. It's used e.g.
+             * if the customer should select the state he is living in the
+             * checkout process. In case that the list is empty, no state
+             * selection is shown.
+             *
+             * A two letter ISO country code must be the key for the list of
+             * states that belong to this country. The list of states must then
+             * contain the state code as key and its name as values, e.g.
+             *
+             *  array(
+             *      'US' => array(
+             *          'CA' => 'California',
+             *          'NY' => 'New York',
+             *          ...
+             *      ),
+             *      ...
+             *  );
+             *
+             * The codes have to be upper case characters like "US" for the
+             * United States or "DE" for Germany. The order of the country and
+             * state codes determine the order of the states in the frontend and
+             * the state codes are later used for per state tax calculation.
+             *
+             * To display the country selection, you have to add the key for the
+             * state (order.base.address.state) to the "mandatory" or
+             * "optional" configuration option for billing and delivery addresses.
+             * You also need to add order.base.address.countryid as well because
+             * it is required to display the states that belong to this country.
+             *
+             * Until 2015-02, the configuration option was available as
+             * "client/html/common/address/states" starting from 2014-09.
+             *
+             * @param array Multi-dimensional list ISO country codes and state codes/names
+             * @since 2015.02
+             * @category User
+             * @category Developer
+             * @see client/html/checkout/standard/address/billing/mandatory
+             * @see client/html/checkout/standard/address/billing/optional
+             * @see client/html/checkout/standard/address/delivery/mandatory
+             * @see client/html/checkout/standard/address/delivery/optional
+             */
+            $view->addressStates = $view->config( 'client/html/checkout/standard/address/states', array() );
+
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +43 added lines, -43 removed lines

@@ -13,7 +13,7 @@ 
 
 
 // Strings for translation
-sprintf( 'address' );
+sprintf('address');
 
 
 /**
@@ -82,7 +82,7 @@ 
 	 * @since 2014.03
 	 * @category Developer
 	 */
-	private $subPartNames = array( 'billing', 'delivery' );
+	private $subPartNames = array('billing', 'delivery');
 
 	private $cache;
 
@@ -95,21 +95,21 @@ 
 	 * @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->getView();
-		$step = $view->get( 'standardStepActive', 'address' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+		$step = $view->get('standardStepActive', 'address');
+		$onepage = $view->config('client/html/checkout/standard/onepage', array());
 
-		if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
+		if ($step != 'address' && !(in_array('address', $onepage) && in_array($step, $onepage))) {
 			return '';
 		}
 
-		$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->addressBody = $html;
 
@@ -136,7 +136,7 @@ 
 		$tplconf = 'client/html/checkout/standard/address/standard/template-body';
 		$default = 'checkout/standard/address-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -148,21 +148,21 @@ 
 	 * @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->getView();
-		$step = $view->get( 'standardStepActive' );
-		$onepage = $view->config( 'client/html/checkout/standard/onepage', array() );
+		$step = $view->get('standardStepActive');
+		$onepage = $view->config('client/html/checkout/standard/onepage', array());
 
-		if( $step != 'address' && !( in_array( 'address', $onepage ) && in_array( $step, $onepage ) ) ) {
+		if ($step != 'address' && !(in_array('address', $onepage) && in_array($step, $onepage))) {
 			return '';
 		}
 
-		$view = $this->setViewParams( $view, $tags, $expire );
+		$view = $this->setViewParams($view, $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->addressHeader = $html;
 
@@ -190,7 +190,7 @@ 
 		$tplconf = 'client/html/checkout/standard/address/standard/template-header';
 		$default = 'checkout/standard/address-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -201,7 +201,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/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout standard address html client
@@ -277,7 +277,7 @@ 
 		 * @see client/html/checkout/standard/address/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/standard/address/' . $type, $name );
+		return $this->createSubClient('checkout/standard/address/'.$type, $name);
 	}
 
 
@@ -294,17 +294,17 @@ 
 		{
 			parent::process();
 
-			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
+			$basketCntl = \Aimeos\Controller\Frontend\Factory::createController($this->getContext(), 'basket');
 
 			// Test if addresses are available
 			$addresses = $basketCntl->get()->getAddresses();
-			if( !isset( $view->standardStepActive ) && count( $addresses ) === 0 )
+			if (!isset($view->standardStepActive) && count($addresses) === 0)
 			{
 				$view->standardStepActive = 'address';
 				return false;
 			}
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
 			$this->getView()->standardStepActive = 'address';
 			throw $e;
@@ -320,7 +320,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -332,44 +332,44 @@ 
 	 * @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();
 
 
-			$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', $context->getUserId() ),
+				$search->compare('==', 'customer.id', $context->getUserId()),
 				$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 )
+			if (($item = reset($items)) !== false)
 			{
 				$deliveryAddressItems = array();
 
-				$orderAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/address' );
-				$customerAddressManager = \Aimeos\MShop\Factory::createManager( $context, 'customer/address' );
+				$orderAddressManager = \Aimeos\MShop\Factory::createManager($context, 'order/base/address');
+				$customerAddressManager = \Aimeos\MShop\Factory::createManager($context, 'customer/address');
 
 				$search = $customerAddressManager->createSearch();
-				$search->setConditions( $search->compare( '==', 'customer.address.parentid', $item->getId() ) );
+				$search->setConditions($search->compare('==', 'customer.address.parentid', $item->getId()));
 
-				foreach( $customerAddressManager->searchItems( $search ) as $id => $address )
+				foreach ($customerAddressManager->searchItems($search) as $id => $address)
 				{
 					$deliveryAddressItem = $orderAddressManager->createItem();
-					$deliveryAddressItem->copyFrom( $address );
+					$deliveryAddressItem->copyFrom($address);
 
 					$deliveryAddressItems[$id] = $deliveryAddressItem;
 				}
 
 				$paymentAddressItem = $orderAddressManager->createItem();
-				$paymentAddressItem->copyFrom( $item->getPaymentAddress() );
+				$paymentAddressItem->copyFrom($item->getPaymentAddress());
 
 				$view->addressCustomerItem = $item;
 				$view->addressPaymentItem = $paymentAddressItem;
@@ -377,11 +377,11 @@ 
 			}
 
 
-			$localeManager = \Aimeos\MShop\Factory::createManager( $context, 'locale' );
-			$locales = $localeManager->searchItems( $localeManager->createSearch( true ) );
+			$localeManager = \Aimeos\MShop\Factory::createManager($context, 'locale');
+			$locales = $localeManager->searchItems($localeManager->createSearch(true));
 
 			$languages = array();
-			foreach( $locales as $locale ) {
+			foreach ($locales as $locale) {
 				$languages[$locale->getLanguageId()] = $locale->getLanguageId();
 			}
 
@@ -418,7 +418,7 @@ 
 			 * @see client/html/checkout/standard/address/delivery/mandatory
 			 * @see client/html/checkout/standard/address/delivery/optional
 			 */
-			$view->addressCountries = $view->config( 'client/html/checkout/standard/address/countries', array() );
+			$view->addressCountries = $view->config('client/html/checkout/standard/address/countries', array());
 
 			/** client/html/checkout/standard/address/states
 			 * List of available states that that users can select from in the front-end
@@ -465,7 +465,7 @@ 
 			 * @see client/html/checkout/standard/address/delivery/mandatory
 			 * @see client/html/checkout/standard/address/delivery/optional
 			 */
-			$view->addressStates = $view->config( 'client/html/checkout/standard/address/states', array() );
+			$view->addressStates = $view->config('client/html/checkout/standard/address/states', array());
 
 
 			$this->cache = $view;

Braces +1 added lines, -2 removed lines

@@ -303,8 +303,7 @@
 				$view->standardStepActive = 'address';
 				return false;
 			}
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$this->getView()->standardStepActive = 'address';
 			throw $e;

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @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
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

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

Indentation +612 added lines, -612 removed lines

@@ -19,617 +19,617 @@
  * @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;
-			}
-
-			$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 );
-			}
-
-			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
-		 */
-
-		$invalid = array();
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
-
-		foreach( $params as $key => $value )
-		{
-			if( isset( $allFields[$key] ) )
-			{
-				$name = substr( $key, 19 );
-				$regex = $view->config( 'client/html/checkout/standard/address/validate/' . $name );
-
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
-				{
-					$msg = $view->translate( 'client', 'Delivery address part "%1$s" is invalid' );
-					$invalid[$key] = sprintf( $msg, $name );
-					unset( $params[$key] );
-				}
-			}
-			else
-			{
-				unset( $params[$key] );
-			}
-		}
-
-
-		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'] = '';
-		}
-
-
-		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;
-	}
-
-
-	/**
-	 * 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' );
-
-			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;
-	}
+    /** 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;
+            }
+
+            $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 );
+            }
+
+            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
+         */
+
+        $invalid = array();
+        $allFields = array_flip( array_merge( $mandatory, $optional ) );
+
+        foreach( $params as $key => $value )
+        {
+            if( isset( $allFields[$key] ) )
+            {
+                $name = substr( $key, 19 );
+                $regex = $view->config( 'client/html/checkout/standard/address/validate/' . $name );
+
+                if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+                {
+                    $msg = $view->translate( 'client', 'Delivery address part "%1$s" is invalid' );
+                    $invalid[$key] = sprintf( $msg, $name );
+                    unset( $params[$key] );
+                }
+            }
+            else
+            {
+                unset( $params[$key] );
+            }
+        }
+
+
+        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'] = '';
+        }
+
+
+        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;
+    }
+
+
+    /**
+     * 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' );
+
+            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;
+    }
 }
\ No newline at end of file

Spacing +77 added lines, -77 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,24 +266,24 @@ 
 
 		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;
 			}
 
-			$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
@@ -304,63 +304,63 @@ 
 			 * @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);
 			}
 
 			parent::process();
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
 			$view->deliveryError = $e->getErrorList();
 			throw $e;
@@ -374,7 +374,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();
 
@@ -416,7 +416,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
@@ -456,7 +456,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
 		 *
@@ -465,32 +465,32 @@ 
 		 */
 
 		$invalid = array();
-		$allFields = array_flip( array_merge( $mandatory, $optional ) );
+		$allFields = array_flip(array_merge($mandatory, $optional));
 
-		foreach( $params as $key => $value )
+		foreach ($params as $key => $value)
 		{
-			if( isset( $allFields[$key] ) )
+			if (isset($allFields[$key]))
 			{
-				$name = substr( $key, 19 );
-				$regex = $view->config( 'client/html/checkout/standard/address/validate/' . $name );
+				$name = substr($key, 19);
+				$regex = $view->config('client/html/checkout/standard/address/validate/'.$name);
 
-				if( $regex && preg_match( '/' . $regex . '/', $value ) !== 1 )
+				if ($regex && preg_match('/'.$regex.'/', $value) !== 1)
 				{
-					$msg = $view->translate( 'client', 'Delivery address part "%1$s" is invalid' );
-					$invalid[$key] = sprintf( $msg, $name );
-					unset( $params[$key] );
+					$msg = $view->translate('client', 'Delivery address part "%1$s" is invalid');
+					$invalid[$key] = sprintf($msg, $name);
+					unset($params[$key]);
 				}
 			}
 			else
 			{
-				unset( $params[$key] );
+				unset($params[$key]);
 			}
 		}
 
 
-		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 {
@@ -498,13 +498,13 @@ 
 		}
 
 
-		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]);
 			}
 		}
 
@@ -519,7 +519,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -531,17 +531,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;
 
@@ -584,13 +584,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
@@ -620,10 +620,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;
 
 

Braces +9 added lines, -9 removed lines

@@ -307,9 +307,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 )
@@ -319,10 +321,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() ) {
@@ -352,15 +355,13 @@ 
 				}
 
 				$basketCtrl->setAddress( $type, $address );
-			}
-			else
+			} else
 			{
 				$basketCtrl->setAddress( $type, null );
 			}
 
 			parent::process();
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
 		{
 			$view->deliveryError = $e->getErrorList();
 			throw $e;
@@ -480,8 +481,7 @@ 
 					$invalid[$key] = sprintf( $msg, $name );
 					unset( $params[$key] );
 				}
-			}
-			else
+			} else
 			{
 				unset( $params[$key] );
 			}

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @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
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

client/html/src/Client/Html/Checkout/Update/Factory.php

Indentation +59 added lines, -59 removed lines

@@ -19,69 +19,69 @@
  * @subpackage Html
  */
 class Factory
-	extends \Aimeos\Client\Html\Common\Factory\Base
-	implements \Aimeos\Client\Html\Common\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Factory\Base
+    implements \Aimeos\Client\Html\Common\Factory\Iface
 {
-	/**
-	 * Creates a update checkout client object.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
-	 * @param array $templatePaths List of file system paths where the templates are stored
-	 * @param string|null $name Client name (default: "Standard")
-	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
-	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
-	 */
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
-	{
-		/** client/html/checkout/update/name
-		 * Class name of the used checkout update client implementation
-		 *
-		 * Each default HTML client can be replace by an alternative imlementation.
-		 * To use this implementation, you have to set the last part of the class
-		 * name as configuration value so the client factory knows which class it
-		 * has to instantiate.
-		 *
-		 * For example, if the name of the default class is
-		 *
-		 *  \Aimeos\Client\Html\Checkout\Update\Standard
-		 *
-		 * and you want to replace it with your own version named
-		 *
-		 *  \Aimeos\Client\Html\Checkout\Update\Myupdate
-		 *
-		 * then you have to set the this configuration option:
-		 *
-		 *  client/html/checkout/update/name = Myupdate
-		 *
-		 * The value is the last part of your own class name and it's case sensitive,
-		 * so take care that the configuration value is exactly named like the last
-		 * part of the class name.
-		 *
-		 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
-		 * characters are possible! You should always start the last part of the class
-		 * name with an upper case character and continue only with lower case characters
-		 * or numbers. Avoid chamel case names like "MyUpdate"!
-		 *
-		 * @param string Last part of the class name
-		 * @since 2014.03
-		 * @category Developer
-		 */
-		if( $name === null ) {
-			$name = $context->getConfig()->get( 'client/html/checkout/update/name', 'Standard' );
-		}
+    /**
+     * Creates a update checkout client object.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
+     * @param array $templatePaths List of file system paths where the templates are stored
+     * @param string|null $name Client name (default: "Standard")
+     * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
+     * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
+     */
+    public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
+    {
+        /** client/html/checkout/update/name
+         * Class name of the used checkout update client implementation
+         *
+         * Each default HTML client can be replace by an alternative imlementation.
+         * To use this implementation, you have to set the last part of the class
+         * name as configuration value so the client factory knows which class it
+         * has to instantiate.
+         *
+         * For example, if the name of the default class is
+         *
+         *  \Aimeos\Client\Html\Checkout\Update\Standard
+         *
+         * and you want to replace it with your own version named
+         *
+         *  \Aimeos\Client\Html\Checkout\Update\Myupdate
+         *
+         * then you have to set the this configuration option:
+         *
+         *  client/html/checkout/update/name = Myupdate
+         *
+         * The value is the last part of your own class name and it's case sensitive,
+         * so take care that the configuration value is exactly named like the last
+         * part of the class name.
+         *
+         * The allowed characters of the class name are A-Z, a-z and 0-9. No other
+         * characters are possible! You should always start the last part of the class
+         * name with an upper case character and continue only with lower case characters
+         * or numbers. Avoid chamel case names like "MyUpdate"!
+         *
+         * @param string Last part of the class name
+         * @since 2014.03
+         * @category Developer
+         */
+        if( $name === null ) {
+            $name = $context->getConfig()->get( 'client/html/checkout/update/name', 'Standard' );
+        }
 
-		if( ctype_alnum( $name ) === false )
-		{
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Checkout\\Update\\' . $name : '<not a string>';
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
-		}
+        if( ctype_alnum( $name ) === false )
+        {
+            $classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Checkout\\Update\\' . $name : '<not a string>';
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
+        }
 
-		$iface = '\\Aimeos\\Client\\Html\\Iface';
-		$classname = '\\Aimeos\\Client\\Html\\Checkout\\Update\\' . $name;
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
+        $classname = '\\Aimeos\\Client\\Html\\Checkout\\Update\\' . $name;
 
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
+        $client = self::createClientBase( $context, $classname, $iface, $templatePaths );
 
-		return self::addClientDecorators( $context, $client, $templatePaths, 'checkout/update' );
-	}
+        return self::addClientDecorators( $context, $client, $templatePaths, 'checkout/update' );
+    }
 }
 

Spacing +9 added lines, -9 removed lines

@@ -31,7 +31,7 @@ 
 	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
 	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
 	 */
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
+	public static function createClient(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null)
 	{
 		/** client/html/checkout/update/name
 		 * Class name of the used checkout update client implementation
@@ -66,22 +66,22 @@ 
 		 * @since 2014.03
 		 * @category Developer
 		 */
-		if( $name === null ) {
-			$name = $context->getConfig()->get( 'client/html/checkout/update/name', 'Standard' );
+		if ($name === null) {
+			$name = $context->getConfig()->get('client/html/checkout/update/name', 'Standard');
 		}
 
-		if( ctype_alnum( $name ) === false )
+		if (ctype_alnum($name) === false)
 		{
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Checkout\\Update\\' . $name : '<not a string>';
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
+			$classname = is_string($name) ? '\\Aimeos\\Client\\Html\\Checkout\\Update\\'.$name : '<not a string>';
+			throw new \Aimeos\Client\Html\Exception(sprintf('Invalid characters in class name "%1$s"', $classname));
 		}
 
 		$iface = '\\Aimeos\\Client\\Html\\Iface';
-		$classname = '\\Aimeos\\Client\\Html\\Checkout\\Update\\' . $name;
+		$classname = '\\Aimeos\\Client\\Html\\Checkout\\Update\\'.$name;
 
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
+		$client = self::createClientBase($context, $classname, $iface, $templatePaths);
 
-		return self::addClientDecorators( $context, $client, $templatePaths, 'checkout/update' );
+		return self::addClientDecorators($context, $client, $templatePaths, 'checkout/update');
 	}
 }
 

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

Indentation +401 added lines, -401 removed lines

@@ -19,406 +19,406 @@
  * @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/update/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout update 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/update/standard/subparts';
-	private $subPartNames = array();
-
-
-	/**
-	 * 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->updateBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', 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->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-
-		/** client/html/checkout/update/standard/template-body
-		 * Relative path to the HTML body template of the checkout update 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/update/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/update/standard/template-body';
-		$default = 'checkout/update/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->updateHeader = $html;
-
-			/** client/html/checkout/update/standard/template-header
-			 * Relative path to the HTML header template of the checkout update 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/update/standard/template-body
-			 */
-			$tplconf = 'client/html/checkout/update/standard/template-header';
-			$default = 'checkout/update/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/update/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout update 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/update/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/update/decorators/global
-		 * @see client/html/checkout/update/decorators/local
-		 */
-
-		/** client/html/checkout/update/decorators/global
-		 * Adds a list of globally available decorators only to the checkout update 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/update/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/update/decorators/excludes
-		 * @see client/html/checkout/update/decorators/local
-		 */
-
-		/** client/html/checkout/update/decorators/local
-		 * Adds a list of local decorators only to the checkout update 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/update/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/update/decorators/excludes
-		 * @see client/html/checkout/update/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/update/' . $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
-		{
-			$provider = $this->getServiceProvider( $view->param( 'code' ) );
-
-			$config = array( 'absoluteUri' => true, 'namespace' => false );
-			$params = array( 'code' => $view->param( 'code' ), 'orderid' => $view->param( 'orderid' ) );
-			$urls = array(
-				'payment.url-success' => $this->getUrlConfirm( $view, $params, $config ),
-				'payment.url-update' => $this->getUrlUpdate( $view, $params, $config ),
-			);
-			$urls['payment.url-self'] = $urls['payment.url-update'];
-			$provider->injectGlobalConfigBE( $urls );
-
-			$response = null;
-			$headers = array();
-
-			try
-			{
-				$body = $view->request()->getBody();
-
-				if( ( $orderItem = $provider->updateSync( $view->param(), $body, $response, $headers ) ) !== null ) {
-					\Aimeos\Controller\Frontend\Factory::createController( $context, 'order' )->update( $orderItem ); // stock, coupons
-				}
-
-				$view->updateMessage = $response;
-			}
-			catch( \Aimeos\MShop\Service\Exception $e )
-			{
-				$view->updateMessage = $e->getMessage();
-			}
-
-			if( !empty( $headers ) ) {
-				$view->updateHttpHeaders = $headers;
-			}
-
-			parent::process();
-		}
-		catch( \Exception $e )
-		{
-			/** client/html/checkout/standard/update/http-error
-			 * HTTP header sent for failed attempts to update the order status
-			 *
-			 * This HTTP header is returned to the remote system if the status
-			 * update failed due to an error in the application. This header is
-			 * not sent if e.g. a payment was refused by the payment gateway!
-			 * It should be one of the 5xx HTTP headers.
-			 *
-			 * @param array List of valid HTTP headers
-			 * @since 2015.07
-			 * @category Developer
-			 * @see client/html/checkout/standard/update/http-success
-			 */
-			$default = array( 'HTTP/1.1 500 Error updating order status' );
-			$headerList = $context->getConfig()->get( 'client/html/checkout/standard/update/http-error', $default );
-
-			$view->updateHttpHeaders = $headerList;
-			$view->updateMessage = $e->getMessage();
-
-			$body = $view->request()->getBody();
-			$params = print_r( $view->param(), true );
-			$msg = "Updating order status failed: %1\$s\n%2\$s\n%3\$s";
-			$context->getLogger()->log( sprintf( $msg, $e->getMessage(), $params, $body ) );
-		}
-	}
-
-
-	/**
-	 * Returns the service provider for the given code
-	 *
-	 * @param string $code Unique service code
-	 * @throws \Aimeos\Client\Html\Exception If no service item could be found
-	 * @return \Aimeos\MShop\Service\Provider\Iface Service provider object
-	 */
-	protected function getServiceProvider( $code )
-	{
-		$serviceManager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'service' );
-
-		$search = $serviceManager->createSearch();
-		$search->setConditions( $search->compare( '==', 'service.code', $code ) );
-
-		$result = $serviceManager->searchItems( $search );
-
-		if( ( $serviceItem = reset( $result ) ) === false )
-		{
-			$msg = sprintf( 'No service for code "%1$s" found', $code );
-			throw new \Aimeos\Client\Html\Exception( $msg );
-		}
-
-		return $serviceManager->getProvider( $serviceItem );
-	}
-
-
-	/**
-	 * 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 URL to the confirm page.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @param array $params Parameters that should be part of the URL
-	 * @param array $config Default URL configuration
-	 * @return string URL string
-	 */
-	protected function getUrlConfirm( \Aimeos\MW\View\Iface $view, array $params, array $config )
-	{
-		$target = $view->config( 'client/html/checkout/confirm/url/target' );
-		$cntl = $view->config( 'client/html/checkout/confirm/url/controller', 'checkout' );
-		$action = $view->config( 'client/html/checkout/confirm/url/action', 'confirm' );
-		$config = $view->config( 'client/html/checkout/confirm/url/config', $config );
-
-		return $view->url( $target, $cntl, $action, $params, array(), $config );
-	}
-
-
-	/**
-	 * Returns the URL to the update page.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @param array $params Parameters that should be part of the URL
-	 * @param array $config Default URL configuration
-	 * @return string URL string
-	 */
-	protected function getUrlUpdate( \Aimeos\MW\View\Iface $view, array $params, array $config )
-	{
-		$target = $view->config( 'client/html/checkout/update/url/target' );
-		$cntl = $view->config( 'client/html/checkout/update/url/controller', 'checkout' );
-		$action = $view->config( 'client/html/checkout/update/url/action', 'update' );
-		$config = $view->config( 'client/html/checkout/update/url/config', $config );
-
-		return $view->url( $target, $cntl, $action, $params, array(), $config );
-	}
+    /** client/html/checkout/update/standard/subparts
+     * List of HTML sub-clients rendered within the checkout update 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/update/standard/subparts';
+    private $subPartNames = array();
+
+
+    /**
+     * 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->updateBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->updateErrorList = $view->get( 'updateErrorList', 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->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+        }
+
+        /** client/html/checkout/update/standard/template-body
+         * Relative path to the HTML body template of the checkout update 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/update/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/update/standard/template-body';
+        $default = 'checkout/update/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->updateHeader = $html;
+
+            /** client/html/checkout/update/standard/template-header
+             * Relative path to the HTML header template of the checkout update 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/update/standard/template-body
+             */
+            $tplconf = 'client/html/checkout/update/standard/template-header';
+            $default = 'checkout/update/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/update/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout update 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/update/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/update/decorators/global
+         * @see client/html/checkout/update/decorators/local
+         */
+
+        /** client/html/checkout/update/decorators/global
+         * Adds a list of globally available decorators only to the checkout update 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/update/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/update/decorators/excludes
+         * @see client/html/checkout/update/decorators/local
+         */
+
+        /** client/html/checkout/update/decorators/local
+         * Adds a list of local decorators only to the checkout update 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/update/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/update/decorators/excludes
+         * @see client/html/checkout/update/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/update/' . $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
+        {
+            $provider = $this->getServiceProvider( $view->param( 'code' ) );
+
+            $config = array( 'absoluteUri' => true, 'namespace' => false );
+            $params = array( 'code' => $view->param( 'code' ), 'orderid' => $view->param( 'orderid' ) );
+            $urls = array(
+                'payment.url-success' => $this->getUrlConfirm( $view, $params, $config ),
+                'payment.url-update' => $this->getUrlUpdate( $view, $params, $config ),
+            );
+            $urls['payment.url-self'] = $urls['payment.url-update'];
+            $provider->injectGlobalConfigBE( $urls );
+
+            $response = null;
+            $headers = array();
+
+            try
+            {
+                $body = $view->request()->getBody();
+
+                if( ( $orderItem = $provider->updateSync( $view->param(), $body, $response, $headers ) ) !== null ) {
+                    \Aimeos\Controller\Frontend\Factory::createController( $context, 'order' )->update( $orderItem ); // stock, coupons
+                }
+
+                $view->updateMessage = $response;
+            }
+            catch( \Aimeos\MShop\Service\Exception $e )
+            {
+                $view->updateMessage = $e->getMessage();
+            }
+
+            if( !empty( $headers ) ) {
+                $view->updateHttpHeaders = $headers;
+            }
+
+            parent::process();
+        }
+        catch( \Exception $e )
+        {
+            /** client/html/checkout/standard/update/http-error
+             * HTTP header sent for failed attempts to update the order status
+             *
+             * This HTTP header is returned to the remote system if the status
+             * update failed due to an error in the application. This header is
+             * not sent if e.g. a payment was refused by the payment gateway!
+             * It should be one of the 5xx HTTP headers.
+             *
+             * @param array List of valid HTTP headers
+             * @since 2015.07
+             * @category Developer
+             * @see client/html/checkout/standard/update/http-success
+             */
+            $default = array( 'HTTP/1.1 500 Error updating order status' );
+            $headerList = $context->getConfig()->get( 'client/html/checkout/standard/update/http-error', $default );
+
+            $view->updateHttpHeaders = $headerList;
+            $view->updateMessage = $e->getMessage();
+
+            $body = $view->request()->getBody();
+            $params = print_r( $view->param(), true );
+            $msg = "Updating order status failed: %1\$s\n%2\$s\n%3\$s";
+            $context->getLogger()->log( sprintf( $msg, $e->getMessage(), $params, $body ) );
+        }
+    }
+
+
+    /**
+     * Returns the service provider for the given code
+     *
+     * @param string $code Unique service code
+     * @throws \Aimeos\Client\Html\Exception If no service item could be found
+     * @return \Aimeos\MShop\Service\Provider\Iface Service provider object
+     */
+    protected function getServiceProvider( $code )
+    {
+        $serviceManager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'service' );
+
+        $search = $serviceManager->createSearch();
+        $search->setConditions( $search->compare( '==', 'service.code', $code ) );
+
+        $result = $serviceManager->searchItems( $search );
+
+        if( ( $serviceItem = reset( $result ) ) === false )
+        {
+            $msg = sprintf( 'No service for code "%1$s" found', $code );
+            throw new \Aimeos\Client\Html\Exception( $msg );
+        }
+
+        return $serviceManager->getProvider( $serviceItem );
+    }
+
+
+    /**
+     * 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 URL to the confirm page.
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @param array $params Parameters that should be part of the URL
+     * @param array $config Default URL configuration
+     * @return string URL string
+     */
+    protected function getUrlConfirm( \Aimeos\MW\View\Iface $view, array $params, array $config )
+    {
+        $target = $view->config( 'client/html/checkout/confirm/url/target' );
+        $cntl = $view->config( 'client/html/checkout/confirm/url/controller', 'checkout' );
+        $action = $view->config( 'client/html/checkout/confirm/url/action', 'confirm' );
+        $config = $view->config( 'client/html/checkout/confirm/url/config', $config );
+
+        return $view->url( $target, $cntl, $action, $params, array(), $config );
+    }
+
+
+    /**
+     * Returns the URL to the update page.
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @param array $params Parameters that should be part of the URL
+     * @param array $config Default URL configuration
+     * @return string URL string
+     */
+    protected function getUrlUpdate( \Aimeos\MW\View\Iface $view, array $params, array $config )
+    {
+        $target = $view->config( 'client/html/checkout/update/url/target' );
+        $cntl = $view->config( 'client/html/checkout/update/url/controller', 'checkout' );
+        $action = $view->config( 'client/html/checkout/update/url/action', 'update' );
+        $config = $view->config( 'client/html/checkout/update/url/config', $config );
+
+        return $view->url( $target, $cntl, $action, $params, array(), $config );
+    }
 }

Spacing +63 added lines, -63 removed lines

@@ -67,42 +67,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->updateBody = $html;
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
+			$view->updateErrorList = $view->get('updateErrorList', 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->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->updateErrorList = $view->get('updateErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
+			$view->updateErrorList = $view->get('updateErrorList', 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->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->updateErrorList = $view->get('updateErrorList', array()) + $error;
 		}
 
 		/** client/html/checkout/update/standard/template-body
@@ -128,7 +128,7 @@ 
 		$tplconf = 'client/html/checkout/update/standard/template-body';
 		$default = 'checkout/update/body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -140,15 +140,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->updateHeader = $html;
 
@@ -176,11 +176,11 @@ 
 			$tplconf = 'client/html/checkout/update/standard/template-header';
 			$default = 'checkout/update/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());
 		}
 	}
 
@@ -192,7 +192,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/update/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout update html client
@@ -268,7 +268,7 @@ 
 		 * @see client/html/checkout/update/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/update/' . $type, $name );
+		return $this->createSubClient('checkout/update/'.$type, $name);
 	}
 
 
@@ -284,16 +284,16 @@ 
 
 		try
 		{
-			$provider = $this->getServiceProvider( $view->param( 'code' ) );
+			$provider = $this->getServiceProvider($view->param('code'));
 
-			$config = array( 'absoluteUri' => true, 'namespace' => false );
-			$params = array( 'code' => $view->param( 'code' ), 'orderid' => $view->param( 'orderid' ) );
+			$config = array('absoluteUri' => true, 'namespace' => false);
+			$params = array('code' => $view->param('code'), 'orderid' => $view->param('orderid'));
 			$urls = array(
-				'payment.url-success' => $this->getUrlConfirm( $view, $params, $config ),
-				'payment.url-update' => $this->getUrlUpdate( $view, $params, $config ),
+				'payment.url-success' => $this->getUrlConfirm($view, $params, $config),
+				'payment.url-update' => $this->getUrlUpdate($view, $params, $config),
 			);
 			$urls['payment.url-self'] = $urls['payment.url-update'];
-			$provider->injectGlobalConfigBE( $urls );
+			$provider->injectGlobalConfigBE($urls);
 
 			$response = null;
 			$headers = array();
@@ -302,24 +302,24 @@ 
 			{
 				$body = $view->request()->getBody();
 
-				if( ( $orderItem = $provider->updateSync( $view->param(), $body, $response, $headers ) ) !== null ) {
-					\Aimeos\Controller\Frontend\Factory::createController( $context, 'order' )->update( $orderItem ); // stock, coupons
+				if (($orderItem = $provider->updateSync($view->param(), $body, $response, $headers)) !== null) {
+					\Aimeos\Controller\Frontend\Factory::createController($context, 'order')->update($orderItem); // stock, coupons
 				}
 
 				$view->updateMessage = $response;
 			}
-			catch( \Aimeos\MShop\Service\Exception $e )
+			catch (\Aimeos\MShop\Service\Exception $e)
 			{
 				$view->updateMessage = $e->getMessage();
 			}
 
-			if( !empty( $headers ) ) {
+			if (!empty($headers)) {
 				$view->updateHttpHeaders = $headers;
 			}
 
 			parent::process();
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
 			/** client/html/checkout/standard/update/http-error
 			 * HTTP header sent for failed attempts to update the order status
@@ -334,16 +334,16 @@ 
 			 * @category Developer
 			 * @see client/html/checkout/standard/update/http-success
 			 */
-			$default = array( 'HTTP/1.1 500 Error updating order status' );
-			$headerList = $context->getConfig()->get( 'client/html/checkout/standard/update/http-error', $default );
+			$default = array('HTTP/1.1 500 Error updating order status');
+			$headerList = $context->getConfig()->get('client/html/checkout/standard/update/http-error', $default);
 
 			$view->updateHttpHeaders = $headerList;
 			$view->updateMessage = $e->getMessage();
 
 			$body = $view->request()->getBody();
-			$params = print_r( $view->param(), true );
+			$params = print_r($view->param(), true);
 			$msg = "Updating order status failed: %1\$s\n%2\$s\n%3\$s";
-			$context->getLogger()->log( sprintf( $msg, $e->getMessage(), $params, $body ) );
+			$context->getLogger()->log(sprintf($msg, $e->getMessage(), $params, $body));
 		}
 	}
 
@@ -355,22 +355,22 @@ 
 	 * @throws \Aimeos\Client\Html\Exception If no service item could be found
 	 * @return \Aimeos\MShop\Service\Provider\Iface Service provider object
 	 */
-	protected function getServiceProvider( $code )
+	protected function getServiceProvider($code)
 	{
-		$serviceManager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'service' );
+		$serviceManager = \Aimeos\MShop\Factory::createManager($this->getContext(), 'service');
 
 		$search = $serviceManager->createSearch();
-		$search->setConditions( $search->compare( '==', 'service.code', $code ) );
+		$search->setConditions($search->compare('==', 'service.code', $code));
 
-		$result = $serviceManager->searchItems( $search );
+		$result = $serviceManager->searchItems($search);
 
-		if( ( $serviceItem = reset( $result ) ) === false )
+		if (($serviceItem = reset($result)) === false)
 		{
-			$msg = sprintf( 'No service for code "%1$s" found', $code );
-			throw new \Aimeos\Client\Html\Exception( $msg );
+			$msg = sprintf('No service for code "%1$s" found', $code);
+			throw new \Aimeos\Client\Html\Exception($msg);
 		}
 
-		return $serviceManager->getProvider( $serviceItem );
+		return $serviceManager->getProvider($serviceItem);
 	}
 
 
@@ -381,7 +381,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -393,14 +393,14 @@ 
 	 * @param array $config Default URL configuration
 	 * @return string URL string
 	 */
-	protected function getUrlConfirm( \Aimeos\MW\View\Iface $view, array $params, array $config )
+	protected function getUrlConfirm(\Aimeos\MW\View\Iface $view, array $params, array $config)
 	{
-		$target = $view->config( 'client/html/checkout/confirm/url/target' );
-		$cntl = $view->config( 'client/html/checkout/confirm/url/controller', 'checkout' );
-		$action = $view->config( 'client/html/checkout/confirm/url/action', 'confirm' );
-		$config = $view->config( 'client/html/checkout/confirm/url/config', $config );
+		$target = $view->config('client/html/checkout/confirm/url/target');
+		$cntl = $view->config('client/html/checkout/confirm/url/controller', 'checkout');
+		$action = $view->config('client/html/checkout/confirm/url/action', 'confirm');
+		$config = $view->config('client/html/checkout/confirm/url/config', $config);
 
-		return $view->url( $target, $cntl, $action, $params, array(), $config );
+		return $view->url($target, $cntl, $action, $params, array(), $config);
 	}
 
 
@@ -412,13 +412,13 @@ 
 	 * @param array $config Default URL configuration
 	 * @return string URL string
 	 */
-	protected function getUrlUpdate( \Aimeos\MW\View\Iface $view, array $params, array $config )
+	protected function getUrlUpdate(\Aimeos\MW\View\Iface $view, array $params, array $config)
 	{
-		$target = $view->config( 'client/html/checkout/update/url/target' );
-		$cntl = $view->config( 'client/html/checkout/update/url/controller', 'checkout' );
-		$action = $view->config( 'client/html/checkout/update/url/action', 'update' );
-		$config = $view->config( 'client/html/checkout/update/url/config', $config );
+		$target = $view->config('client/html/checkout/update/url/target');
+		$cntl = $view->config('client/html/checkout/update/url/controller', 'checkout');
+		$action = $view->config('client/html/checkout/update/url/action', 'update');
+		$config = $view->config('client/html/checkout/update/url/config', $config);
 
-		return $view->url( $target, $cntl, $action, $params, array(), $config );
+		return $view->url($target, $cntl, $action, $params, array(), $config);
 	}
 }

Braces +7 added lines, -14 removed lines

@@ -81,23 +81,19 @@ 
 				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
 			}
 			$view->updateBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		} catch( \Aimeos\Client\Html\Exception $e )
 		{
 			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
 			$view->updateErrorList = $view->get( 'updateErrorList', 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->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
+		} catch( \Aimeos\MShop\Exception $e )
 		{
 			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
 			$view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 
@@ -177,8 +173,7 @@ 
 			$default = 'checkout/update/header-default.php';
 
 			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 		}
@@ -307,8 +302,7 @@ 
 				}
 
 				$view->updateMessage = $response;
-			}
-			catch( \Aimeos\MShop\Service\Exception $e )
+			} catch( \Aimeos\MShop\Service\Exception $e )
 			{
 				$view->updateMessage = $e->getMessage();
 			}
@@ -318,8 +312,7 @@ 
 			}
 
 			parent::process();
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			/** client/html/checkout/standard/update/http-error
 			 * HTTP header sent for failed attempts to update the order status

client/html/src/Client/Html/Account/Favorite/Factory.php

Indentation +59 added lines, -59 removed lines

@@ -19,69 +19,69 @@
  * @subpackage Html
  */
 class Factory
-	extends \Aimeos\Client\Html\Common\Factory\Base
-	implements \Aimeos\Client\Html\Common\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Factory\Base
+    implements \Aimeos\Client\Html\Common\Factory\Iface
 {
-	/**
-	 * Creates a account favorite client object.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
-	 * @param array $templatePaths List of file system paths where the templates are stored
-	 * @param string|null $name Client name (default: "Standard")
-	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
-	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
-	 */
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
-	{
-		/** client/html/account/favorite/name
-		 * Class name of the used account favorite client implementation
-		 *
-		 * Each default HTML client can be replace by an alternative imlementation.
-		 * To use this implementation, you have to set the last part of the class
-		 * name as configuration value so the client factory knows which class it
-		 * has to instantiate.
-		 *
-		 * For example, if the name of the default class is
-		 *
-		 *  \Aimeos\Client\Html\Account\Favorite\Standard
-		 *
-		 * and you want to replace it with your own version named
-		 *
-		 *  \Aimeos\Client\Html\Account\Favorite\Myfavorite
-		 *
-		 * then you have to set the this configuration option:
-		 *
-		 *  client/html/account/favorite/name = Myfavorite
-		 *
-		 * The value is the last part of your own class name and it's case sensitive,
-		 * so take care that the configuration value is exactly named like the last
-		 * part of the class name.
-		 *
-		 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
-		 * characters are possible! You should always start the last part of the class
-		 * name with an upper case character and continue only with lower case characters
-		 * or numbers. Avoid chamel case names like "MyFavorite"!
-		 *
-		 * @param string Last part of the class name
-		 * @since 2014.03
-		 * @category Developer
-		 */
-		if( $name === null ) {
-			$name = $context->getConfig()->get( 'client/html/account/favorite/name', 'Standard' );
-		}
+    /**
+     * Creates a account favorite client object.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
+     * @param array $templatePaths List of file system paths where the templates are stored
+     * @param string|null $name Client name (default: "Standard")
+     * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
+     * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
+     */
+    public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
+    {
+        /** client/html/account/favorite/name
+         * Class name of the used account favorite client implementation
+         *
+         * Each default HTML client can be replace by an alternative imlementation.
+         * To use this implementation, you have to set the last part of the class
+         * name as configuration value so the client factory knows which class it
+         * has to instantiate.
+         *
+         * For example, if the name of the default class is
+         *
+         *  \Aimeos\Client\Html\Account\Favorite\Standard
+         *
+         * and you want to replace it with your own version named
+         *
+         *  \Aimeos\Client\Html\Account\Favorite\Myfavorite
+         *
+         * then you have to set the this configuration option:
+         *
+         *  client/html/account/favorite/name = Myfavorite
+         *
+         * The value is the last part of your own class name and it's case sensitive,
+         * so take care that the configuration value is exactly named like the last
+         * part of the class name.
+         *
+         * The allowed characters of the class name are A-Z, a-z and 0-9. No other
+         * characters are possible! You should always start the last part of the class
+         * name with an upper case character and continue only with lower case characters
+         * or numbers. Avoid chamel case names like "MyFavorite"!
+         *
+         * @param string Last part of the class name
+         * @since 2014.03
+         * @category Developer
+         */
+        if( $name === null ) {
+            $name = $context->getConfig()->get( 'client/html/account/favorite/name', 'Standard' );
+        }
 
-		if( ctype_alnum( $name ) === false )
-		{
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\Favorite\\' . $name : '<not a string>';
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
-		}
+        if( ctype_alnum( $name ) === false )
+        {
+            $classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\Favorite\\' . $name : '<not a string>';
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
+        }
 
-		$iface = '\\Aimeos\\Client\\Html\\Iface';
-		$classname = '\\Aimeos\\Client\\Html\\Account\\Favorite\\' . $name;
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
+        $classname = '\\Aimeos\\Client\\Html\\Account\\Favorite\\' . $name;
 
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
+        $client = self::createClientBase( $context, $classname, $iface, $templatePaths );
 
-		return self::addClientDecorators( $context, $client, $templatePaths, 'account/favorite' );
-	}
+        return self::addClientDecorators( $context, $client, $templatePaths, 'account/favorite' );
+    }
 
 }
\ No newline at end of file

Spacing +9 added lines, -9 removed lines

@@ -31,7 +31,7 @@ 
 	 * @return \Aimeos\Client\Html\Iface Filter part implementing \Aimeos\Client\Html\Iface
 	 * @throws \Aimeos\Client\Html\Exception If requested client implementation couldn't be found or initialisation fails
 	 */
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null )
+	public static function createClient(\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null)
 	{
 		/** client/html/account/favorite/name
 		 * Class name of the used account favorite client implementation
@@ -66,22 +66,22 @@ 
 		 * @since 2014.03
 		 * @category Developer
 		 */
-		if( $name === null ) {
-			$name = $context->getConfig()->get( 'client/html/account/favorite/name', 'Standard' );
+		if ($name === null) {
+			$name = $context->getConfig()->get('client/html/account/favorite/name', 'Standard');
 		}
 
-		if( ctype_alnum( $name ) === false )
+		if (ctype_alnum($name) === false)
 		{
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Account\\Favorite\\' . $name : '<not a string>';
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in class name "%1$s"', $classname ) );
+			$classname = is_string($name) ? '\\Aimeos\\Client\\Html\\Account\\Favorite\\'.$name : '<not a string>';
+			throw new \Aimeos\Client\Html\Exception(sprintf('Invalid characters in class name "%1$s"', $classname));
 		}
 
 		$iface = '\\Aimeos\\Client\\Html\\Iface';
-		$classname = '\\Aimeos\\Client\\Html\\Account\\Favorite\\' . $name;
+		$classname = '\\Aimeos\\Client\\Html\\Account\\Favorite\\'.$name;
 
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
+		$client = self::createClientBase($context, $classname, $iface, $templatePaths);
 
-		return self::addClientDecorators( $context, $client, $templatePaths, 'account/favorite' );
+		return self::addClientDecorators($context, $client, $templatePaths, 'account/favorite');
 	}
 
 }
\ No newline at end of file

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

Indentation +460 added lines, -460 removed lines

@@ -19,465 +19,465 @@
  * @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/favorite/standard/subparts
-	 * List of HTML sub-clients rendered within the account favorite 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/favorite/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->favoriteBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', 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->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
-		}
-
-		/** client/html/account/favorite/standard/template-body
-		 * Relative path to the HTML body template of the account favorite 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/favorite/standard/template-header
-		 */
-		$tplconf = 'client/html/account/favorite/standard/template-body';
-		$default = 'account/favorite/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->favoriteHeader = $html;
-
-			/** client/html/account/favorite/standard/template-header
-			 * Relative path to the HTML header template of the account favorite 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/favorite/standard/template-body
-			 */
-			$tplconf = 'client/html/account/favorite/standard/template-header';
-			$default = 'account/favorite/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/favorite/decorators/excludes
-		 * Excludes decorators added by the "common" option from the account favorite 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/favorite/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/favorite/decorators/global
-		 * @see client/html/account/favorite/decorators/local
-		 */
-
-		/** client/html/account/favorite/decorators/global
-		 * Adds a list of globally available decorators only to the account favorite 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/favorite/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/favorite/decorators/excludes
-		 * @see client/html/account/favorite/decorators/local
-		 */
-
-		/** client/html/account/favorite/decorators/local
-		 * Adds a list of local decorators only to the account favorite 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/favorite/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/favorite/decorators/excludes
-		 * @see client/html/account/favorite/decorators/global
-		 */
-		return $this->createSubClient( 'account/favorite/' . $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();
-		$ids = $view->param( 'fav_id', array() );
-
-
-		if( $context->getUserId() != null && !empty( $ids ) )
-		{
-			$typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'favorite' );
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
-
-			$search = $manager->createSearch();
-			$expr = array(
-				$search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
-				$search->compare( '==', 'customer.lists.refid', $ids ),
-				$search->compare( '==', 'customer.lists.domain', 'product' ),
-				$search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
-			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-
-			$items = array();
-			foreach( $manager->searchItems( $search ) as $item ) {
-				$items[$item->getRefId()] = $item;
-			}
-
-
-			switch( $view->param( 'fav_action' ) )
-			{
-				case 'add':
-
-					$item = $manager->createItem();
-					$item->setParentId( $context->getUserId() );
-					$item->setTypeId( $typeItem->getId() );
-					$item->setDomain( 'product' );
-					$item->setStatus( 1 );
-
-					foreach( (array) $view->param( 'fav_id', array() ) as $id )
-					{
-						if( !isset( $items[$id] ) )
-						{
-							$item->setId( null );
-							$item->setRefId( $id );
-
-							$manager->saveItem( $item );
-							$manager->moveItem( $item->getId() );
-						}
-					}
-
-					break;
-
-				case 'delete':
-
-					$listIds = array();
-
-					foreach( (array) $view->param( 'fav_id', array() ) as $id )
-					{
-						if( isset( $items[$id] ) ) {
-							$listIds[] = $items[$id]->getId();
-						}
-					}
-
-					$manager->deleteItems( $listIds );
-					break;
-			}
-		}
-
-		parent::process();
-	}
-
-
-	/**
-	 * 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( 'fav_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/favorite/size
-		 * The number of products shown in a list page for favorite 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/favorite/size', 48 );
-
-		$size = (int) $view->param( 'fav-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', 'favorite' );
-
-			$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->favoriteListItems = $manager->searchItems( $search, array(), $total );
-
-
-			/** client/html/account/favorite/domains
-			 * A list of domain names whose items should be available in the account favorite 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/favorite/domains', $default );
-
-			foreach( $view->favoriteListItems as $listItem ) {
-				$productIds[] = $listItem->getRefId();
-			}
-
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-			$view->favoriteProductItems = $controller->getProductItems( $productIds, $domains );
-			$view->favoritePageFirst = 1;
-			$view->favoritePagePrev = ( $current > 1 ? $current - 1 : 1 );
-			$view->favoritePageNext = ( $current < $last ? $current + 1 : $last );
-			$view->favoritePageLast = $last;
-			$view->favoritePageCurr = $current;
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/account/favorite/standard/subparts
+     * List of HTML sub-clients rendered within the account favorite 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/favorite/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->favoriteBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->favoriteErrorList = $view->get( 'favoriteErrorList', 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->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+        }
+
+        /** client/html/account/favorite/standard/template-body
+         * Relative path to the HTML body template of the account favorite 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/favorite/standard/template-header
+         */
+        $tplconf = 'client/html/account/favorite/standard/template-body';
+        $default = 'account/favorite/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->favoriteHeader = $html;
+
+            /** client/html/account/favorite/standard/template-header
+             * Relative path to the HTML header template of the account favorite 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/favorite/standard/template-body
+             */
+            $tplconf = 'client/html/account/favorite/standard/template-header';
+            $default = 'account/favorite/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/favorite/decorators/excludes
+         * Excludes decorators added by the "common" option from the account favorite 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/favorite/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/favorite/decorators/global
+         * @see client/html/account/favorite/decorators/local
+         */
+
+        /** client/html/account/favorite/decorators/global
+         * Adds a list of globally available decorators only to the account favorite 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/favorite/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/favorite/decorators/excludes
+         * @see client/html/account/favorite/decorators/local
+         */
+
+        /** client/html/account/favorite/decorators/local
+         * Adds a list of local decorators only to the account favorite 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/favorite/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/favorite/decorators/excludes
+         * @see client/html/account/favorite/decorators/global
+         */
+        return $this->createSubClient( 'account/favorite/' . $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();
+        $ids = $view->param( 'fav_id', array() );
+
+
+        if( $context->getUserId() != null && !empty( $ids ) )
+        {
+            $typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'favorite' );
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+
+            $search = $manager->createSearch();
+            $expr = array(
+                $search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
+                $search->compare( '==', 'customer.lists.refid', $ids ),
+                $search->compare( '==', 'customer.lists.domain', 'product' ),
+                $search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
+            );
+            $search->setConditions( $search->combine( '&&', $expr ) );
+
+            $items = array();
+            foreach( $manager->searchItems( $search ) as $item ) {
+                $items[$item->getRefId()] = $item;
+            }
+
+
+            switch( $view->param( 'fav_action' ) )
+            {
+                case 'add':
+
+                    $item = $manager->createItem();
+                    $item->setParentId( $context->getUserId() );
+                    $item->setTypeId( $typeItem->getId() );
+                    $item->setDomain( 'product' );
+                    $item->setStatus( 1 );
+
+                    foreach( (array) $view->param( 'fav_id', array() ) as $id )
+                    {
+                        if( !isset( $items[$id] ) )
+                        {
+                            $item->setId( null );
+                            $item->setRefId( $id );
+
+                            $manager->saveItem( $item );
+                            $manager->moveItem( $item->getId() );
+                        }
+                    }
+
+                    break;
+
+                case 'delete':
+
+                    $listIds = array();
+
+                    foreach( (array) $view->param( 'fav_id', array() ) as $id )
+                    {
+                        if( isset( $items[$id] ) ) {
+                            $listIds[] = $items[$id]->getId();
+                        }
+                    }
+
+                    $manager->deleteItems( $listIds );
+                    break;
+            }
+        }
+
+        parent::process();
+    }
+
+
+    /**
+     * 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( 'fav_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/favorite/size
+         * The number of products shown in a list page for favorite 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/favorite/size', 48 );
+
+        $size = (int) $view->param( 'fav-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', 'favorite' );
+
+            $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->favoriteListItems = $manager->searchItems( $search, array(), $total );
+
+
+            /** client/html/account/favorite/domains
+             * A list of domain names whose items should be available in the account favorite 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/favorite/domains', $default );
+
+            foreach( $view->favoriteListItems as $listItem ) {
+                $productIds[] = $listItem->getRefId();
+            }
+
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+            $view->favoriteProductItems = $controller->getProductItems( $productIds, $domains );
+            $view->favoritePageFirst = 1;
+            $view->favoritePagePrev = ( $current > 1 ? $current - 1 : 1 );
+            $view->favoritePageNext = ( $current < $last ? $current + 1 : $last );
+            $view->favoritePageLast = $last;
+            $view->favoritePageCurr = $current;
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +80 added lines, -80 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->favoriteBody = $html;
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
+			$view->favoriteErrorList = $view->get('favoriteErrorList', 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->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->favoriteErrorList = $view->get('favoriteErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
+			$view->favoriteErrorList = $view->get('favoriteErrorList', 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->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->favoriteErrorList = $view->get('favoriteErrorList', array()) + $error;
 		}
 
 		/** client/html/account/favorite/standard/template-body
@@ -129,7 +129,7 @@ 
 		$tplconf = 'client/html/account/favorite/standard/template-body';
 		$default = 'account/favorite/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->favoriteHeader = $html;
 
@@ -177,11 +177,11 @@ 
 			$tplconf = 'client/html/account/favorite/standard/template-header';
 			$default = 'account/favorite/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/favorite/decorators/excludes
 		 * Excludes decorators added by the "common" option from the account favorite html client
@@ -268,7 +268,7 @@ 
 		 * @see client/html/account/favorite/decorators/excludes
 		 * @see client/html/account/favorite/decorators/global
 		 */
-		return $this->createSubClient( 'account/favorite/' . $type, $name );
+		return $this->createSubClient('account/favorite/'.$type, $name);
 	}
 
 
@@ -281,48 +281,48 @@ 
 	{
 		$view = $this->getView();
 		$context = $this->getContext();
-		$ids = $view->param( 'fav_id', array() );
+		$ids = $view->param('fav_id', array());
 
 
-		if( $context->getUserId() != null && !empty( $ids ) )
+		if ($context->getUserId() != null && !empty($ids))
 		{
-			$typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'favorite' );
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+			$typeItem = $this->getTypeItem('customer/lists/type', 'product', 'favorite');
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'customer/lists');
 
 			$search = $manager->createSearch();
 			$expr = array(
-				$search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
-				$search->compare( '==', 'customer.lists.refid', $ids ),
-				$search->compare( '==', 'customer.lists.domain', 'product' ),
-				$search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
+				$search->compare('==', 'customer.lists.parentid', $context->getUserId()),
+				$search->compare('==', 'customer.lists.refid', $ids),
+				$search->compare('==', 'customer.lists.domain', 'product'),
+				$search->compare('==', 'customer.lists.typeid', $typeItem->getId()),
 			);
-			$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;
 			}
 
 
-			switch( $view->param( 'fav_action' ) )
+			switch ($view->param('fav_action'))
 			{
 				case 'add':
 
 					$item = $manager->createItem();
-					$item->setParentId( $context->getUserId() );
-					$item->setTypeId( $typeItem->getId() );
-					$item->setDomain( 'product' );
-					$item->setStatus( 1 );
+					$item->setParentId($context->getUserId());
+					$item->setTypeId($typeItem->getId());
+					$item->setDomain('product');
+					$item->setStatus(1);
 
-					foreach( (array) $view->param( 'fav_id', array() ) as $id )
+					foreach ((array) $view->param('fav_id', array()) as $id)
 					{
-						if( !isset( $items[$id] ) )
+						if (!isset($items[$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());
 						}
 					}
 
@@ -332,14 +332,14 @@ 
 
 					$listIds = array();
 
-					foreach( (array) $view->param( 'fav_id', array() ) as $id )
+					foreach ((array) $view->param('fav_id', array()) as $id)
 					{
-						if( isset( $items[$id] ) ) {
+						if (isset($items[$id])) {
 							$listIds[] = $items[$id]->getId();
 						}
 					}
 
-					$manager->deleteItems( $listIds );
+					$manager->deleteItems($listIds);
 					break;
 			}
 		}
@@ -355,7 +355,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -365,10 +365,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( 'fav_page', 1 );
-		return ( $page < 1 ? 1 : $page );
+		$page = (int) $view->param('fav_page', 1);
+		return ($page < 1 ? 1 : $page);
 	}
 
 
@@ -378,7 +378,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/favorite/size
 		 * The number of products shown in a list page for favorite products
@@ -399,10 +399,10 @@ 
 		 * @category Developer
 		 * @see client/html/catalog/lists/size
 		 */
-		$defaultSize = $this->getContext()->getConfig()->get( 'client/html/account/favorite/size', 48 );
+		$defaultSize = $this->getContext()->getConfig()->get('client/html/account/favorite/size', 48);
 
-		$size = (int) $view->param( 'fav-size', $defaultSize );
-		return ( $size < 1 || $size > 100 ? $defaultSize : $size );
+		$size = (int) $view->param('fav-size', $defaultSize);
+		return ($size < 1 || $size > 100 ? $defaultSize : $size);
 	}
 
 
@@ -414,33 +414,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', 'favorite' );
+			$typeItem = $this->getTypeItem('customer/lists/type', 'product', 'favorite');
 
-			$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->favoriteListItems = $manager->searchItems( $search, array(), $total );
+			$view->favoriteListItems = $manager->searchItems($search, array(), $total);
 
 
 			/** client/html/account/favorite/domains
@@ -459,19 +459,19 @@ 
 			 * @category Developer
 			 * @see client/html/catalog/domains
 			 */
-			$default = array( 'text', 'price', 'media' );
-			$domains = $context->getConfig()->get( 'client/html/account/favorite/domains', $default );
+			$default = array('text', 'price', 'media');
+			$domains = $context->getConfig()->get('client/html/account/favorite/domains', $default);
 
-			foreach( $view->favoriteListItems as $listItem ) {
+			foreach ($view->favoriteListItems as $listItem) {
 				$productIds[] = $listItem->getRefId();
 			}
 
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+			$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
 
-			$view->favoriteProductItems = $controller->getProductItems( $productIds, $domains );
+			$view->favoriteProductItems = $controller->getProductItems($productIds, $domains);
 			$view->favoritePageFirst = 1;
-			$view->favoritePagePrev = ( $current > 1 ? $current - 1 : 1 );
-			$view->favoritePageNext = ( $current < $last ? $current + 1 : $last );
+			$view->favoritePagePrev = ($current > 1 ? $current - 1 : 1);
+			$view->favoritePageNext = ($current < $last ? $current + 1 : $last);
 			$view->favoritePageLast = $last;
 			$view->favoritePageCurr = $current;
 

Braces +5 added lines, -10 removed lines

@@ -82,23 +82,19 @@ 
 				$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;
-		}
-		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;
-		}
-		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;
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 
@@ -178,8 +174,7 @@ 
 			$default = 'account/watch/header-default.php';
 
 			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 		}

client/html/src/Client/Html/Account/History/Lists/Standard.php

Indentation +273 added lines, -273 removed lines

@@ -19,278 +19,278 @@
  * @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/history/lists/standard/subparts
-	 * List of HTML sub-clients rendered within the account history list 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/history/lists/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 )
-	{
-		$view = $this->getView();
-
-		if( $view->param( 'his_action', 'list' ) != 'list' ) {
-			return '';
-		}
-
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->listsBody = $html;
-
-		/** client/html/account/history/lists/standard/template-body
-		 * Relative path to the HTML body template of the account history list 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/history/lists/standard/template-header
-		 */
-		$tplconf = 'client/html/account/history/lists/standard/template-body';
-		$default = 'account/history/list-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->getView();
-
-		if( $view->param( 'his_action', 'list' ) != 'list' ) {
-			return '';
-		}
-
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->listsHeader = $html;
-
-		/** client/html/account/history/lists/standard/template-header
-		 * Relative path to the HTML header template of the account history list 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/history/lists/standard/template-body
-		 */
-		$tplconf = 'client/html/account/history/lists/standard/template-header';
-		$default = 'account/history/list-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/account/history/lists/decorators/excludes
-		 * Excludes decorators added by the "common" option from the account history list 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/history/lists/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/account/history/lists/decorators/global
-		 * @see client/html/account/history/lists/decorators/local
-		 */
-
-		/** client/html/account/history/lists/decorators/global
-		 * Adds a list of globally available decorators only to the account history list 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/history/lists/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/account/history/lists/decorators/excludes
-		 * @see client/html/account/history/lists/decorators/local
-		 */
-
-		/** client/html/account/history/lists/decorators/local
-		 * Adds a list of local decorators only to the account history list 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/history/lists/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 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/account/history/lists/decorators/excludes
-		 * @see client/html/account/history/lists/decorators/global
-		 */
-
-		return $this->createSubClient( 'account/history/lists/' . $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 ) )
-		{
-			$context = $this->getContext();
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'order' );
-
-
-			$search = $manager->createSearch( true );
-			$expr = array(
-				$search->getConditions(),
-				$search->compare( '==', 'order.base.customerid', $context->getUserId() ),
-			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( array( $search->sort( '-', 'order.id' ) ) );
-
-
-			$view->listsOrderItems = $manager->searchItems( $search );
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/account/history/lists/standard/subparts
+     * List of HTML sub-clients rendered within the account history list 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/history/lists/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 )
+    {
+        $view = $this->getView();
+
+        if( $view->param( 'his_action', 'list' ) != 'list' ) {
+            return '';
+        }
+
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->listsBody = $html;
+
+        /** client/html/account/history/lists/standard/template-body
+         * Relative path to the HTML body template of the account history list 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/history/lists/standard/template-header
+         */
+        $tplconf = 'client/html/account/history/lists/standard/template-body';
+        $default = 'account/history/list-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->getView();
+
+        if( $view->param( 'his_action', 'list' ) != 'list' ) {
+            return '';
+        }
+
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->listsHeader = $html;
+
+        /** client/html/account/history/lists/standard/template-header
+         * Relative path to the HTML header template of the account history list 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/history/lists/standard/template-body
+         */
+        $tplconf = 'client/html/account/history/lists/standard/template-header';
+        $default = 'account/history/list-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/account/history/lists/decorators/excludes
+         * Excludes decorators added by the "common" option from the account history list 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/history/lists/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/account/history/lists/decorators/global
+         * @see client/html/account/history/lists/decorators/local
+         */
+
+        /** client/html/account/history/lists/decorators/global
+         * Adds a list of globally available decorators only to the account history list 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/history/lists/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/account/history/lists/decorators/excludes
+         * @see client/html/account/history/lists/decorators/local
+         */
+
+        /** client/html/account/history/lists/decorators/local
+         * Adds a list of local decorators only to the account history list 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/history/lists/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 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/account/history/lists/decorators/excludes
+         * @see client/html/account/history/lists/decorators/global
+         */
+
+        return $this->createSubClient( 'account/history/lists/' . $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 ) )
+        {
+            $context = $this->getContext();
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'order' );
+
+
+            $search = $manager->createSearch( true );
+            $expr = array(
+                $search->getConditions(),
+                $search->compare( '==', 'order.base.customerid', $context->getUserId() ),
+            );
+            $search->setConditions( $search->combine( '&&', $expr ) );
+            $search->setSortations( array( $search->sort( '-', 'order.id' ) ) );
+
+
+            $view->listsOrderItems = $manager->searchItems( $search );
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +23 added lines, -23 removed lines

@@ -68,19 +68,19 @@ 
 	 * @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->getView();
 
-		if( $view->param( 'his_action', 'list' ) != 'list' ) {
+		if ($view->param('his_action', 'list') != 'list') {
 			return '';
 		}
 
-		$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->listsBody = $html;
 
@@ -107,7 +107,7 @@ 
 		$tplconf = 'client/html/account/history/lists/standard/template-body';
 		$default = 'account/history/list-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -119,19 +119,19 @@ 
 	 * @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->getView();
 
-		if( $view->param( 'his_action', 'list' ) != 'list' ) {
+		if ($view->param('his_action', 'list') != 'list') {
 			return '';
 		}
 
-		$view = $this->setViewParams( $view, $tags, $expire );
+		$view = $this->setViewParams($view, $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->listsHeader = $html;
 
@@ -159,7 +159,7 @@ 
 		$tplconf = 'client/html/account/history/lists/standard/template-header';
 		$default = 'account/history/list-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -170,7 +170,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/history/lists/decorators/excludes
 		 * Excludes decorators added by the "common" option from the account history list html client
@@ -246,7 +246,7 @@ 
 		 * @see client/html/account/history/lists/decorators/global
 		 */
 
-		return $this->createSubClient( 'account/history/lists/' . $type, $name );
+		return $this->createSubClient('account/history/lists/'.$type, $name);
 	}
 
 
@@ -257,7 +257,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -269,24 +269,24 @@ 
 	 * @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();
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'order' );
+			$manager = \Aimeos\MShop\Factory::createManager($context, 'order');
 
 
-			$search = $manager->createSearch( true );
+			$search = $manager->createSearch(true);
 			$expr = array(
 				$search->getConditions(),
-				$search->compare( '==', 'order.base.customerid', $context->getUserId() ),
+				$search->compare('==', 'order.base.customerid', $context->getUserId()),
 			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( array( $search->sort( '-', 'order.id' ) ) );
+			$search->setConditions($search->combine('&&', $expr));
+			$search->setSortations(array($search->sort('-', 'order.id')));
 
 
-			$view->listsOrderItems = $manager->searchItems( $search );
+			$view->listsOrderItems = $manager->searchItems($search);
 
 			$this->cache = $view;
 		}

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @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
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{