aimeos / ai-client-html

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' );
+    }
 }
 

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

Indentation +582 added lines, -582 removed lines

@@ -19,587 +19,587 @@
  * @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/lists/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog list section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/lists/standard/subparts';
-
-	/** client/html/catalog/lists/head/name
-	 * Name of the head part used by the catalog list client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Head\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/catalog/lists/promo/name
-	 * Name of the promotion part used by the catalog list client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Promo\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/catalog/lists/quote/name
-	 * Name of the quote part used by the catalog list client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Quote\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/catalog/lists/pagination/name
-	 * Name of the pagination part used by the catalog list client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Pagination\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/catalog/lists/items/name
-	 * Name of the items part used by the catalog list client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Items\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'head', 'quote', 'promo', 'pagination', 'items', 'pagination' );
-
-	private $tags = array();
-	private $expire;
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$prefixes = array( 'f', 'l' );
-		$context = $this->getContext();
-
-		/** client/html/catalog/list
-		 * All parameters defined for the catalog list component and its subparts
-		 *
-		 * This returns all settings related to the filter component.
-		 * Please refer to the single settings for details.
-		 *
-		 * @param array Associative list of name/value settings
-		 * @category Developer
-		 * @see client/html/catalog#list
-		 */
-		$confkey = 'client/html/catalog/list';
-
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
-		{
-			$view = $this->getView();
-
-			try
-			{
-				$view = $this->setViewParams( $view, $tags, $expire );
-
-				$html = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-				}
-				$view->listBody = $html;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->listErrorList = $view->get( 'listErrorList', 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->listErrorList = $view->get( 'listErrorList', array() ) + $error;
-			}
-
-			/** client/html/catalog/lists/standard/template-body
-			 * Relative path to the HTML body template of the catalog list client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the result shown in the body of the frontend. The
-			 * configuration string is the path to the template file relative
-			 * to the templates directory (usually in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page body
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/lists/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/lists/standard/template-body';
-			$default = 'catalog/lists/body-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		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 )
-	{
-		$prefixes = array( 'f', 'l' );
-		$context = $this->getContext();
-		$confkey = 'client/html/catalog/list';
-
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
-		{
-			$view = $this->getView();
-
-			try
-			{
-				$view = $this->setViewParams( $view, $tags, $expire );
-
-				$html = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-				}
-				$view->listHeader = $html;
-			}
-			catch( \Exception $e )
-			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-			}
-
-			/** client/html/catalog/lists/standard/template-header
-			 * Relative path to the HTML header template of the catalog list client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the HTML code that is inserted into the HTML page header
-			 * of the rendered page in the frontend. The configuration string is the
-			 * path to the template file relative to the templates directory (usually
-			 * in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page head
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/lists/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/lists/standard/template-header';
-			$default = 'catalog/lists/header-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		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/catalog/lists/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog list html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/lists/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/decorators/global
-		 * @see client/html/catalog/lists/decorators/local
-		 */
-
-		/** client/html/catalog/lists/decorators/global
-		 * Adds a list of globally available decorators only to the catalog list html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/lists/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/decorators/excludes
-		 * @see client/html/catalog/lists/decorators/local
-		 */
-
-		/** client/html/catalog/lists/decorators/local
-		 * Adds a list of local decorators only to the catalog list html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/lists/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/lists/decorators/excludes
-		 * @see client/html/catalog/lists/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/lists/' . $type, $name );
-	}
-
-
-	/**
-	 * Processes the input, e.g. store given values.
-	 * A view must be available and this method doesn't generate any output
-	 * besides setting view variables.
-	 */
-	public function process()
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
-
-		try
-		{
-			$site = $context->getLocale()->getSite()->getCode();
-			$params = $this->getClientParams( $view->param() );
-			$context->getSession()->set( 'aimeos/catalog/lists/params/last/' . $site, $params );
-
-			parent::process();
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->listErrorList = $view->get( 'listErrorList', 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->listErrorList = $view->get( 'listErrorList', array() ) + $error;
-		}
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$context = $this->getContext();
-			$config = $context->getConfig();
-
-			$products = $this->getProductList( $view );
-
-			$text = (string) $view->param( 'f_search' );
-			$catid = (string) $view->param( 'f_catid' );
-
-			if( $catid == '' ) {
-				$catid = $config->get( 'client/html/catalog/lists/catid-default', '' );
-			}
-
-			if( $text === '' && $catid !== '' )
-			{
-				$domains = $config->get( 'client/html/catalog/domains', array( 'media', 'text' ) );
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-				$listCatPath = $controller->getCatalogPath( $catid, $domains );
-
-				if( ( $categoryItem = end( $listCatPath ) ) !== false ) {
-					$view->listCurrentCatItem = $categoryItem;
-				}
-
-				$view->listCatPath = $listCatPath;
-
-				$this->addMetaItem( $listCatPath, 'catalog', $this->expire, $this->tags );
-				$this->addMetaList( array_keys( $listCatPath ), 'catalog', $this->expire );
-			}
-
-			/** client/html/catalog/lists/stock/enable
-			 * Enables or disables displaying product stock levels in product list views
-			 *
-			 * This configuration option allows shop owners to display product
-			 * stock levels for each product in list views or to disable
-			 * fetching product stock information.
-			 *
-			 * The stock information is fetched via AJAX and inserted via Javascript.
-			 * This allows to cache product items by leaving out such highly
-			 * dynamic content like stock levels which changes with each order.
-			 *
-			 * @param boolean Value of "1" to display stock levels, "0" to disable displaying them
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/detail/stock/enable
-			 * @see client/html/catalog/stock/url/target
-			 * @see client/html/catalog/stock/url/controller
-			 * @see client/html/catalog/stock/url/action
-			 * @see client/html/catalog/stock/url/config
-			 */
-			if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true ) {
-				$view->listStockUrl = $this->getStockUrl( $view, array_keys( $products ) );
-			}
-
-
-			$this->addMetaItem( $products, 'product', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $products ), 'product', $this->expire );
-
-			// Delete cache when products are added or deleted even when in "tag-all" mode
-			$this->tags[] = 'product';
-
-			$view->listParams = $this->getClientParams( $view->param() );
-			$view->listPageCurr = $this->getProductListPage( $view );
-			$view->listPageSize = $this->getProductListSize( $view );
-			$view->listProductTotal = $this->getProductListTotal( $view );
-			$view->listProductSort = $view->param( 'f_sort', 'relevance' );
-			$view->listProductItems = $products;
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Returns the URL to fetch the stock level details of the given products
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @param array $productIds List of product IDs
-	 * @return string Generated stock level URL
-	 */
-	protected function getStockUrl( \Aimeos\MW\View\Iface $view, array $productIds )
-	{
-		/** client/html/catalog/stock/url/target
-		 * Destination of the URL where the controller specified in the URL is known
-		 *
-		 * The destination can be a page ID like in a content management system or the
-		 * module of a software development framework. This "target" must contain or know
-		 * the controller that should be called by the generated URL.
-		 *
-		 * @param string Destination of the URL
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stock/url/controller
-		 * @see client/html/catalog/stock/url/action
-		 * @see client/html/catalog/stock/url/config
-		 */
-		$stockTarget = $view->config( 'client/html/catalog/stock/url/target' );
-
-		/** client/html/catalog/stock/url/controller
-		 * Name of the controller whose action should be called
-		 *
-		 * In Model-View-Controller (MVC) applications, the controller contains the methods
-		 * that create parts of the output displayed in the generated HTML page. Controller
-		 * names are usually alpha-numeric.
-		 *
-		 * @param string Name of the controller
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stock/url/target
-		 * @see client/html/catalog/stock/url/action
-		 * @see client/html/catalog/stock/url/config
-		*/
-		$stockController = $view->config( 'client/html/catalog/stock/url/controller', 'catalog' );
-
-		/** client/html/catalog/stock/url/action
-		 * Name of the action that should create the output
-		 *
-		 * In Model-View-Controller (MVC) applications, actions are the methods of a
-		 * controller that create parts of the output displayed in the generated HTML page.
-		 * Action names are usually alpha-numeric.
-		 *
-		 * @param string Name of the action
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stock/url/target
-		 * @see client/html/catalog/stock/url/controller
-		 * @see client/html/catalog/stock/url/config
-		*/
-		$stockAction = $view->config( 'client/html/catalog/stock/url/action', 'stock' );
-
-		/** client/html/catalog/stock/url/config
-		 * Associative list of configuration options used for generating the URL
-		 *
-		 * You can specify additional options as key/value pairs used when generating
-		 * the URLs, like
-		 *
-		 *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
-		 *
-		 * The available key/value pairs depend on the application that embeds the e-commerce
-		 * framework. This is because the infrastructure of the application is used for
-		 * generating the URLs. The full list of available config options is referenced
-		 * in the "see also" section of this page.
-		 *
-		 * @param string Associative list of configuration options
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/stock/url/target
-		 * @see client/html/catalog/stock/url/controller
-		 * @see client/html/catalog/stock/url/action
-		 * @see client/html/url/config
-		*/
-		$stockConfig = $view->config( 'client/html/catalog/stock/url/config', array() );
-
-		sort( $productIds );
-
-		$params = array( 's_prodid' => implode( ' ', $productIds ) );
-		return $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
-	}
+    /** client/html/catalog/lists/standard/subparts
+     * List of HTML sub-clients rendered within the catalog list section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/lists/standard/subparts';
+
+    /** client/html/catalog/lists/head/name
+     * Name of the head part used by the catalog list client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Head\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/catalog/lists/promo/name
+     * Name of the promotion part used by the catalog list client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Promo\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/catalog/lists/quote/name
+     * Name of the quote part used by the catalog list client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Quote\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/catalog/lists/pagination/name
+     * Name of the pagination part used by the catalog list client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Pagination\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/catalog/lists/items/name
+     * Name of the items part used by the catalog list client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Lists\Items\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartNames = array( 'head', 'quote', 'promo', 'pagination', 'items', 'pagination' );
+
+    private $tags = array();
+    private $expire;
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $prefixes = array( 'f', 'l' );
+        $context = $this->getContext();
+
+        /** client/html/catalog/list
+         * All parameters defined for the catalog list component and its subparts
+         *
+         * This returns all settings related to the filter component.
+         * Please refer to the single settings for details.
+         *
+         * @param array Associative list of name/value settings
+         * @category Developer
+         * @see client/html/catalog#list
+         */
+        $confkey = 'client/html/catalog/list';
+
+        if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
+        {
+            $view = $this->getView();
+
+            try
+            {
+                $view = $this->setViewParams( $view, $tags, $expire );
+
+                $html = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+                }
+                $view->listBody = $html;
+            }
+            catch( \Aimeos\Client\Html\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+                $view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\Controller\Frontend\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+                $view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\MShop\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+                $view->listErrorList = $view->get( 'listErrorList', 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->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+            }
+
+            /** client/html/catalog/lists/standard/template-body
+             * Relative path to the HTML body template of the catalog list client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the result shown in the body of the frontend. The
+             * configuration string is the path to the template file relative
+             * to the templates directory (usually in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page body
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/lists/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/lists/standard/template-body';
+            $default = 'catalog/lists/body-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
+        }
+        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 )
+    {
+        $prefixes = array( 'f', 'l' );
+        $context = $this->getContext();
+        $confkey = 'client/html/catalog/list';
+
+        if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
+        {
+            $view = $this->getView();
+
+            try
+            {
+                $view = $this->setViewParams( $view, $tags, $expire );
+
+                $html = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+                }
+                $view->listHeader = $html;
+            }
+            catch( \Exception $e )
+            {
+                $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            }
+
+            /** client/html/catalog/lists/standard/template-header
+             * Relative path to the HTML header template of the catalog list client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the HTML code that is inserted into the HTML page header
+             * of the rendered page in the frontend. The configuration string is the
+             * path to the template file relative to the templates directory (usually
+             * in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page head
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/lists/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/lists/standard/template-header';
+            $default = 'catalog/lists/header-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
+        }
+        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/catalog/lists/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog list html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/lists/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/decorators/global
+         * @see client/html/catalog/lists/decorators/local
+         */
+
+        /** client/html/catalog/lists/decorators/global
+         * Adds a list of globally available decorators only to the catalog list html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/lists/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/decorators/excludes
+         * @see client/html/catalog/lists/decorators/local
+         */
+
+        /** client/html/catalog/lists/decorators/local
+         * Adds a list of local decorators only to the catalog list html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/lists/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/lists/decorators/excludes
+         * @see client/html/catalog/lists/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/lists/' . $type, $name );
+    }
+
+
+    /**
+     * Processes the input, e.g. store given values.
+     * A view must be available and this method doesn't generate any output
+     * besides setting view variables.
+     */
+    public function process()
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
+
+        try
+        {
+            $site = $context->getLocale()->getSite()->getCode();
+            $params = $this->getClientParams( $view->param() );
+            $context->getSession()->set( 'aimeos/catalog/lists/params/last/' . $site, $params );
+
+            parent::process();
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->listErrorList = $view->get( 'listErrorList', 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->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+        }
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $context = $this->getContext();
+            $config = $context->getConfig();
+
+            $products = $this->getProductList( $view );
+
+            $text = (string) $view->param( 'f_search' );
+            $catid = (string) $view->param( 'f_catid' );
+
+            if( $catid == '' ) {
+                $catid = $config->get( 'client/html/catalog/lists/catid-default', '' );
+            }
+
+            if( $text === '' && $catid !== '' )
+            {
+                $domains = $config->get( 'client/html/catalog/domains', array( 'media', 'text' ) );
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+                $listCatPath = $controller->getCatalogPath( $catid, $domains );
+
+                if( ( $categoryItem = end( $listCatPath ) ) !== false ) {
+                    $view->listCurrentCatItem = $categoryItem;
+                }
+
+                $view->listCatPath = $listCatPath;
+
+                $this->addMetaItem( $listCatPath, 'catalog', $this->expire, $this->tags );
+                $this->addMetaList( array_keys( $listCatPath ), 'catalog', $this->expire );
+            }
+
+            /** client/html/catalog/lists/stock/enable
+             * Enables or disables displaying product stock levels in product list views
+             *
+             * This configuration option allows shop owners to display product
+             * stock levels for each product in list views or to disable
+             * fetching product stock information.
+             *
+             * The stock information is fetched via AJAX and inserted via Javascript.
+             * This allows to cache product items by leaving out such highly
+             * dynamic content like stock levels which changes with each order.
+             *
+             * @param boolean Value of "1" to display stock levels, "0" to disable displaying them
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/detail/stock/enable
+             * @see client/html/catalog/stock/url/target
+             * @see client/html/catalog/stock/url/controller
+             * @see client/html/catalog/stock/url/action
+             * @see client/html/catalog/stock/url/config
+             */
+            if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true ) {
+                $view->listStockUrl = $this->getStockUrl( $view, array_keys( $products ) );
+            }
+
+
+            $this->addMetaItem( $products, 'product', $this->expire, $this->tags );
+            $this->addMetaList( array_keys( $products ), 'product', $this->expire );
+
+            // Delete cache when products are added or deleted even when in "tag-all" mode
+            $this->tags[] = 'product';
+
+            $view->listParams = $this->getClientParams( $view->param() );
+            $view->listPageCurr = $this->getProductListPage( $view );
+            $view->listPageSize = $this->getProductListSize( $view );
+            $view->listProductTotal = $this->getProductListTotal( $view );
+            $view->listProductSort = $view->param( 'f_sort', 'relevance' );
+            $view->listProductItems = $products;
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Returns the URL to fetch the stock level details of the given products
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @param array $productIds List of product IDs
+     * @return string Generated stock level URL
+     */
+    protected function getStockUrl( \Aimeos\MW\View\Iface $view, array $productIds )
+    {
+        /** client/html/catalog/stock/url/target
+         * Destination of the URL where the controller specified in the URL is known
+         *
+         * The destination can be a page ID like in a content management system or the
+         * module of a software development framework. This "target" must contain or know
+         * the controller that should be called by the generated URL.
+         *
+         * @param string Destination of the URL
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stock/url/controller
+         * @see client/html/catalog/stock/url/action
+         * @see client/html/catalog/stock/url/config
+         */
+        $stockTarget = $view->config( 'client/html/catalog/stock/url/target' );
+
+        /** client/html/catalog/stock/url/controller
+         * Name of the controller whose action should be called
+         *
+         * In Model-View-Controller (MVC) applications, the controller contains the methods
+         * that create parts of the output displayed in the generated HTML page. Controller
+         * names are usually alpha-numeric.
+         *
+         * @param string Name of the controller
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stock/url/target
+         * @see client/html/catalog/stock/url/action
+         * @see client/html/catalog/stock/url/config
+         */
+        $stockController = $view->config( 'client/html/catalog/stock/url/controller', 'catalog' );
+
+        /** client/html/catalog/stock/url/action
+         * Name of the action that should create the output
+         *
+         * In Model-View-Controller (MVC) applications, actions are the methods of a
+         * controller that create parts of the output displayed in the generated HTML page.
+         * Action names are usually alpha-numeric.
+         *
+         * @param string Name of the action
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stock/url/target
+         * @see client/html/catalog/stock/url/controller
+         * @see client/html/catalog/stock/url/config
+         */
+        $stockAction = $view->config( 'client/html/catalog/stock/url/action', 'stock' );
+
+        /** client/html/catalog/stock/url/config
+         * Associative list of configuration options used for generating the URL
+         *
+         * You can specify additional options as key/value pairs used when generating
+         * the URLs, like
+         *
+         *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
+         *
+         * The available key/value pairs depend on the application that embeds the e-commerce
+         * framework. This is because the infrastructure of the application is used for
+         * generating the URLs. The full list of available config options is referenced
+         * in the "see also" section of this page.
+         *
+         * @param string Associative list of configuration options
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/stock/url/target
+         * @see client/html/catalog/stock/url/controller
+         * @see client/html/catalog/stock/url/action
+         * @see client/html/url/config
+         */
+        $stockConfig = $view->config( 'client/html/catalog/stock/url/config', array() );
+
+        sort( $productIds );
+
+        $params = array( 's_prodid' => implode( ' ', $productIds ) );
+        return $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
+    }
 }

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

