aimeos / ai-client-html

client/html/src/Client/Html/Basket/Mini/Standard.php

Indentation +348 added lines, -348 removed lines

@@ -19,353 +19,353 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Basket\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Basket\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/basket/mini/standard/subparts
-	 * List of HTML sub-clients rendered within the basket mini 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/basket/mini/standard/subparts';
-
-	/** client/html/basket/mini/main/name
-	 * Name of the main part used by the basket mini client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Mini\Main\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/basket/mini/product/name
-	 * Name of the product part used by the basket mini client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Mini\Product\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2015.09
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'main', 'product' );
-
-	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();
-		$site = $context->getLocale()->getSiteId();
-		$view = $this->getView();
-
-		/** client/html/basket/mini
-		 * All parameters defined for the small basket component and its subparts
-		 *
-		 * This returns all settings related to the small basket component.
-		 * Please refer to the single settings for details.
-		 *
-		 * @param array Associative list of name/value settings
-		 * @category Developer
-		 * @see client/html/basket#mini
-		 */
-		$config = $context->getConfig()->get( 'client/html/basket/mini', array() );
-		$key = $this->getParamHash( array(), $uid . $site . ':basket:mini-body', $config );
-
-		if( ( $html = $this->getBasketCached( $key ) ) === null )
-		{
-			try
-			{
-				$view = $this->setViewParams( $view, $tags, $expire );
-
-				$output = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-				}
-				$view->miniBody = $output;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->miniErrorList = $view->get( 'miniErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->miniErrorList = $view->get( 'miniErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->miniErrorList = $view->get( 'miniErrorList', 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->miniErrorList = $view->get( 'miniErrorList', array() ) + $error;
-			}
-
-			/** client/html/basket/mini/standard/template-body
-			 * Relative path to the HTML body template of the basket mini 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/basket/mini/standard/template-header
-			 */
-			$tplconf = 'client/html/basket/mini/standard/template-body';
-			$default = 'basket/mini/body-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-			$this->setBasketCached( $key, $html );
-		}
-		else
-		{
-			$html = $this->modifyBody( $html, $uid );
-		}
-
-		return $html;
-	}
-
-
-	/**
-	 * 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 )
-	{
-		$context = $this->getContext();
-		$site = $context->getLocale()->getSiteId();
-		$view = $this->getView();
-
-		$config = $context->getConfig()->get( 'client/html/basket/mini', array() );
-		$key = $this->getParamHash( array(), $uid . $site . ':basket:mini-header', $config );
-
-		if( ( $html = $this->getBasketCached( $key ) ) === null )
-		{
-			try
-			{
-				$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-				$output = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-				}
-				$view->miniHeader = $output;
-
-				/** client/html/basket/mini/standard/template-header
-				 * Relative path to the HTML header template of the basket mini 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/basket/mini/standard/template-body
-				 */
-				$tplconf = 'client/html/basket/mini/standard/template-header';
-				$default = 'basket/mini/header-default.php';
-
-				$html = $view->render( $view->config( $tplconf, $default ) );
-				$this->setBasketCached( $key, $html );
-			}
-			catch( \Exception $e )
-			{
-				$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-			}
-		}
-		else
-		{
-			$html = $this->modifyHeader( $html, $uid );
-		}
-
-		return $html;
-	}
-
-
-	/**
-	 * 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/basket/mini/decorators/excludes
-		 * Excludes decorators added by the "common" option from the basket mini 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/basket/mini/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/basket/mini/decorators/global
-		 * @see client/html/basket/mini/decorators/local
-		 */
-
-		/** client/html/basket/mini/decorators/global
-		 * Adds a list of globally available decorators only to the basket mini 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/basket/mini/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/basket/mini/decorators/excludes
-		 * @see client/html/basket/mini/decorators/local
-		 */
-
-		/** client/html/basket/mini/decorators/local
-		 * Adds a list of local decorators only to the basket mini 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\Basket\Decorator\*") around the html client.
-		 *
-		 *  client/html/basket/mini/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Basket\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/basket/mini/decorators/excludes
-		 * @see client/html/basket/mini/decorators/global
-		 */
-
-		return $this->createSubClient( 'basket/mini/' . $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 ) )
-		{
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
-			$view->miniBasket = $controller->get();
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/basket/mini/standard/subparts
+     * List of HTML sub-clients rendered within the basket mini 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/basket/mini/standard/subparts';
+
+    /** client/html/basket/mini/main/name
+     * Name of the main part used by the basket mini client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Mini\Main\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/basket/mini/product/name
+     * Name of the product part used by the basket mini client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Mini\Product\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2015.09
+     * @category Developer
+     */
+    private $subPartNames = array( 'main', 'product' );
+
+    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();
+        $site = $context->getLocale()->getSiteId();
+        $view = $this->getView();
+
+        /** client/html/basket/mini
+         * All parameters defined for the small basket component and its subparts
+         *
+         * This returns all settings related to the small basket component.
+         * Please refer to the single settings for details.
+         *
+         * @param array Associative list of name/value settings
+         * @category Developer
+         * @see client/html/basket#mini
+         */
+        $config = $context->getConfig()->get( 'client/html/basket/mini', array() );
+        $key = $this->getParamHash( array(), $uid . $site . ':basket:mini-body', $config );
+
+        if( ( $html = $this->getBasketCached( $key ) ) === null )
+        {
+            try
+            {
+                $view = $this->setViewParams( $view, $tags, $expire );
+
+                $output = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+                }
+                $view->miniBody = $output;
+            }
+            catch( \Aimeos\Client\Html\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+                $view->miniErrorList = $view->get( 'miniErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\Controller\Frontend\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+                $view->miniErrorList = $view->get( 'miniErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\MShop\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+                $view->miniErrorList = $view->get( 'miniErrorList', 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->miniErrorList = $view->get( 'miniErrorList', array() ) + $error;
+            }
+
+            /** client/html/basket/mini/standard/template-body
+             * Relative path to the HTML body template of the basket mini 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/basket/mini/standard/template-header
+             */
+            $tplconf = 'client/html/basket/mini/standard/template-body';
+            $default = 'basket/mini/body-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+            $this->setBasketCached( $key, $html );
+        }
+        else
+        {
+            $html = $this->modifyBody( $html, $uid );
+        }
+
+        return $html;
+    }
+
+
+    /**
+     * 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 )
+    {
+        $context = $this->getContext();
+        $site = $context->getLocale()->getSiteId();
+        $view = $this->getView();
+
+        $config = $context->getConfig()->get( 'client/html/basket/mini', array() );
+        $key = $this->getParamHash( array(), $uid . $site . ':basket:mini-header', $config );
+
+        if( ( $html = $this->getBasketCached( $key ) ) === null )
+        {
+            try
+            {
+                $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+                $output = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+                }
+                $view->miniHeader = $output;
+
+                /** client/html/basket/mini/standard/template-header
+                 * Relative path to the HTML header template of the basket mini 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/basket/mini/standard/template-body
+                 */
+                $tplconf = 'client/html/basket/mini/standard/template-header';
+                $default = 'basket/mini/header-default.php';
+
+                $html = $view->render( $view->config( $tplconf, $default ) );
+                $this->setBasketCached( $key, $html );
+            }
+            catch( \Exception $e )
+            {
+                $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            }
+        }
+        else
+        {
+            $html = $this->modifyHeader( $html, $uid );
+        }
+
+        return $html;
+    }
+
+
+    /**
+     * 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/basket/mini/decorators/excludes
+         * Excludes decorators added by the "common" option from the basket mini 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/basket/mini/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/basket/mini/decorators/global
+         * @see client/html/basket/mini/decorators/local
+         */
+
+        /** client/html/basket/mini/decorators/global
+         * Adds a list of globally available decorators only to the basket mini 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/basket/mini/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/basket/mini/decorators/excludes
+         * @see client/html/basket/mini/decorators/local
+         */
+
+        /** client/html/basket/mini/decorators/local
+         * Adds a list of local decorators only to the basket mini 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\Basket\Decorator\*") around the html client.
+         *
+         *  client/html/basket/mini/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Basket\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/basket/mini/decorators/excludes
+         * @see client/html/basket/mini/decorators/global
+         */
+
+        return $this->createSubClient( 'basket/mini/' . $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 ) )
+        {
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'basket' );
+            $view->miniBasket = $controller->get();
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Basket/Mini/Main/Standard.php