Indentation +310 added lines, -310 removed lines

@@ -19,315 +19,315 @@
  * @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/promo/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog list promo 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/promo/standard/subparts';
-	private $subPartNames = array();
-	private $tags = array();
-	private $expire;
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->promoBody = $html;
-
-		/** client/html/catalog/lists/promo/standard/template-body
-		 * Relative path to the HTML body template of the catalog list promotion 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/promo/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/lists/promo/standard/template-body';
-		$default = 'catalog/lists/promo-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->promoHeader = $html;
-
-		/** client/html/catalog/lists/promo/standard/template-header
-		 * Relative path to the HTML header template of the catalog list promotion 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/promo/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/lists/promo/standard/template-header';
-		$default = 'catalog/lists/promo-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/promo/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog list promo 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/promo/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/promo/decorators/global
-		 * @see client/html/catalog/lists/promo/decorators/local
-		 */
-
-		/** client/html/catalog/lists/promo/decorators/global
-		 * Adds a list of globally available decorators only to the catalog list promo 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/promo/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/promo/decorators/excludes
-		 * @see client/html/catalog/lists/promo/decorators/local
-		 */
-
-		/** client/html/catalog/lists/promo/decorators/local
-		 * Adds a list of local decorators only to the catalog list promo 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/promo/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/promo/decorators/excludes
-		 * @see client/html/catalog/lists/promo/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/lists/promo/' . $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 ) )
-		{
-			$products = array();
-			$context = $this->getContext();
-			$config = $context->getConfig();
-
-			if( isset( $view->listCurrentCatItem ) ) {
-				$catId = $view->listCurrentCatItem->getId();
-			} else {
-				$catId = $config->get( 'client/html/catalog/lists/catid-default', '' );
-			}
-
-			if( $catId != '' )
-			{
-				/** client/html/catalog/lists/promo/size
-				 * The maximum number of products that should be shown in the promotion section
-				 *
-				 * Each product list can render a list of promoted products on
-				 * top if there are any products associated to that category whose
-				 * list type is "promotion". This option limits the maximum number
-				 * of products that are displayed. It takes only effect if more
-				 * promotional products are added to this category than the set
-				 * value.
-				 *
-				 * @param integer Number of promotion products
-				 * @since 2014.03
-				 * @category User
-				 * @category Developer
-				 */
-				$size = $config->get( 'client/html/catalog/lists/promo/size', 6 );
-				$domains = $config->get( 'client/html/catalog/lists/domains', array( 'media', 'price', 'text' ) );
-
-				$total = null;
-
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-				$filter = $controller->createIndexFilterCategory( $catId, 'relevance', '+', 0, $size, 'promotion' );
-				$products = $controller->getIndexItems( $filter, $domains, $total );
-			}
-
-
-			if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true )
-			{
-				$stockTarget = $config->get( 'client/html/catalog/stock/url/target' );
-				$stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' );
-				$stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' );
-				$stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() );
-
-				$productIds = array_keys( $products );
-				sort( $productIds );
-
-				$params = array( 's_prodid' => implode( ' ', $productIds ) );
-				$view->promoStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
-			}
-
-
-			$this->addMetaItem( $products, 'product', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $products ), 'product', $this->expire );
-
-
-			$view->promoItems = $products;
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
+    /** client/html/catalog/lists/promo/standard/subparts
+     * List of HTML sub-clients rendered within the catalog list promo 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/promo/standard/subparts';
+    private $subPartNames = array();
+    private $tags = array();
+    private $expire;
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->promoBody = $html;
+
+        /** client/html/catalog/lists/promo/standard/template-body
+         * Relative path to the HTML body template of the catalog list promotion 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/promo/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/lists/promo/standard/template-body';
+        $default = 'catalog/lists/promo-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->promoHeader = $html;
+
+        /** client/html/catalog/lists/promo/standard/template-header
+         * Relative path to the HTML header template of the catalog list promotion 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/promo/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/lists/promo/standard/template-header';
+        $default = 'catalog/lists/promo-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/promo/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog list promo 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/promo/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/promo/decorators/global
+         * @see client/html/catalog/lists/promo/decorators/local
+         */
+
+        /** client/html/catalog/lists/promo/decorators/global
+         * Adds a list of globally available decorators only to the catalog list promo 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/promo/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/promo/decorators/excludes
+         * @see client/html/catalog/lists/promo/decorators/local
+         */
+
+        /** client/html/catalog/lists/promo/decorators/local
+         * Adds a list of local decorators only to the catalog list promo 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/promo/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/promo/decorators/excludes
+         * @see client/html/catalog/lists/promo/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/lists/promo/' . $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 ) )
+        {
+            $products = array();
+            $context = $this->getContext();
+            $config = $context->getConfig();
+
+            if( isset( $view->listCurrentCatItem ) ) {
+                $catId = $view->listCurrentCatItem->getId();
+            } else {
+                $catId = $config->get( 'client/html/catalog/lists/catid-default', '' );
+            }
+
+            if( $catId != '' )
+            {
+                /** client/html/catalog/lists/promo/size
+                 * The maximum number of products that should be shown in the promotion section
+                 *
+                 * Each product list can render a list of promoted products on
+                 * top if there are any products associated to that category whose
+                 * list type is "promotion". This option limits the maximum number
+                 * of products that are displayed. It takes only effect if more
+                 * promotional products are added to this category than the set
+                 * value.
+                 *
+                 * @param integer Number of promotion products
+                 * @since 2014.03
+                 * @category User
+                 * @category Developer
+                 */
+                $size = $config->get( 'client/html/catalog/lists/promo/size', 6 );
+                $domains = $config->get( 'client/html/catalog/lists/domains', array( 'media', 'price', 'text' ) );
+
+                $total = null;
+
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+                $filter = $controller->createIndexFilterCategory( $catId, 'relevance', '+', 0, $size, 'promotion' );
+                $products = $controller->getIndexItems( $filter, $domains, $total );
+            }
+
+
+            if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true )
+            {
+                $stockTarget = $config->get( 'client/html/catalog/stock/url/target' );
+                $stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' );
+                $stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' );
+                $stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() );
+
+                $productIds = array_keys( $products );
+                sort( $productIds );
+
+                $params = array( 's_prodid' => implode( ' ', $productIds ) );
+                $view->promoStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
+            }
+
+
+            $this->addMetaItem( $products, 'product', $this->expire, $this->tags );
+            $this->addMetaList( array_keys( $products ), 'product', $this->expire );
+
+
+            $view->promoItems = $products;
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

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

Indentation +239 added lines, -239 removed lines

@@ -19,267 +19,267 @@
  * @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/pagination/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog list pagination 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/pagination/standard/subparts';
-	private $subPartNames = array();
-	private $header;
-	private $cache;
+    /** client/html/catalog/lists/pagination/standard/subparts
+     * List of HTML sub-clients rendered within the catalog list pagination 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/pagination/standard/subparts';
+    private $subPartNames = array();
+    private $header;
+    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->pagiBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->pagiBody = $html;
 
-		/** client/html/catalog/lists/pagination/standard/template-body
-		 * Relative path to the HTML body template of the catalog list pagination 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/pagination/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/lists/pagination/standard/template-body';
-		$default = 'catalog/lists/pagination-body-default.php';
+        /** client/html/catalog/lists/pagination/standard/template-body
+         * Relative path to the HTML body template of the catalog list pagination 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/pagination/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/lists/pagination/standard/template-body';
+        $default = 'catalog/lists/pagination-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 )
-	{
-		// output header only once
-		if( $this->header !== null ) {
-			return '';
-		}
+    /**
+     * 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 )
+    {
+        // output header only once
+        if( $this->header !== null ) {
+            return '';
+        }
 
-		$this->header = true;
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+        $this->header = true;
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
 
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->pagiHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->pagiHeader = $html;
 
-		/** client/html/catalog/lists/pagination/standard/template-header
-		 * Relative path to the HTML header template of the catalog list pagination 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/pagination/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/lists/pagination/standard/template-header';
-		$default = 'catalog/lists/pagination-header-default.php';
+        /** client/html/catalog/lists/pagination/standard/template-header
+         * Relative path to the HTML header template of the catalog list pagination 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/pagination/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/lists/pagination/standard/template-header';
+        $default = 'catalog/lists/pagination-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/lists/pagination/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog list pagination 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/pagination/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/pagination/decorators/global
-		 * @see client/html/catalog/lists/pagination/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/lists/pagination/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog list pagination 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/pagination/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/pagination/decorators/global
+         * @see client/html/catalog/lists/pagination/decorators/local
+         */
 