Indentation +232 added lines, -232 removed lines

@@ -19,259 +19,259 @@
  * @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/basket/mini/main/standard/subparts
-	 * List of HTML sub-clients rendered within the basket mini main 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/basket/mini/main/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
+    /** client/html/basket/mini/main/standard/subparts
+     * List of HTML sub-clients rendered within the basket mini main 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/basket/mini/main/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->setViewParams( $this->getView(), $tags, $expire );
+    /**
+     * 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->mainBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->mainBody = $html;
 
-		/** client/html/basket/mini/main/standard/template-body
-		 * Relative path to the HTML body template of the basket mini main 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/basket/mini/main/standard/template-header
-		 */
-		$tplconf = 'client/html/basket/mini/main/standard/template-body';
-		$default = 'basket/mini/main-body-default.php';
+        /** client/html/basket/mini/main/standard/template-body
+         * Relative path to the HTML body template of the basket mini main 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/basket/mini/main/standard/template-header
+         */
+        $tplconf = 'client/html/basket/mini/main/standard/template-body';
+        $default = 'basket/mini/main-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
+        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 );
+    /**
+     * 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->mainHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->mainHeader = $html;
 
-		/** client/html/basket/mini/main/standard/template-header
-		 * Relative path to the HTML header template of the basket mini main 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/basket/mini/main/standard/template-body
-		 */
-		$tplconf = 'client/html/basket/mini/main/standard/template-header';
-		$default = 'basket/mini/main-header-default.php';
+        /** client/html/basket/mini/main/standard/template-header
+         * Relative path to the HTML header template of the basket mini main 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/basket/mini/main/standard/template-body
+         */
+        $tplconf = 'client/html/basket/mini/main/standard/template-header';
+        $default = 'basket/mini/main-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
+        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/basket/mini/main/decorators/excludes
-		 * Excludes decorators added by the "common" option from the basket mini main 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/basket/mini/main/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/basket/mini/main/decorators/global
-		 * @see client/html/basket/mini/main/decorators/local
-		 */
+    /**
+     * 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/basket/mini/main/decorators/excludes
+         * Excludes decorators added by the "common" option from the basket mini main 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/basket/mini/main/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/basket/mini/main/decorators/global
+         * @see client/html/basket/mini/main/decorators/local
+         */
 
-		/** client/html/basket/mini/main/decorators/global
-		 * Adds a list of globally available decorators only to the basket mini main 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/basket/mini/main/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/basket/mini/main/decorators/excludes
-		 * @see client/html/basket/mini/main/decorators/local
-		 */
+        /** client/html/basket/mini/main/decorators/global
+         * Adds a list of globally available decorators only to the basket mini main 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/basket/mini/main/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/basket/mini/main/decorators/excludes
+         * @see client/html/basket/mini/main/decorators/local
+         */
 
-		/** client/html/basket/mini/main/decorators/local
-		 * Adds a list of local decorators only to the basket mini main 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\Basket\Decorator\*") around the html client.
-		 *
-		 *  client/html/basket/mini/main/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Basket\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/basket/mini/main/decorators/excludes
-		 * @see client/html/basket/mini/main/decorators/global
-		 */
-		return $this->createSubClient( 'basket/mini/main/' . $type, $name );
-	}
+        /** client/html/basket/mini/main/decorators/local
+         * Adds a list of local decorators only to the basket mini main 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\Basket\Decorator\*") around the html client.
+         *
+         *  client/html/basket/mini/main/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Basket\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/basket/mini/main/decorators/excludes
+         * @see client/html/basket/mini/main/decorators/global
+         */
+        return $this->createSubClient( 'basket/mini/main/' . $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 );
-	}
+    /**
+     * 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 ) )
-		{
-			$view->mainPriceItem = $view->miniBasket->getPrice();
+    /**
+     * 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 ) )
+        {
+            $view->mainPriceItem = $view->miniBasket->getPrice();
 
-			$count = 0;
-			foreach( $view->miniBasket->getProducts() as $product ) {
-				$count += $product->getQuantity();
-			}
+            $count = 0;
+            foreach( $view->miniBasket->getProducts() as $product ) {
+                $count += $product->getQuantity();
+            }
 
-			$view->mainQuantity = $count;
+            $view->mainQuantity = $count;
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file

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

Indentation +661 added lines, -661 removed lines

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

client/html/src/Client/Html/Catalog/Stage/Breadcrumb/Standard.php

Indentation +226 added lines, -226 removed lines

@@ -19,231 +19,231 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/stage/breadcrumb/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog stage breadcrumb section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/stage/breadcrumb/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 )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->breadcrumbBody = $html;
-
-		/** client/html/catalog/stage/breadcrumb/standard/template-body
-		 * Relative path to the HTML body template of the catalog stage breadcrumb client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stage/breadcrumb/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/stage/breadcrumb/standard/template-body';
-		$default = 'catalog/stage/breadcrumb-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->breadcrumbHeader = $html;
-
-		/** client/html/catalog/stage/breadcrumb/standard/template-header
-		 * Relative path to the HTML header template of the catalog stage breadcrumb client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stage/breadcrumb/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/stage/breadcrumb/standard/template-header';
-		$default = 'catalog/stage/breadcrumb-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/stage/breadcrumb/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog stage breadcrumb html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/stage/breadcrumb/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/catalog/stage/breadcrumb/decorators/global
-		 * @see client/html/catalog/stage/breadcrumb/decorators/local
-		 */
-
-		/** client/html/catalog/stage/breadcrumb/decorators/global
-		 * Adds a list of globally available decorators only to the catalog stage breadcrumb html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/breadcrumb/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/catalog/stage/breadcrumb/decorators/excludes
-		 * @see client/html/catalog/stage/breadcrumb/decorators/local
-		 */
-
-		/** client/html/catalog/stage/breadcrumb/decorators/local
-		 * Adds a list of local decorators only to the catalog stage breadcrumb html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/breadcrumb/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/stage/breadcrumb/decorators/excludes
-		 * @see client/html/catalog/stage/breadcrumb/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/stage/breadcrumb/' . $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 );
-	}
+    /** client/html/catalog/stage/breadcrumb/standard/subparts
+     * List of HTML sub-clients rendered within the catalog stage breadcrumb section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/stage/breadcrumb/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 )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->breadcrumbBody = $html;
+
+        /** client/html/catalog/stage/breadcrumb/standard/template-body
+         * Relative path to the HTML body template of the catalog stage breadcrumb client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stage/breadcrumb/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/stage/breadcrumb/standard/template-body';
+        $default = 'catalog/stage/breadcrumb-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->breadcrumbHeader = $html;
+
+        /** client/html/catalog/stage/breadcrumb/standard/template-header
+         * Relative path to the HTML header template of the catalog stage breadcrumb client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stage/breadcrumb/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/stage/breadcrumb/standard/template-header';
+        $default = 'catalog/stage/breadcrumb-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/stage/breadcrumb/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog stage breadcrumb html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/stage/breadcrumb/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/catalog/stage/breadcrumb/decorators/global
+         * @see client/html/catalog/stage/breadcrumb/decorators/local
+         */
+
+        /** client/html/catalog/stage/breadcrumb/decorators/global
+         * Adds a list of globally available decorators only to the catalog stage breadcrumb html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/breadcrumb/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/catalog/stage/breadcrumb/decorators/excludes
+         * @see client/html/catalog/stage/breadcrumb/decorators/local
+         */
+
+        /** client/html/catalog/stage/breadcrumb/decorators/local
+         * Adds a list of local decorators only to the catalog stage breadcrumb html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/breadcrumb/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/stage/breadcrumb/decorators/excludes
+         * @see client/html/catalog/stage/breadcrumb/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/stage/breadcrumb/' . $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 );
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Catalog/Stage/Navigator/Standard.php

Indentation +323 added lines, -323 removed lines

@@ -19,328 +19,328 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Catalog\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Catalog\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/stage/navigator/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog stage navigator section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/stage/navigator/standard/subparts';
-	private $subPartNames = array();
-	private $view;
-
-
-	/**
-	 * 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->navigatorBody = $html;
-
-		/** client/html/catalog/stage/navigator/standard/template-body
-		 * Relative path to the HTML body template of the catalog stage navigator client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stage/navigator/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/stage/navigator/standard/template-body';
-		$default = 'catalog/stage/navigator-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->navigatorHeader = $html;
-
-		/** client/html/catalog/stage/navigator/standard/template-header
-		 * Relative path to the HTML header template of the catalog stage navigator client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stage/navigator/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/stage/navigator/standard/template-header';
-		$default = 'catalog/stage/navigator-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/stage/navigator/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog stage navigator html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/stage/navigator/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/catalog/stage/navigator/decorators/global
-		 * @see client/html/catalog/stage/navigator/decorators/local
-		 */
-
-		/** client/html/catalog/stage/navigator/decorators/global
-		 * Adds a list of globally available decorators only to the catalog stage navigator html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/navigator/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/catalog/stage/navigator/decorators/excludes
-		 * @see client/html/catalog/stage/navigator/decorators/local
-		 */
-
-		/** client/html/catalog/stage/navigator/decorators/local
-		 * Adds a list of local decorators only to the catalog stage navigator html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/navigator/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/stage/navigator/decorators/excludes
-		 * @see client/html/catalog/stage/navigator/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/stage/navigator/' . $type, $name );
-	}
-
-
-	/**
-	 * Modifies the cached body content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified body content
-	 */
-	public function modifyBody( $content, $uid )
-	{
-		return $this->replaceSection( $content, $this->getBody( $uid ), 'catalog.stage.navigator' );
-	}
-
-
-	/**
-	 * Modifies the cached header content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified body content
-	 */
-	public function modifyHeader( $content, $uid )
-	{
-		return $this->replaceSection( $content, $this->getHeader( $uid ), 'catalog.stage.navigator' );
-	}
-
-
-	/**
-	 * 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->view ) )
-		{
-			if( ( $pos = $view->param( 'l_pos' ) ) !== null && ( $pid = $view->param( 'd_prodid' ) ) !== null )
-			{
-				if( $pos < 1 ) {
-					$start = 0; $size = 2;
-				} else {
-					$start = $pos - 1; $size = 3;
-				}
-
-				$context = $this->getContext();
-				$site = $context->getLocale()->getSite()->getCode();
-				$params = $context->getSession()->get( 'aimeos/catalog/lists/params/last/' . $site, array() );
-
-				$filter = $this->getProductListFilterByParam( $params );
-				$filter->setSlice( $start, $size );
-				$total = null;
-
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-				$products = $controller->getIndexItems( $filter, array( 'text' ), $total );
-
-				if( ( $count = count( $products ) ) > 1 )
-				{
-					$enc = $view->encoder();
-					$listPos = array_search( $pid, array_keys( $products ) );
-
-					$target = $view->config( 'client/html/catalog/detail/url/target' );
-					$controller = $view->config( 'client/html/catalog/detail/url/controller', 'catalog' );
-					$action = $view->config( 'client/html/catalog/detail/url/action', 'detail' );
-					$config = $view->config( 'client/html/catalog/detail/url/config', array() );
-
-					if( $listPos > 0 && ( $product = reset( $products ) ) !== false )
-					{
-						$param = array(
-							'd_prodid' => $product->getId(),
-							'd_name' => $enc->url( $product->getName( 'url ' ) ),
-							'l_pos' => $pos - 1
-						);
-						$view->navigationPrev = $view->url( $target, $controller, $action, $param, array(), $config );
-					}
-
-					if( $listPos < $count - 1 && ( $product = end( $products ) ) !== false )
-					{
-						$param = array(
-							'd_prodid' => $product->getId(),
-							'd_name' => $enc->url( $product->getName( 'url' ) ),
-							'l_pos' => $pos + 1
-						);
-						$view->navigationNext = $view->url( $target, $controller, $action, $param, array(), $config );
-					}
-				}
-			}
-
-			$this->view = $view;
-		}
-
-		return $this->view;
-	}
+    /** client/html/catalog/stage/navigator/standard/subparts
+     * List of HTML sub-clients rendered within the catalog stage navigator section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/stage/navigator/standard/subparts';
+    private $subPartNames = array();
+    private $view;
+
+
+    /**
+     * 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->navigatorBody = $html;
+
+        /** client/html/catalog/stage/navigator/standard/template-body
+         * Relative path to the HTML body template of the catalog stage navigator client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stage/navigator/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/stage/navigator/standard/template-body';
+        $default = 'catalog/stage/navigator-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->navigatorHeader = $html;
+
+        /** client/html/catalog/stage/navigator/standard/template-header
+         * Relative path to the HTML header template of the catalog stage navigator client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stage/navigator/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/stage/navigator/standard/template-header';
+        $default = 'catalog/stage/navigator-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/stage/navigator/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog stage navigator html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/stage/navigator/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/catalog/stage/navigator/decorators/global
+         * @see client/html/catalog/stage/navigator/decorators/local
+         */
+
+        /** client/html/catalog/stage/navigator/decorators/global
+         * Adds a list of globally available decorators only to the catalog stage navigator html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/navigator/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/catalog/stage/navigator/decorators/excludes
+         * @see client/html/catalog/stage/navigator/decorators/local
+         */
+
+        /** client/html/catalog/stage/navigator/decorators/local
+         * Adds a list of local decorators only to the catalog stage navigator html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/navigator/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/stage/navigator/decorators/excludes
+         * @see client/html/catalog/stage/navigator/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/stage/navigator/' . $type, $name );
+    }
+
+
+    /**
+     * Modifies the cached body content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified body content
+     */
+    public function modifyBody( $content, $uid )
+    {
+        return $this->replaceSection( $content, $this->getBody( $uid ), 'catalog.stage.navigator' );
+    }
+
+
+    /**
+     * Modifies the cached header content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified body content
+     */
+    public function modifyHeader( $content, $uid )
+    {
+        return $this->replaceSection( $content, $this->getHeader( $uid ), 'catalog.stage.navigator' );
+    }
+
+
+    /**
+     * 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->view ) )
+        {
+            if( ( $pos = $view->param( 'l_pos' ) ) !== null && ( $pid = $view->param( 'd_prodid' ) ) !== null )
+            {
+                if( $pos < 1 ) {
+                    $start = 0; $size = 2;
+                } else {
+                    $start = $pos - 1; $size = 3;
+                }
+
+                $context = $this->getContext();
+                $site = $context->getLocale()->getSite()->getCode();
+                $params = $context->getSession()->get( 'aimeos/catalog/lists/params/last/' . $site, array() );
+
+                $filter = $this->getProductListFilterByParam( $params );
+                $filter->setSlice( $start, $size );
+                $total = null;
+
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+                $products = $controller->getIndexItems( $filter, array( 'text' ), $total );
+
+                if( ( $count = count( $products ) ) > 1 )
+                {
+                    $enc = $view->encoder();
+                    $listPos = array_search( $pid, array_keys( $products ) );
+
+                    $target = $view->config( 'client/html/catalog/detail/url/target' );
+                    $controller = $view->config( 'client/html/catalog/detail/url/controller', 'catalog' );
+                    $action = $view->config( 'client/html/catalog/detail/url/action', 'detail' );
+                    $config = $view->config( 'client/html/catalog/detail/url/config', array() );
+
+                    if( $listPos > 0 && ( $product = reset( $products ) ) !== false )
+                    {
+                        $param = array(
+                            'd_prodid' => $product->getId(),
+                            'd_name' => $enc->url( $product->getName( 'url ' ) ),
+                            'l_pos' => $pos - 1
+                        );
+                        $view->navigationPrev = $view->url( $target, $controller, $action, $param, array(), $config );
+                    }
+
+                    if( $listPos < $count - 1 && ( $product = end( $products ) ) !== false )
+                    {
+                        $param = array(
+                            'd_prodid' => $product->getId(),
+                            'd_name' => $enc->url( $product->getName( 'url' ) ),
+                            'l_pos' => $pos + 1
+                        );
+                        $view->navigationNext = $view->url( $target, $controller, $action, $param, array(), $config );
+                    }
+                }
+            }
+
+            $this->view = $view;
+        }
+
+        return $this->view;
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Catalog/Stage/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 stage 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/catalog/stage/name
-		 * Class name of the used catalog stage 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\Catalog\Stage\Standard
-		 *
-		 * and you want to replace it with your own version named
-		 *
-		 *  \Aimeos\Client\Html\Catalog\Stage\Mystage
-		 *
-		 * then you have to set the this configuration option:
-		 *
-		 *  client/html/catalog/stage/name = Mystage
-		 *
-		 * 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 "MyStage"!
-		 *
-		 * @param string Last part of the class name
-		 * @since 2014.03
-		 * @category Developer
-		 */
-		if( $name === null ) {
-			$name = $context->getConfig()->get( 'client/html/catalog/stage/name', 'Standard' );
-		}
+    /**
+     * Creates a stage 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/catalog/stage/name
+         * Class name of the used catalog stage 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\Catalog\Stage\Standard
+         *
+         * and you want to replace it with your own version named
+         *
+         *  \Aimeos\Client\Html\Catalog\Stage\Mystage
+         *
+         * then you have to set the this configuration option:
+         *
+         *  client/html/catalog/stage/name = Mystage
+         *
+         * 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 "MyStage"!
+         *
+         * @param string Last part of the class name
+         * @since 2014.03
+         * @category Developer
+         */
+        if( $name === null ) {
+            $name = $context->getConfig()->get( 'client/html/catalog/stage/name', 'Standard' );
+        }
 