-		/** client/html/catalog/lists/pagination/decorators/global
-		 * Adds a list of globally available decorators only to the catalog list pagination 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/pagination/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/pagination/decorators/excludes
-		 * @see client/html/catalog/lists/pagination/decorators/local
-		 */
+        /** client/html/catalog/lists/pagination/decorators/global
+         * Adds a list of globally available decorators only to the catalog list pagination 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/pagination/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/pagination/decorators/excludes
+         * @see client/html/catalog/lists/pagination/decorators/local
+         */
 
-		/** client/html/catalog/lists/pagination/decorators/local
-		 * Adds a list of local decorators only to the catalog list pagination 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/pagination/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/pagination/decorators/excludes
-		 * @see client/html/catalog/lists/pagination/decorators/global
-		 */
+        /** client/html/catalog/lists/pagination/decorators/local
+         * Adds a list of local decorators only to the catalog list pagination 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/pagination/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/pagination/decorators/excludes
+         * @see client/html/catalog/lists/pagination/decorators/global
+         */
 
-		return $this->createSubClient( 'catalog/lists/pagination/' . $type, $name );
-	}
+        return $this->createSubClient( 'catalog/lists/pagination/' . $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 ) )
-		{
-			$total = $view->listProductTotal;
-			$current = $view->listPageCurr;
-			$last = ( $total != 0 ? ceil( $total / $view->listPageSize ) : 1 );
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $total = $view->listProductTotal;
+            $current = $view->listPageCurr;
+            $last = ( $total != 0 ? ceil( $total / $view->listPageSize ) : 1 );
 
-			$view->pagiPageFirst = 1;
-			$view->pagiPagePrev = ( $current > 1 ? $current - 1 : 1 );
-			$view->pagiPageNext = ( $current < $last ? $current + 1 : $last );
-			$view->pagiPageLast = $last;
+            $view->pagiPageFirst = 1;
+            $view->pagiPagePrev = ( $current > 1 ? $current - 1 : 1 );
+            $view->pagiPageNext = ( $current < $last ? $current + 1 : $last );
+            $view->pagiPageLast = $last;
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file