-		if( ctype_alnum( $name ) === false )
-		{
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Catalog\\Stage\\' . $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\\Catalog\\Stage\\' . $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\\Catalog\\Stage\\' . $name;
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
+        $classname = '\\Aimeos\\Client\\Html\\Catalog\\Stage\\' . $name;
 
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
+        $client = self::createClientBase( $context, $classname, $iface, $templatePaths );
 
-		return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/stage' );
-	}
+        return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/stage' );
+    }
 }
 

client/html/src/Client/Html/Catalog/Stage/Image/Standard.php

Indentation +236 added lines, -236 removed lines

@@ -19,264 +19,264 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/stage/image/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog stage image section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/stage/image/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
+    /** client/html/catalog/stage/image/standard/subparts
+     * List of HTML sub-clients rendered within the catalog stage image section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/stage/image/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->setViewParams( $this->getView(), $tags, $expire );
+    /**
+     * 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->imageBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->imageBody = $html;
 
-		/** client/html/catalog/stage/image/standard/template-body
-		 * Relative path to the HTML body template of the catalog stage image client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stage/image/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/stage/image/standard/template-body';
-		$default = 'catalog/stage/image-body-default.php';
+        /** client/html/catalog/stage/image/standard/template-body
+         * Relative path to the HTML body template of the catalog stage image client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stage/image/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/stage/image/standard/template-body';
+        $default = 'catalog/stage/image-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
+        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 );
+    /**
+     * 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->imageHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->imageHeader = $html;
 
-		/** client/html/catalog/stage/image/standard/template-header
-		 * Relative path to the HTML header template of the catalog stage image client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stage/image/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/stage/image/standard/template-header';
-		$default = 'catalog/stage/image-header-default.php';
+        /** client/html/catalog/stage/image/standard/template-header
+         * Relative path to the HTML header template of the catalog stage image client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stage/image/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/stage/image/standard/template-header';
+        $default = 'catalog/stage/image-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
 
 
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/stage/image/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog stage image html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/stage/image/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/catalog/stage/image/decorators/global
-		 * @see client/html/catalog/stage/image/decorators/local
-		 */
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/stage/image/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog stage image html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/stage/image/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/catalog/stage/image/decorators/global
+         * @see client/html/catalog/stage/image/decorators/local
+         */
 
-		/** client/html/catalog/stage/image/decorators/global
-		 * Adds a list of globally available decorators only to the catalog stage image html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/image/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/catalog/stage/image/decorators/excludes
-		 * @see client/html/catalog/stage/image/decorators/local
-		 */
+        /** client/html/catalog/stage/image/decorators/global
+         * Adds a list of globally available decorators only to the catalog stage image html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/image/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/catalog/stage/image/decorators/excludes
+         * @see client/html/catalog/stage/image/decorators/local
+         */
 
-		/** client/html/catalog/stage/image/decorators/local
-		 * Adds a list of local decorators only to the catalog stage image html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/image/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/stage/image/decorators/excludes
-		 * @see client/html/catalog/stage/image/decorators/global
-		 */
-		return $this->createSubClient( 'catalog/stage/image/' . $type, $name );
-	}
+        /** client/html/catalog/stage/image/decorators/local
+         * Adds a list of local decorators only to the catalog stage image html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/image/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/stage/image/decorators/excludes
+         * @see client/html/catalog/stage/image/decorators/global
+         */
+        return $this->createSubClient( 'catalog/stage/image/' . $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 );
-	}
+    /**
+     * 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 ) )
-		{
-			$mediaItems = array();
-			$catPath = $view->get( 'stageCatPath', array() );
+    /**
+     * 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 ) )
+        {
+            $mediaItems = array();
+            $catPath = $view->get( 'stageCatPath', array() );
 
-			foreach( array_reverse( $catPath ) as $catItem )
-			{
-				$mediaItems = $catItem->getRefItems( 'media', 'default', 'stage' );
+            foreach( array_reverse( $catPath ) as $catItem )
+            {
+                $mediaItems = $catItem->getRefItems( 'media', 'default', 'stage' );
 
-				if( !empty( $mediaItems ) ) {
-					break;
-				}
-			}
+                if( !empty( $mediaItems ) ) {
+                    break;
+                }
+            }
 
-			$view->imageItems = $mediaItems;
+            $view->imageItems = $mediaItems;
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Catalog/Lists/Head/Standard.php

Indentation +226 added lines, -226 removed lines

@@ -19,231 +19,231 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/lists/head/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog list head section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/lists/head/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 )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->headBody = $html;
-
-		/** client/html/catalog/lists/head/standard/template-body
-		 * Relative path to the HTML body template of the catalog list head client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/lists/head/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/lists/head/standard/template-body';
-		$default = 'catalog/lists/head-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->headHeader = $html;
-
-		/** client/html/catalog/lists/head/standard/template-header
-		 * Relative path to the HTML header template of the catalog list head client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/lists/head/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/lists/head/standard/template-header';
-		$default = 'catalog/lists/head-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/lists/head/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog list head html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/lists/head/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/head/decorators/global
-		 * @see client/html/catalog/lists/head/decorators/local
-		 */
-
-		/** client/html/catalog/lists/head/decorators/global
-		 * Adds a list of globally available decorators only to the catalog list head html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/lists/head/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/head/decorators/excludes
-		 * @see client/html/catalog/lists/head/decorators/local
-		 */
-
-		/** client/html/catalog/lists/head/decorators/local
-		 * Adds a list of local decorators only to the catalog list head html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/lists/head/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/head/decorators/excludes
-		 * @see client/html/catalog/lists/head/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/lists/head/' . $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 );
-	}
+    /** client/html/catalog/lists/head/standard/subparts
+     * List of HTML sub-clients rendered within the catalog list head section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/lists/head/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 )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->headBody = $html;
+
+        /** client/html/catalog/lists/head/standard/template-body
+         * Relative path to the HTML body template of the catalog list head client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/lists/head/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/lists/head/standard/template-body';
+        $default = 'catalog/lists/head-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->headHeader = $html;
+
+        /** client/html/catalog/lists/head/standard/template-header
+         * Relative path to the HTML header template of the catalog list head client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/lists/head/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/lists/head/standard/template-header';
+        $default = 'catalog/lists/head-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/lists/head/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog list head html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/lists/head/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/head/decorators/global
+         * @see client/html/catalog/lists/head/decorators/local
+         */
+
+        /** client/html/catalog/lists/head/decorators/global
+         * Adds a list of globally available decorators only to the catalog list head html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/lists/head/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/head/decorators/excludes
+         * @see client/html/catalog/lists/head/decorators/local
+         */
+
+        /** client/html/catalog/lists/head/decorators/local
+         * Adds a list of local decorators only to the catalog list head html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/lists/head/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/head/decorators/excludes
+         * @see client/html/catalog/lists/head/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/lists/head/' . $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 );
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Catalog/Lists/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 list 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/catalog/lists/name
-		 * Class name of the used catalog list 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\Catalog\Lists\Standard
-		 *
-		 * and you want to replace it with your own version named
-		 *
-		 *  \Aimeos\Client\Html\Catalog\Lists\Mylist
-		 *
-		 * then you have to set the this configuration option:
-		 *
-		 *  client/html/catalog/lists/name = Mylist
-		 *
-		 * 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 "MyList"!
-		 *
-		 * @param string Last part of the class name
-		 * @since 2014.03
-		 * @category Developer
-		 */
-		if( $name === null ) {
-			$name = $context->getConfig()->get( 'client/html/catalog/lists/name', 'Standard' );
-		}
+    /**
+     * Creates a list 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/catalog/lists/name
+         * Class name of the used catalog list 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\Catalog\Lists\Standard
+         *
+         * and you want to replace it with your own version named
+         *
+         *  \Aimeos\Client\Html\Catalog\Lists\Mylist
+         *
+         * then you have to set the this configuration option:
+         *
+         *  client/html/catalog/lists/name = Mylist
+         *
+         * 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 "MyList"!
+         *
+         * @param string Last part of the class name
+         * @since 2014.03
+         * @category Developer
+         */
+        if( $name === null ) {
+            $name = $context->getConfig()->get( 'client/html/catalog/lists/name', 'Standard' );
+        }
 
-		if( ctype_alnum( $name ) === false )
-		{
-			$classname = is_string( $name ) ? '\\Aimeos\\Client\\Html\\Catalog\\Lists\\' . $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\\Catalog\\Lists\\' . $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\\Catalog\\Lists\\' . $name;
+        $iface = '\\Aimeos\\Client\\Html\\Iface';
+        $classname = '\\Aimeos\\Client\\Html\\Catalog\\Lists\\' . $name;
 
-		$client = self::createClientBase( $context, $classname, $iface, $templatePaths );
+        $client = self::createClientBase( $context, $classname, $iface, $templatePaths );
 
-		return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/lists' );
-	}
+        return self::addClientDecorators( $context, $client, $templatePaths, 'catalog/lists' );
+    }
 }