aimeos / ai-client-html

client/html/src/Client/Html/Catalog/Detail/Social/Standard.php

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

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/detail/social/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog detail social 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.09
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/detail/social/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->socialBody = $html;
-
-		/** client/html/catalog/detail/social/standard/template-body
-		 * Relative path to the HTML body template of the catalog detail social 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.09
-		 * @category Developer
-		 * @see client/html/catalog/detail/social/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/detail/social/standard/template-body';
-		$default = 'catalog/detail/social-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->socialHeader = $html;
-
-		/** client/html/catalog/detail/social/standard/template-header
-		 * Relative path to the HTML header template of the catalog detail social 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.09
-		 * @category Developer
-		 * @see client/html/catalog/detail/social/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/detail/social/standard/template-header';
-		$default = 'catalog/detail/social-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/detail/social/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog detail social 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/detail/social/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/detail/social/decorators/global
-		 * @see client/html/catalog/detail/social/decorators/local
-		 */
-
-		/** client/html/catalog/detail/social/decorators/global
-		 * Adds a list of globally available decorators only to the catalog detail social 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/detail/social/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/detail/social/decorators/excludes
-		 * @see client/html/catalog/detail/social/decorators/local
-		 */
-
-		/** client/html/catalog/detail/social/decorators/local
-		 * Adds a list of local decorators only to the catalog detail social 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/detail/social/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/detail/social/decorators/excludes
-		 * @see client/html/catalog/detail/social/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/detail/social/' . $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/detail/social/standard/subparts
+     * List of HTML sub-clients rendered within the catalog detail social 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.09
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/detail/social/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->socialBody = $html;
+
+        /** client/html/catalog/detail/social/standard/template-body
+         * Relative path to the HTML body template of the catalog detail social 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.09
+         * @category Developer
+         * @see client/html/catalog/detail/social/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/detail/social/standard/template-body';
+        $default = 'catalog/detail/social-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->socialHeader = $html;
+
+        /** client/html/catalog/detail/social/standard/template-header
+         * Relative path to the HTML header template of the catalog detail social 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.09
+         * @category Developer
+         * @see client/html/catalog/detail/social/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/detail/social/standard/template-header';
+        $default = 'catalog/detail/social-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/detail/social/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog detail social 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/detail/social/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/detail/social/decorators/global
+         * @see client/html/catalog/detail/social/decorators/local
+         */
+
+        /** client/html/catalog/detail/social/decorators/global
+         * Adds a list of globally available decorators only to the catalog detail social 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/detail/social/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/detail/social/decorators/excludes
+         * @see client/html/catalog/detail/social/decorators/local
+         */
+
+        /** client/html/catalog/detail/social/decorators/local
+         * Adds a list of local decorators only to the catalog detail social 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/detail/social/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/detail/social/decorators/excludes
+         * @see client/html/catalog/detail/social/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/detail/social/' . $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

Spacing +13 added lines, -13 removed lines

@@ -67,13 +67,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->socialBody = $html;
 
@@ -100,7 +100,7 @@ 
 		$tplconf = 'client/html/catalog/detail/social/standard/template-body';
 		$default = 'catalog/detail/social-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -112,13 +112,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->socialHeader = $html;
 
@@ -146,7 +146,7 @@ 
 		$tplconf = 'client/html/catalog/detail/social/standard/template-header';
 		$default = 'catalog/detail/social-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -157,7 +157,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/detail/social/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog detail social html client
@@ -233,7 +233,7 @@ 
 		 * @see client/html/catalog/detail/social/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/detail/social/' . $type, $name );
+		return $this->createSubClient('catalog/detail/social/'.$type, $name);
 	}
 
 
@@ -244,6 +244,6 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 }
\ No newline at end of file

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

Doc Comments +1 added lines, -1 removed lines

@@ -277,7 +277,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

Indentation +596 added lines, -596 removed lines

@@ -19,601 +19,601 @@
  * @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/detail/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog detail 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/detail/standard/subparts';
-
-	/** client/html/catalog/detail/social/name
-	 * Name of the social part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Social\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.09
-	 * @category Developer
-	 */
-
-	/** client/html/catalog/detail/image/name
-	 * Name of the image part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Image\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/detail/basic/name
-	 * Name of the basic part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basic\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/detail/actions/name
-	 * Name of the actions part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Actions\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.09
-	 * @category Developer
-	 */
-
-	/** client/html/catalog/detail/basket/name
-	 * Name of the basket part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basket\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/detail/bundle/name
-	 * Name of the bundle part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Bundle\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.11
-	 * @category Developer
-	 */
-
-	/** client/html/catalog/detail/additional/name
-	 * Name of the additional part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\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/detail/suggest/name
-	 * Name of the suggest part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Suggest\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/detail/bought/name
-	 * Name of the bought together part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Bought\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.09
-	 * @category Developer
-	 */
-
-	/** client/html/catalog/detail/seen/name
-	 * Name of the seen part used by the catalog detail client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Seen\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( 'image', 'basic', 'basket', 'actions', 'social', 'bundle', 'additional', 'suggest', 'bought', 'seen' );
-
-	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( 'd' );
-		$context = $this->getContext();
-
-		/** client/html/catalog/detail
-		 * All parameters defined for the catalog detail component and its subparts
-		 *
-		 * This returns all settings related to the detail component.
-		 * Please refer to the single settings for details.
-		 *
-		 * @param array Associative list of name/value settings
-		 * @category Developer
-		 * @see client/html/catalog#detail
-		 */
-		$confkey = 'client/html/catalog/detail';
-
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
-		{
-			$view = $this->getView();
-
-			try
-			{
-				$view = $this->setViewParams( $view, $tags, $expire );
-
-				$output = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-				}
-				$view->detailBody = $output;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->detailErrorList = $view->get( 'detailErrorList', 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->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-			}
-
-			/** client/html/catalog/detail/standard/template-body
-			 * Relative path to the HTML body template of the catalog detail 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/detail/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/detail/standard/template-body';
-			$default = 'catalog/detail/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( 'd' );
-		$context = $this->getContext();
-		$confkey = 'client/html/catalog/detail';
-
-
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
-		{
-			$view = $this->getView();
-
-			try
-			{
-				$view = $this->setViewParams( $view, $tags, $expire );
-
-				$output = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-				}
-				$view->detailHeader = $output;
-			}
-			catch( \Exception $e )
-			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-			}
-
-			/** client/html/catalog/detail/standard/template-header
-			 * Relative path to the HTML header template of the catalog detail 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/detail/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/detail/standard/template-header';
-			$default = 'catalog/detail/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/detail/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog detail 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/detail/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/detail/decorators/global
-		 * @see client/html/catalog/detail/decorators/local
-		 */
-
-		/** client/html/catalog/detail/decorators/global
-		 * Adds a list of globally available decorators only to the catalog detail 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/detail/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/detail/decorators/excludes
-		 * @see client/html/catalog/detail/decorators/local
-		 */
-
-		/** client/html/catalog/detail/decorators/local
-		 * Adds a list of local decorators only to the catalog detail 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/detail/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/detail/decorators/excludes
-		 * @see client/html/catalog/detail/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/detail/' . $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/detail/params/last' . $site, $params );
-
-			parent::process();
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->detailErrorList = $view->get( 'detailErrorList', 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->detailErrorList = $view->get( 'detailErrorList', 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();
-			$domains = array( 'media', 'price', 'text', 'attribute', 'product' );
-			$productItem = $this->getProductItem( $view->param( 'd_prodid' ), $domains );
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-
-			$attrManager = $controller->createManager( 'attribute' );
-			$attrSearch = $attrManager->createSearch( true );
-			$expr = array(
-				$attrSearch->compare( '==', 'attribute.id', array_keys( $productItem->getRefItems( 'attribute' ) ) ),
-				$attrSearch->getConditions(),
-			);
-			$attrSearch->setConditions( $attrSearch->combine( '&&', $expr ) );
-			$attributes = $attrManager->searchItems( $attrSearch, $domains );
-
-			$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
-
-
-			$mediaManager = $controller->createManager( 'media' );
-			$mediaSearch = $mediaManager->createSearch( true );
-			$expr = array(
-				$mediaSearch->compare( '==', 'media.id', array_keys( $productItem->getRefItems( 'media' ) ) ),
-				$mediaSearch->getConditions(),
-			);
-			$mediaSearch->setConditions( $mediaSearch->combine( '&&', $expr ) );
-			$media = $mediaManager->searchItems( $mediaSearch, $domains );
-
-			$this->addMetaItem( $media, 'media', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $media ), 'media', $this->expire );
-
-
-			$view->detailProductItem = $productItem;
-			$view->detailProductAttributeItems = $attributes;
-			$view->detailProductMediaItems = $media;
-			$view->detailParams = $this->getClientParams( $view->param() );
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Returns the product item for the given ID including the domain items
-	 *
-	 * @param string $prodid Unique product ID
-	 * @param array List of domain items that should be fetched too
-	 * @throws \Aimeos\Client\Html\Exception If no product item was found
-	 * @return \Aimeos\MShop\Product\Item\Iface Product item object
-	 */
-	protected function getProductItem( $prodid, array $domains )
-	{
-		$context = $this->getContext();
-		$config = $context->getConfig();
-
-		if( $prodid == '' )
-		{
-			/** client/html/catalog/detail/prodid-default
-			 * The default product ID used if none is given as parameter
-			 *
-			 * To display a product detail view or a part of it for a specific
-			 * product, you can configure its ID using this setting. This is
-			 * most useful in a CMS where the product ID can be configured
-			 * separately for each content node.
-			 *
-			 * @param string Product ID
-			 * @since 2016.01
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/lists/catid-default
-			 */
-			$prodid = $config->get( 'client/html/catalog/detail/prodid-default', '' );
-		}
-
-		/** client/html/catalog/domains
-		 * A list of domain names whose items should be available in the catalog view templates
-		 *
-		 * @see client/html/catalog/detail/domains
-		 */
-		$domains = $config->get( 'client/html/catalog/domains', $domains );
-
-		/** client/html/catalog/detail/domains
-		 * A list of domain names whose items should be available in the product detail view template
-		 *
-		 * The templates rendering product details usually add the images,
-		 * prices, texts, attributes, products, etc. associated to the product
-		 * item. If you want to display additional or less content, you can
-		 * configure your own list of domains (attribute, media, price, product,
-		 * text, etc. are domains) whose items are fetched from the storage.
-		 * Please keep in mind that the more domains you add to the configuration,
-		 * the more time is required for fetching the content!
-		 *
-		 * Since version 2014.05 this configuration option overwrites the
-		 * "client/html/catalog/domains" option that allows to configure the
-		 * domain names of the items fetched for all catalog related data.
-		 *
-		 * @param array List of domain names
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/domains
-		 * @see client/html/catalog/lists/domains
-		 */
-		$domains = $config->get( 'client/html/catalog/detail/domains', $domains );
-
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-		$items = $controller->getProductItems( array( $prodid ), $domains );
-
-		if( ( $item = reset( $items ) ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'No product with ID "%1$s" found', $prodid ) );
-		}
-
-		$this->addMetaItem( $item, 'product', $this->expire, $this->tags );
-		$this->addMetaList( $prodid, 'product', $this->expire );
-
-		return $item;
-	}
+    /** client/html/catalog/detail/standard/subparts
+     * List of HTML sub-clients rendered within the catalog detail 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/detail/standard/subparts';
+
+    /** client/html/catalog/detail/social/name
+     * Name of the social part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Social\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.09
+     * @category Developer
+     */
+
+    /** client/html/catalog/detail/image/name
+     * Name of the image part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Image\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/detail/basic/name
+     * Name of the basic part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basic\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/detail/actions/name
+     * Name of the actions part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Actions\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.09
+     * @category Developer
+     */
+
+    /** client/html/catalog/detail/basket/name
+     * Name of the basket part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Basket\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/detail/bundle/name
+     * Name of the bundle part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Bundle\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.11
+     * @category Developer
+     */
+
+    /** client/html/catalog/detail/additional/name
+     * Name of the additional part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Additional\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/detail/suggest/name
+     * Name of the suggest part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Suggest\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/detail/bought/name
+     * Name of the bought together part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Bought\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.09
+     * @category Developer
+     */
+
+    /** client/html/catalog/detail/seen/name
+     * Name of the seen part used by the catalog detail client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Detail\Seen\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( 'image', 'basic', 'basket', 'actions', 'social', 'bundle', 'additional', 'suggest', 'bought', 'seen' );
+
+    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( 'd' );
+        $context = $this->getContext();
+
+        /** client/html/catalog/detail
+         * All parameters defined for the catalog detail component and its subparts
+         *
+         * This returns all settings related to the detail component.
+         * Please refer to the single settings for details.
+         *
+         * @param array Associative list of name/value settings
+         * @category Developer
+         * @see client/html/catalog#detail
+         */
+        $confkey = 'client/html/catalog/detail';
+
+        if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
+        {
+            $view = $this->getView();
+
+            try
+            {
+                $view = $this->setViewParams( $view, $tags, $expire );
+
+                $output = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+                }
+                $view->detailBody = $output;
+            }
+            catch( \Aimeos\Client\Html\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+                $view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\Controller\Frontend\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+                $view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\MShop\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+                $view->detailErrorList = $view->get( 'detailErrorList', 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->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+            }
+
+            /** client/html/catalog/detail/standard/template-body
+             * Relative path to the HTML body template of the catalog detail 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/detail/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/detail/standard/template-body';
+            $default = 'catalog/detail/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( 'd' );
+        $context = $this->getContext();
+        $confkey = 'client/html/catalog/detail';
+
+
+        if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
+        {
+            $view = $this->getView();
+
+            try
+            {
+                $view = $this->setViewParams( $view, $tags, $expire );
+
+                $output = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+                }
+                $view->detailHeader = $output;
+            }
+            catch( \Exception $e )
+            {
+                $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            }
+
+            /** client/html/catalog/detail/standard/template-header
+             * Relative path to the HTML header template of the catalog detail 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/detail/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/detail/standard/template-header';
+            $default = 'catalog/detail/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/detail/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog detail 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/detail/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/detail/decorators/global
+         * @see client/html/catalog/detail/decorators/local
+         */
+
+        /** client/html/catalog/detail/decorators/global
+         * Adds a list of globally available decorators only to the catalog detail 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/detail/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/detail/decorators/excludes
+         * @see client/html/catalog/detail/decorators/local
+         */
+
+        /** client/html/catalog/detail/decorators/local
+         * Adds a list of local decorators only to the catalog detail 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/detail/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/detail/decorators/excludes
+         * @see client/html/catalog/detail/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/detail/' . $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/detail/params/last' . $site, $params );
+
+            parent::process();
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->detailErrorList = $view->get( 'detailErrorList', 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->detailErrorList = $view->get( 'detailErrorList', 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();
+            $domains = array( 'media', 'price', 'text', 'attribute', 'product' );
+            $productItem = $this->getProductItem( $view->param( 'd_prodid' ), $domains );
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+
+            $attrManager = $controller->createManager( 'attribute' );
+            $attrSearch = $attrManager->createSearch( true );
+            $expr = array(
+                $attrSearch->compare( '==', 'attribute.id', array_keys( $productItem->getRefItems( 'attribute' ) ) ),
+                $attrSearch->getConditions(),
+            );
+            $attrSearch->setConditions( $attrSearch->combine( '&&', $expr ) );
+            $attributes = $attrManager->searchItems( $attrSearch, $domains );
+
+            $this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
+            $this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
+
+
+            $mediaManager = $controller->createManager( 'media' );
+            $mediaSearch = $mediaManager->createSearch( true );
+            $expr = array(
+                $mediaSearch->compare( '==', 'media.id', array_keys( $productItem->getRefItems( 'media' ) ) ),
+                $mediaSearch->getConditions(),
+            );
+            $mediaSearch->setConditions( $mediaSearch->combine( '&&', $expr ) );
+            $media = $mediaManager->searchItems( $mediaSearch, $domains );
+
+            $this->addMetaItem( $media, 'media', $this->expire, $this->tags );
+            $this->addMetaList( array_keys( $media ), 'media', $this->expire );
+
+
+            $view->detailProductItem = $productItem;
+            $view->detailProductAttributeItems = $attributes;
+            $view->detailProductMediaItems = $media;
+            $view->detailParams = $this->getClientParams( $view->param() );
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Returns the product item for the given ID including the domain items
+     *
+     * @param string $prodid Unique product ID
+     * @param array List of domain items that should be fetched too
+     * @throws \Aimeos\Client\Html\Exception If no product item was found
+     * @return \Aimeos\MShop\Product\Item\Iface Product item object
+     */
+    protected function getProductItem( $prodid, array $domains )
+    {
+        $context = $this->getContext();
+        $config = $context->getConfig();
+
+        if( $prodid == '' )
+        {
+            /** client/html/catalog/detail/prodid-default
+             * The default product ID used if none is given as parameter
+             *
+             * To display a product detail view or a part of it for a specific
+             * product, you can configure its ID using this setting. This is
+             * most useful in a CMS where the product ID can be configured
+             * separately for each content node.
+             *
+             * @param string Product ID
+             * @since 2016.01
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/lists/catid-default
+             */
+            $prodid = $config->get( 'client/html/catalog/detail/prodid-default', '' );
+        }
+
+        /** client/html/catalog/domains
+         * A list of domain names whose items should be available in the catalog view templates
+         *
+         * @see client/html/catalog/detail/domains
+         */
+        $domains = $config->get( 'client/html/catalog/domains', $domains );
+
+        /** client/html/catalog/detail/domains
+         * A list of domain names whose items should be available in the product detail view template
+         *
+         * The templates rendering product details usually add the images,
+         * prices, texts, attributes, products, etc. associated to the product
+         * item. If you want to display additional or less content, you can
+         * configure your own list of domains (attribute, media, price, product,
+         * text, etc. are domains) whose items are fetched from the storage.
+         * Please keep in mind that the more domains you add to the configuration,
+         * the more time is required for fetching the content!
+         *
+         * Since version 2014.05 this configuration option overwrites the
+         * "client/html/catalog/domains" option that allows to configure the
+         * domain names of the items fetched for all catalog related data.
+         *
+         * @param array List of domain names
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/domains
+         * @see client/html/catalog/lists/domains
+         */
+        $domains = $config->get( 'client/html/catalog/detail/domains', $domains );
+
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+        $items = $controller->getProductItems( array( $prodid ), $domains );
+
+        if( ( $item = reset( $items ) ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'No product with ID "%1$s" found', $prodid ) );
+        }
+
+        $this->addMetaItem( $item, 'product', $this->expire, $this->tags );
+        $this->addMetaList( $prodid, 'product', $this->expire );
+
+        return $item;
+    }
 }
\ No newline at end of file

Spacing +85 added lines, -85 removed lines

@@ -166,7 +166,7 @@ 
 	 * @since 2014.03
 	 * @category Developer
 	 */
-	private $subPartNames = array( 'image', 'basic', 'basket', 'actions', 'social', 'bundle', 'additional', 'suggest', 'bought', 'seen' );
+	private $subPartNames = array('image', 'basic', 'basket', 'actions', 'social', 'bundle', 'additional', 'suggest', 'bought', 'seen');
 
 	private $tags = array();
 	private $expire;
@@ -181,9 +181,9 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$prefixes = array( 'd' );
+		$prefixes = array('d');
 		$context = $this->getContext();
 
 		/** client/html/catalog/detail
@@ -198,41 +198,41 @@ 
 		 */
 		$confkey = 'client/html/catalog/detail';
 
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
+		if ($context->getUserId() != null || ($html = $this->getCached('body', $uid, $prefixes, $confkey)) === null)
 		{
 			$view = $this->getView();
 
 			try
 			{
-				$view = $this->setViewParams( $view, $tags, $expire );
+				$view = $this->setViewParams($view, $tags, $expire);
 
 				$output = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+				foreach ($this->getSubClients() as $subclient) {
+					$output .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 				}
 				$view->detailBody = $output;
 			}
-			catch( \Aimeos\Client\Html\Exception $e )
+			catch (\Aimeos\Client\Html\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', $e->getMessage()));
+				$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
+			catch (\Aimeos\Controller\Frontend\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
+				$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 			}
-			catch( \Aimeos\MShop\Exception $e )
+			catch (\Aimeos\MShop\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
+				$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 			}
-			catch( \Exception $e )
+			catch (\Exception $e)
 			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+				$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 
-				$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+				$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 			}
 
 			/** client/html/catalog/detail/standard/template-body
@@ -258,13 +258,13 @@ 
 			$tplconf = 'client/html/catalog/detail/standard/template-body';
 			$default = 'catalog/detail/body-default.php';
 
-			$html = $view->render( $view->config( $tplconf, $default ) );
+			$html = $view->render($view->config($tplconf, $default));
 
-			$this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
+			$this->setCached('body', $uid, $prefixes, $confkey, $html, $tags, $expire);
 		}
 		else
 		{
-			$html = $this->modifyBody( $html, $uid );
+			$html = $this->modifyBody($html, $uid);
 		}
 
 		return $html;
@@ -279,30 +279,30 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$prefixes = array( 'd' );
+		$prefixes = array('d');
 		$context = $this->getContext();
 		$confkey = 'client/html/catalog/detail';
 
 
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
+		if ($context->getUserId() != null || ($html = $this->getCached('header', $uid, $prefixes, $confkey)) === null)
 		{
 			$view = $this->getView();
 
 			try
 			{
-				$view = $this->setViewParams( $view, $tags, $expire );
+				$view = $this->setViewParams($view, $tags, $expire);
 
 				$output = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+				foreach ($this->getSubClients() as $subclient) {
+					$output .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 				}
 				$view->detailHeader = $output;
 			}
-			catch( \Exception $e )
+			catch (\Exception $e)
 			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+				$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 			}
 
 			/** client/html/catalog/detail/standard/template-header
@@ -329,13 +329,13 @@ 
 			$tplconf = 'client/html/catalog/detail/standard/template-header';
 			$default = 'catalog/detail/header-default.php';
 
-			$html = $view->render( $view->config( $tplconf, $default ) );
+			$html = $view->render($view->config($tplconf, $default));
 
-			$this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
+			$this->setCached('header', $uid, $prefixes, $confkey, $html, $tags, $expire);
 		}
 		else
 		{
-			$html = $this->modifyHeader( $html, $uid );
+			$html = $this->modifyHeader($html, $uid);
 		}
 
 		return $html;
@@ -349,7 +349,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/detail/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog detail html client
@@ -425,7 +425,7 @@ 
 		 * @see client/html/catalog/detail/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/detail/' . $type, $name );
+		return $this->createSubClient('catalog/detail/'.$type, $name);
 	}
 
 
@@ -442,32 +442,32 @@ 
 		try
 		{
 			$site = $context->getLocale()->getSite()->getCode();
-			$params = $this->getClientParams( $view->param() );
-			$context->getSession()->set( 'aimeos/catalog/detail/params/last' . $site, $params );
+			$params = $this->getClientParams($view->param());
+			$context->getSession()->set('aimeos/catalog/detail/params/last'.$site, $params);
 
 			parent::process();
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', $e->getMessage()));
+			$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
+			$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->detailErrorList = $view->get('detailErrorList', array()) + $error;
 		}
 	}
 
@@ -479,7 +479,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -491,52 +491,52 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$context = $this->getContext();
-			$domains = array( 'media', 'price', 'text', 'attribute', 'product' );
-			$productItem = $this->getProductItem( $view->param( 'd_prodid' ), $domains );
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+			$domains = array('media', 'price', 'text', 'attribute', 'product');
+			$productItem = $this->getProductItem($view->param('d_prodid'), $domains);
+			$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
 
 
-			$attrManager = $controller->createManager( 'attribute' );
-			$attrSearch = $attrManager->createSearch( true );
+			$attrManager = $controller->createManager('attribute');
+			$attrSearch = $attrManager->createSearch(true);
 			$expr = array(
-				$attrSearch->compare( '==', 'attribute.id', array_keys( $productItem->getRefItems( 'attribute' ) ) ),
+				$attrSearch->compare('==', 'attribute.id', array_keys($productItem->getRefItems('attribute'))),
 				$attrSearch->getConditions(),
 			);
-			$attrSearch->setConditions( $attrSearch->combine( '&&', $expr ) );
-			$attributes = $attrManager->searchItems( $attrSearch, $domains );
+			$attrSearch->setConditions($attrSearch->combine('&&', $expr));
+			$attributes = $attrManager->searchItems($attrSearch, $domains);
 
-			$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
+			$this->addMetaItem($attributes, 'attribute', $this->expire, $this->tags);
+			$this->addMetaList(array_keys($attributes), 'attribute', $this->expire);
 
 
-			$mediaManager = $controller->createManager( 'media' );
-			$mediaSearch = $mediaManager->createSearch( true );
+			$mediaManager = $controller->createManager('media');
+			$mediaSearch = $mediaManager->createSearch(true);
 			$expr = array(
-				$mediaSearch->compare( '==', 'media.id', array_keys( $productItem->getRefItems( 'media' ) ) ),
+				$mediaSearch->compare('==', 'media.id', array_keys($productItem->getRefItems('media'))),
 				$mediaSearch->getConditions(),
 			);
-			$mediaSearch->setConditions( $mediaSearch->combine( '&&', $expr ) );
-			$media = $mediaManager->searchItems( $mediaSearch, $domains );
+			$mediaSearch->setConditions($mediaSearch->combine('&&', $expr));
+			$media = $mediaManager->searchItems($mediaSearch, $domains);
 
-			$this->addMetaItem( $media, 'media', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $media ), 'media', $this->expire );
+			$this->addMetaItem($media, 'media', $this->expire, $this->tags);
+			$this->addMetaList(array_keys($media), 'media', $this->expire);
 
 
 			$view->detailProductItem = $productItem;
 			$view->detailProductAttributeItems = $attributes;
 			$view->detailProductMediaItems = $media;
-			$view->detailParams = $this->getClientParams( $view->param() );
+			$view->detailParams = $this->getClientParams($view->param());
 
 			$this->cache = $view;
 		}
 
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
+		$expire = $this->expires($this->expire, $expire);
+		$tags = array_merge($tags, $this->tags);
 
 		return $this->cache;
 	}
@@ -550,12 +550,12 @@ 
 	 * @throws \Aimeos\Client\Html\Exception If no product item was found
 	 * @return \Aimeos\MShop\Product\Item\Iface Product item object
 	 */
-	protected function getProductItem( $prodid, array $domains )
+	protected function getProductItem($prodid, array $domains)
 	{
 		$context = $this->getContext();
 		$config = $context->getConfig();
 
-		if( $prodid == '' )
+		if ($prodid == '')
 		{
 			/** client/html/catalog/detail/prodid-default
 			 * The default product ID used if none is given as parameter
@@ -571,7 +571,7 @@ 
 			 * @category Developer
 			 * @see client/html/catalog/lists/catid-default
 			 */
-			$prodid = $config->get( 'client/html/catalog/detail/prodid-default', '' );
+			$prodid = $config->get('client/html/catalog/detail/prodid-default', '');
 		}
 
 		/** client/html/catalog/domains
@@ -579,7 +579,7 @@ 
 		 *
 		 * @see client/html/catalog/detail/domains
 		 */
-		$domains = $config->get( 'client/html/catalog/domains', $domains );
+		$domains = $config->get('client/html/catalog/domains', $domains);
 
 		/** client/html/catalog/detail/domains
 		 * A list of domain names whose items should be available in the product detail view template
@@ -602,17 +602,17 @@ 
 		 * @see client/html/catalog/domains
 		 * @see client/html/catalog/lists/domains
 		 */
-		$domains = $config->get( 'client/html/catalog/detail/domains', $domains );
+		$domains = $config->get('client/html/catalog/detail/domains', $domains);
 
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-		$items = $controller->getProductItems( array( $prodid ), $domains );
+		$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
+		$items = $controller->getProductItems(array($prodid), $domains);
 
-		if( ( $item = reset( $items ) ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'No product with ID "%1$s" found', $prodid ) );
+		if (($item = reset($items)) === false) {
+			throw new \Aimeos\Client\Html\Exception(sprintf('No product with ID "%1$s" found', $prodid));
 		}
 
-		$this->addMetaItem( $item, 'product', $this->expire, $this->tags );
-		$this->addMetaList( $prodid, 'product', $this->expire );
+		$this->addMetaItem($item, 'product', $this->expire, $this->tags);
+		$this->addMetaList($prodid, 'product', $this->expire);
 
 		return $item;
 	}

Braces +11 added lines, -22 removed lines

@@ -211,23 +211,19 @@ 
 					$output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
 				}
 				$view->detailBody = $output;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
+			} catch( \Aimeos\Client\Html\Exception $e )
 			{
 				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
 				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
+			} catch( \Aimeos\Controller\Frontend\Exception $e )
 			{
 				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
 				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
+			} catch( \Aimeos\MShop\Exception $e )
 			{
 				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
 				$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-			}
-			catch( \Exception $e )
+			} catch( \Exception $e )
 			{
 				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 
@@ -261,8 +257,7 @@ 
 			$html = $view->render( $view->config( $tplconf, $default ) );
 
 			$this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		else
+		} else
 		{
 			$html = $this->modifyBody( $html, $uid );
 		}
@@ -299,8 +294,7 @@ 
 					$output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
 				}
 				$view->detailHeader = $output;
-			}
-			catch( \Exception $e )
+			} catch( \Exception $e )
 			{
 				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 			}
@@ -332,8 +326,7 @@ 
 			$html = $view->render( $view->config( $tplconf, $default ) );
 
 			$this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		else
+		} else
 		{
 			$html = $this->modifyHeader( $html, $uid );
 		}
@@ -446,23 +439,19 @@ 
 			$context->getSession()->set( 'aimeos/catalog/detail/params/last' . $site, $params );
 
 			parent::process();
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		} catch( \Aimeos\Client\Html\Exception $e )
 		{
 			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
 			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
 		{
 			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
 			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
+		} catch( \Aimeos\MShop\Exception $e )
 		{
 			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
 			$view->detailErrorList = $view->get( 'detailErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 

client/html/src/Client/Html/Catalog/Detail/Suggest/Standard.php

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

Indentation +297 added lines, -297 removed lines

@@ -19,302 +19,302 @@
  * @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/detail/suggest/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog detail suggest 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/detail/suggest/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->suggestBody = $html;
-
-		/** client/html/catalog/detail/suggest/standard/template-body
-		 * Relative path to the HTML body template of the catalog detail suggest 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/detail/suggest/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/detail/suggest/standard/template-body';
-		$default = 'catalog/detail/suggest-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->suggestHeader = $html;
-
-		/** client/html/catalog/detail/suggest/standard/template-header
-		 * Relative path to the HTML header template of the catalog detail suggest 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/detail/suggest/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/detail/suggest/standard/template-header';
-		$default = 'catalog/detail/suggest-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/detail/suggest/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog detail suggest 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/detail/suggest/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/detail/suggest/decorators/global
-		 * @see client/html/catalog/detail/suggest/decorators/local
-		 */
-
-		/** client/html/catalog/detail/suggest/decorators/global
-		 * Adds a list of globally available decorators only to the catalog detail suggest 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/detail/suggest/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/detail/suggest/decorators/excludes
-		 * @see client/html/catalog/detail/suggest/decorators/local
-		 */
-
-		/** client/html/catalog/detail/suggest/decorators/local
-		 * Adds a list of local decorators only to the catalog detail suggest 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/detail/suggest/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/detail/suggest/decorators/excludes
-		 * @see client/html/catalog/detail/suggest/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/detail/suggest/' . $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 ) )
-		{
-			if( isset( $view->detailProductItem ) )
-			{
-				$context = $this->getContext();
-				$config = $context->getConfig();
-				$domains = array( 'text', 'price', 'media' );
-				$products = $view->detailProductItem->getRefItems( 'product', null, 'suggestion' );
-
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-				/** client/html/catalog/detail/domains
-				 * A list of domain names whose items should be available in the catalog view templates
-				 *
-				 * @see client/html/catalog/detail/domains
-				 */
-				$domains = $config->get( 'client/html/catalog/detail/domains', $domains );
-
-				/** client/html/catalog/detail/suggest/domains
-				 * A list of domain names whose items should be available in the suggestion part of the catalog detail view templates
-				 *
-				 * The templates rendering suggestion related data usually add
-				 * the images and texts associated to each item. If you want to
-				 * display additional content like the attributes, you can configure
-				 * your own list of domains (attribute, media, price, product, text,
-				 * etc. are domains) whose items are fetched from the storage.
-				 * Please keep in mind that the more domains you add to the
-				 * configuration, the more time is required for fetching the content!
-				 *
-				 * This configuration option can be overwritten by the
-				 * "client/html/catalog/detail/domains" configuration option that
-				 * allows to configure the domain names of the items fetched
-				 * specifically for all types of product listings.
-				 *
-				 * @param array List of domain names
-				 * @since 2015.09
-				 * @category Developer
-				 * @see client/html/catalog/detail/domains
-				 */
-				$domains = $config->get( 'client/html/catalog/detail/suggest/domains', $domains );
-
-				$view->suggestItems = $controller->getProductItems( array_keys( $products ), $domains );
-				$view->suggestPosItems = $products;
-
-				$this->addMetaItem( $view->suggestItems, 'product', $this->expire, $this->tags );
-				$this->addMetaList( array_keys( $view->suggestItems ), 'product', $this->expire );
-			}
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
+    /** client/html/catalog/detail/suggest/standard/subparts
+     * List of HTML sub-clients rendered within the catalog detail suggest 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/detail/suggest/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->suggestBody = $html;
+
+        /** client/html/catalog/detail/suggest/standard/template-body
+         * Relative path to the HTML body template of the catalog detail suggest 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/detail/suggest/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/detail/suggest/standard/template-body';
+        $default = 'catalog/detail/suggest-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->suggestHeader = $html;
+
+        /** client/html/catalog/detail/suggest/standard/template-header
+         * Relative path to the HTML header template of the catalog detail suggest 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/detail/suggest/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/detail/suggest/standard/template-header';
+        $default = 'catalog/detail/suggest-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/detail/suggest/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog detail suggest 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/detail/suggest/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/detail/suggest/decorators/global
+         * @see client/html/catalog/detail/suggest/decorators/local
+         */
+
+        /** client/html/catalog/detail/suggest/decorators/global
+         * Adds a list of globally available decorators only to the catalog detail suggest 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/detail/suggest/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/detail/suggest/decorators/excludes
+         * @see client/html/catalog/detail/suggest/decorators/local
+         */
+
+        /** client/html/catalog/detail/suggest/decorators/local
+         * Adds a list of local decorators only to the catalog detail suggest 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/detail/suggest/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/detail/suggest/decorators/excludes
+         * @see client/html/catalog/detail/suggest/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/detail/suggest/' . $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 ) )
+        {
+            if( isset( $view->detailProductItem ) )
+            {
+                $context = $this->getContext();
+                $config = $context->getConfig();
+                $domains = array( 'text', 'price', 'media' );
+                $products = $view->detailProductItem->getRefItems( 'product', null, 'suggestion' );
+
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+                /** client/html/catalog/detail/domains
+                 * A list of domain names whose items should be available in the catalog view templates
+                 *
+                 * @see client/html/catalog/detail/domains
+                 */
+                $domains = $config->get( 'client/html/catalog/detail/domains', $domains );
+
+                /** client/html/catalog/detail/suggest/domains
+                 * A list of domain names whose items should be available in the suggestion part of the catalog detail view templates
+                 *
+                 * The templates rendering suggestion related data usually add
+                 * the images and texts associated to each item. If you want to
+                 * display additional content like the attributes, you can configure
+                 * your own list of domains (attribute, media, price, product, text,
+                 * etc. are domains) whose items are fetched from the storage.
+                 * Please keep in mind that the more domains you add to the
+                 * configuration, the more time is required for fetching the content!
+                 *
+                 * This configuration option can be overwritten by the
+                 * "client/html/catalog/detail/domains" configuration option that
+                 * allows to configure the domain names of the items fetched
+                 * specifically for all types of product listings.
+                 *
+                 * @param array List of domain names
+                 * @since 2015.09
+                 * @category Developer
+                 * @see client/html/catalog/detail/domains
+                 */
+                $domains = $config->get( 'client/html/catalog/detail/suggest/domains', $domains );
+
+                $view->suggestItems = $controller->getProductItems( array_keys( $products ), $domains );
+                $view->suggestPosItems = $products;
+
+                $this->addMetaItem( $view->suggestItems, 'product', $this->expire, $this->tags );
+                $this->addMetaList( array_keys( $view->suggestItems ), 'product', $this->expire );
+            }
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +26 added lines, -26 removed lines

@@ -70,13 +70,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->suggestBody = $html;
 
@@ -103,7 +103,7 @@ 
 		$tplconf = 'client/html/catalog/detail/suggest/standard/template-body';
 		$default = 'catalog/detail/suggest-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -115,13 +115,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->suggestHeader = $html;
 
@@ -149,7 +149,7 @@ 
 		$tplconf = 'client/html/catalog/detail/suggest/standard/template-header';
 		$default = 'catalog/detail/suggest-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -160,7 +160,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/detail/suggest/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog detail suggest html client
@@ -236,7 +236,7 @@ 
 		 * @see client/html/catalog/detail/suggest/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/detail/suggest/' . $type, $name );
+		return $this->createSubClient('catalog/detail/suggest/'.$type, $name);
 	}
 
 
@@ -247,7 +247,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -259,25 +259,25 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
-			if( isset( $view->detailProductItem ) )
+			if (isset($view->detailProductItem))
 			{
 				$context = $this->getContext();
 				$config = $context->getConfig();
-				$domains = array( 'text', 'price', 'media' );
-				$products = $view->detailProductItem->getRefItems( 'product', null, 'suggestion' );
+				$domains = array('text', 'price', 'media');
+				$products = $view->detailProductItem->getRefItems('product', null, 'suggestion');
 
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+				$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
 
 				/** client/html/catalog/detail/domains
 				 * A list of domain names whose items should be available in the catalog view templates
 				 *
 				 * @see client/html/catalog/detail/domains
 				 */
-				$domains = $config->get( 'client/html/catalog/detail/domains', $domains );
+				$domains = $config->get('client/html/catalog/detail/domains', $domains);
 
 				/** client/html/catalog/detail/suggest/domains
 				 * A list of domain names whose items should be available in the suggestion part of the catalog detail view templates
@@ -300,20 +300,20 @@ 
 				 * @category Developer
 				 * @see client/html/catalog/detail/domains
 				 */
-				$domains = $config->get( 'client/html/catalog/detail/suggest/domains', $domains );
+				$domains = $config->get('client/html/catalog/detail/suggest/domains', $domains);
 
-				$view->suggestItems = $controller->getProductItems( array_keys( $products ), $domains );
+				$view->suggestItems = $controller->getProductItems(array_keys($products), $domains);
 				$view->suggestPosItems = $products;
 
-				$this->addMetaItem( $view->suggestItems, 'product', $this->expire, $this->tags );
-				$this->addMetaList( array_keys( $view->suggestItems ), 'product', $this->expire );
+				$this->addMetaItem($view->suggestItems, 'product', $this->expire, $this->tags);
+				$this->addMetaList(array_keys($view->suggestItems), 'product', $this->expire);
 			}
 
 			$this->cache = $view;
 		}
 
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
+		$expire = $this->expires($this->expire, $expire);
+		$tags = array_merge($tags, $this->tags);
 
 		return $this->cache;
 	}

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

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

Indentation +344 added lines, -344 removed lines

@@ -19,349 +19,349 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/filter/attribute/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog filter attribute section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/filter/attribute/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->attributeBody = $html;
-
-		/** client/html/catalog/filter/attribute/standard/template-body
-		 * Relative path to the HTML body template of the catalog filter attribute client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/filter/attribute/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/filter/attribute/standard/template-body';
-		$default = 'catalog/filter/attribute-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->attributeHeader = $html;
-
-		/** client/html/catalog/filter/attribute/standard/template-header
-		 * Relative path to the HTML header template of the catalog filter attribute client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/filter/attribute/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/filter/attribute/standard/template-header';
-		$default = 'catalog/filter/attribute-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/filter/attribute/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog filter attribute html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/filter/attribute/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/attribute/decorators/global
-		 * @see client/html/catalog/filter/attribute/decorators/local
-		 */
-
-		/** client/html/catalog/filter/attribute/decorators/global
-		 * Adds a list of globally available decorators only to the catalog filter attribute html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/attribute/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/attribute/decorators/excludes
-		 * @see client/html/catalog/filter/attribute/decorators/local
-		 */
-
-		/** client/html/catalog/filter/attribute/decorators/local
-		 * Adds a list of local decorators only to the catalog filter attribute html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/attribute/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/attribute/decorators/excludes
-		 * @see client/html/catalog/filter/attribute/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/filter/attribute/' . $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 ) )
-		{
-			$attrMap = array();
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'catalog' );
-
-			/** client/html/catalog/filter/attribute/types
-			 * List of attribute types that should be displayed in this order in the catalog filter
-			 *
-			 * The attribute section in the catalog filter component can display
-			 * all attributes a visitor can use to reduce the listed products
-			 * to those that contains one or more attributes. By default, all
-			 * available attributes will be displayed and ordered by their
-			 * attribute type.
-			 *
-			 * With this setting, you can limit the attribute types to only thoses
-			 * whose names are part of the setting value. Furthermore, a particular
-			 * order for the attribute types can be enforced that is different
-			 * from the standard order.
-			 *
-			 * @param array List of attribute type codes
-			 * @since 2015.05
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/filter/attribute/domains
-			 */
-			$attrTypes = $view->config( 'client/html/catalog/filter/attribute/types', array() );
-
-			$manager = $controller->createManager( 'attribute' );
-			$search = $manager->createSearch( true );
-
-			$expr = array();
-			if( !empty( $attrTypes ) ) {
-				$expr[] = $search->compare( '==', 'attribute.type.code', $attrTypes );
-			}
-
-			$expr[] = $search->compare( '==', 'attribute.domain', 'product' );
-			$expr[] = $search->getConditions();
-
-			$sort = array( $search->sort( '+', 'attribute.position' ) );
-
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( $sort );
-			$search->setSlice( 0, 0x7fffffff );
-
-			/** client/html/catalog/filter/attribute/domains
-			 * List of domain names whose items should be fetched with the filter attributes
-			 *
-			 * The templates rendering the attributes in the catalog filter usually
-			 * add the images and texts associated to each item. If you want to
-			 * display additional content, you can configure your own list of
-			 * domains (attribute, media, price, product, text, etc. are domains)
-			 * whose items are fetched from the storage. Please keep in mind that
-			 * the more domains you add to the configuration, the more time is
-			 * required for fetching the content!
-			 *
-			 * @param array List of domain item names
-			 * @since 2015.05
-			 * @category Developer
-			 * @see client/html/catalog/filter/attribute/types
-			 */
-			$domains = $view->config( 'client/html/catalog/filter/attribute/domains', array( 'text', 'media' ) );
-
-			$attributes = $manager->searchItems( $search, $domains );
-
-			foreach( $attributes as $id => $item ) {
-				$attrMap[$item->getType()][$id] = $item;
-			}
-
-			if( !empty( $attrTypes ) )
-			{
-				$sortedMap = array();
-
-				foreach( $attrTypes as $type )
-				{
-					if( isset( $attrMap[$type] ) ) {
-						$sortedMap[$type] = $attrMap[$type];
-					}
-				}
-
-				$attrMap = $sortedMap;
-			}
-			else
-			{
-				ksort( $attrMap );
-			}
-
-			$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
-
-			// Delete cache when attributes are added or deleted even in "tag-all" mode
-			$this->tags[] = 'attribute';
-
-
-			$view->attributeMap = $attrMap;
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
+    /** client/html/catalog/filter/attribute/standard/subparts
+     * List of HTML sub-clients rendered within the catalog filter attribute section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/filter/attribute/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->attributeBody = $html;
+
+        /** client/html/catalog/filter/attribute/standard/template-body
+         * Relative path to the HTML body template of the catalog filter attribute client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/filter/attribute/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/filter/attribute/standard/template-body';
+        $default = 'catalog/filter/attribute-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->attributeHeader = $html;
+
+        /** client/html/catalog/filter/attribute/standard/template-header
+         * Relative path to the HTML header template of the catalog filter attribute client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/filter/attribute/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/filter/attribute/standard/template-header';
+        $default = 'catalog/filter/attribute-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/filter/attribute/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog filter attribute html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/filter/attribute/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/attribute/decorators/global
+         * @see client/html/catalog/filter/attribute/decorators/local
+         */
+
+        /** client/html/catalog/filter/attribute/decorators/global
+         * Adds a list of globally available decorators only to the catalog filter attribute html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/attribute/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/attribute/decorators/excludes
+         * @see client/html/catalog/filter/attribute/decorators/local
+         */
+
+        /** client/html/catalog/filter/attribute/decorators/local
+         * Adds a list of local decorators only to the catalog filter attribute html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/attribute/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/attribute/decorators/excludes
+         * @see client/html/catalog/filter/attribute/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/filter/attribute/' . $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 ) )
+        {
+            $attrMap = array();
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'catalog' );
+
+            /** client/html/catalog/filter/attribute/types
+             * List of attribute types that should be displayed in this order in the catalog filter
+             *
+             * The attribute section in the catalog filter component can display
+             * all attributes a visitor can use to reduce the listed products
+             * to those that contains one or more attributes. By default, all
+             * available attributes will be displayed and ordered by their
+             * attribute type.
+             *
+             * With this setting, you can limit the attribute types to only thoses
+             * whose names are part of the setting value. Furthermore, a particular
+             * order for the attribute types can be enforced that is different
+             * from the standard order.
+             *
+             * @param array List of attribute type codes
+             * @since 2015.05
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/filter/attribute/domains
+             */
+            $attrTypes = $view->config( 'client/html/catalog/filter/attribute/types', array() );
+
+            $manager = $controller->createManager( 'attribute' );
+            $search = $manager->createSearch( true );
+
+            $expr = array();
+            if( !empty( $attrTypes ) ) {
+                $expr[] = $search->compare( '==', 'attribute.type.code', $attrTypes );
+            }
+
+            $expr[] = $search->compare( '==', 'attribute.domain', 'product' );
+            $expr[] = $search->getConditions();
+
+            $sort = array( $search->sort( '+', 'attribute.position' ) );
+
+            $search->setConditions( $search->combine( '&&', $expr ) );
+            $search->setSortations( $sort );
+            $search->setSlice( 0, 0x7fffffff );
+
+            /** client/html/catalog/filter/attribute/domains
+             * List of domain names whose items should be fetched with the filter attributes
+             *
+             * The templates rendering the attributes in the catalog filter usually
+             * add the images and texts associated to each item. If you want to
+             * display additional content, you can configure your own list of
+             * domains (attribute, media, price, product, text, etc. are domains)
+             * whose items are fetched from the storage. Please keep in mind that
+             * the more domains you add to the configuration, the more time is
+             * required for fetching the content!
+             *
+             * @param array List of domain item names
+             * @since 2015.05
+             * @category Developer
+             * @see client/html/catalog/filter/attribute/types
+             */
+            $domains = $view->config( 'client/html/catalog/filter/attribute/domains', array( 'text', 'media' ) );
+
+            $attributes = $manager->searchItems( $search, $domains );
+
+            foreach( $attributes as $id => $item ) {
+                $attrMap[$item->getType()][$id] = $item;
+            }
+
+            if( !empty( $attrTypes ) )
+            {
+                $sortedMap = array();
+
+                foreach( $attrTypes as $type )
+                {
+                    if( isset( $attrMap[$type] ) ) {
+                        $sortedMap[$type] = $attrMap[$type];
+                    }
+                }
+
+                $attrMap = $sortedMap;
+            }
+            else
+            {
+                ksort( $attrMap );
+            }
+
+            $this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
+            $this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
+
+            // Delete cache when attributes are added or deleted even in "tag-all" mode
+            $this->tags[] = 'attribute';
+
+
+            $view->attributeMap = $attrMap;
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +37 added lines, -37 removed lines

@@ -70,13 +70,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->attributeBody = $html;
 
@@ -103,7 +103,7 @@ 
 		$tplconf = 'client/html/catalog/filter/attribute/standard/template-body';
 		$default = 'catalog/filter/attribute-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -115,13 +115,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->attributeHeader = $html;
 
@@ -149,7 +149,7 @@ 
 		$tplconf = 'client/html/catalog/filter/attribute/standard/template-header';
 		$default = 'catalog/filter/attribute-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -160,7 +160,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/filter/attribute/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog filter attribute html client
@@ -236,7 +236,7 @@ 
 		 * @see client/html/catalog/filter/attribute/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/filter/attribute/' . $type, $name );
+		return $this->createSubClient('catalog/filter/attribute/'.$type, $name);
 	}
 
 
@@ -247,7 +247,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -259,12 +259,12 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$attrMap = array();
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $this->getContext(), 'catalog' );
+			$controller = \Aimeos\Controller\Frontend\Factory::createController($this->getContext(), 'catalog');
 
 			/** client/html/catalog/filter/attribute/types
 			 * List of attribute types that should be displayed in this order in the catalog filter
@@ -286,24 +286,24 @@ 
 			 * @category Developer
 			 * @see client/html/catalog/filter/attribute/domains
 			 */
-			$attrTypes = $view->config( 'client/html/catalog/filter/attribute/types', array() );
+			$attrTypes = $view->config('client/html/catalog/filter/attribute/types', array());
 
-			$manager = $controller->createManager( 'attribute' );
-			$search = $manager->createSearch( true );
+			$manager = $controller->createManager('attribute');
+			$search = $manager->createSearch(true);
 
 			$expr = array();
-			if( !empty( $attrTypes ) ) {
-				$expr[] = $search->compare( '==', 'attribute.type.code', $attrTypes );
+			if (!empty($attrTypes)) {
+				$expr[] = $search->compare('==', 'attribute.type.code', $attrTypes);
 			}
 
-			$expr[] = $search->compare( '==', 'attribute.domain', 'product' );
+			$expr[] = $search->compare('==', 'attribute.domain', 'product');
 			$expr[] = $search->getConditions();
 
-			$sort = array( $search->sort( '+', 'attribute.position' ) );
+			$sort = array($search->sort('+', 'attribute.position'));
 
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( $sort );
-			$search->setSlice( 0, 0x7fffffff );
+			$search->setConditions($search->combine('&&', $expr));
+			$search->setSortations($sort);
+			$search->setSlice(0, 0x7fffffff);
 
 			/** client/html/catalog/filter/attribute/domains
 			 * List of domain names whose items should be fetched with the filter attributes
@@ -321,21 +321,21 @@ 
 			 * @category Developer
 			 * @see client/html/catalog/filter/attribute/types
 			 */
-			$domains = $view->config( 'client/html/catalog/filter/attribute/domains', array( 'text', 'media' ) );
+			$domains = $view->config('client/html/catalog/filter/attribute/domains', array('text', 'media'));
 
-			$attributes = $manager->searchItems( $search, $domains );
+			$attributes = $manager->searchItems($search, $domains);
 
-			foreach( $attributes as $id => $item ) {
+			foreach ($attributes as $id => $item) {
 				$attrMap[$item->getType()][$id] = $item;
 			}
 
-			if( !empty( $attrTypes ) )
+			if (!empty($attrTypes))
 			{
 				$sortedMap = array();
 
-				foreach( $attrTypes as $type )
+				foreach ($attrTypes as $type)
 				{
-					if( isset( $attrMap[$type] ) ) {
+					if (isset($attrMap[$type])) {
 						$sortedMap[$type] = $attrMap[$type];
 					}
 				}
@@ -344,11 +344,11 @@ 
 			}
 			else
 			{
-				ksort( $attrMap );
+				ksort($attrMap);
 			}
 
-			$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
+			$this->addMetaItem($attributes, 'attribute', $this->expire, $this->tags);
+			$this->addMetaList(array_keys($attributes), 'attribute', $this->expire);
 
 			// Delete cache when attributes are added or deleted even in "tag-all" mode
 			$this->tags[] = 'attribute';
@@ -359,8 +359,8 @@ 
 			$this->cache = $view;
 		}
 
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
+		$expire = $this->expires($this->expire, $expire);
+		$tags = array_merge($tags, $this->tags);
 
 		return $this->cache;
 	}

Braces +1 added lines, -2 removed lines

@@ -341,8 +341,7 @@
 				}
 
 				$attrMap = $sortedMap;
-			}
-			else
+			} else
 			{
 				ksort( $attrMap );
 			}

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

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

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

Spacing +13 added lines, -13 removed lines

@@ -67,13 +67,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->searchBody = $html;
 
@@ -100,7 +100,7 @@ 
 		$tplconf = 'client/html/catalog/filter/search/standard/template-body';
 		$default = 'catalog/filter/search-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -112,13 +112,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->searchHeader = $html;
 
@@ -146,7 +146,7 @@ 
 		$tplconf = 'client/html/catalog/filter/search/standard/template-header';
 		$default = 'catalog/filter/search-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -157,7 +157,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/filter/search/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog filter search html client
@@ -233,7 +233,7 @@ 
 		 * @see client/html/catalog/filter/search/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/filter/search/' . $type, $name );
+		return $this->createSubClient('catalog/filter/search/'.$type, $name);
 	}
 
 
@@ -244,6 +244,6 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 }
\ No newline at end of file

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

Doc Comments +1 added lines, -1 removed lines

@@ -199,7 +199,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

Indentation +514 added lines, -514 removed lines

@@ -19,519 +19,519 @@
  * @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
 {
-	private static $headerSingleton;
-
-	/** client/html/catalog/filter/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog filter section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/filter/standard/subparts';
-
-	/** client/html/catalog/filter/search/name
-	 * Name of the search part used by the catalog filter client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Search\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/filter/tree/name
-	 * Name of the tree part used by the catalog filter client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Tree\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/filter/attribute/name
-	 * Name of the attribute part used by the catalog filter client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Attribute\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( 'search', 'tree', 'attribute' );
-	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' );
-		$context = $this->getContext();
-
-		/** client/html/catalog/filter
-		 * All parameters defined for the catalog filter 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#filter
-		 */
-		$confkey = 'client/html/catalog/filter';
-
-		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->filterBody = $html;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', 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->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-
-			/** client/html/catalog/filter/standard/template-body
-			 * Relative path to the HTML body template of the catalog filter client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the result shown in the body of the frontend. The
-			 * configuration string is the path to the template file relative
-			 * to the templates directory (usually in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page body
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/filter/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/filter/standard/template-body';
-			$default = 'catalog/filter/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 )
-	{
-		if( self::$headerSingleton !== null ) {
-			return '';
-		}
-
-		self::$headerSingleton = true;
-
-		$prefixes = array( 'f' );
-		$context = $this->getContext();
-		$confkey = 'client/html/catalog/filter';
-
-		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->filterHeader = $html;
-			}
-			catch( \Exception $e )
-			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-			}
-
-			/** client/html/catalog/filter/standard/template-header
-			 * Relative path to the HTML header template of the catalog filter client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the HTML code that is inserted into the HTML page header
-			 * of the rendered page in the frontend. The configuration string is the
-			 * path to the template file relative to the templates directory (usually
-			 * in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page head
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/filter/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/filter/standard/template-header';
-			$default = 'catalog/filter/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/filter/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog filter html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/filter/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/filter/decorators/global
-		 * @see client/html/catalog/filter/decorators/local
-		 */
-
-		/** client/html/catalog/filter/decorators/global
-		 * Adds a list of globally available decorators only to the catalog filter html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/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/filter/decorators/excludes
-		 * @see client/html/catalog/filter/decorators/local
-		 */
-
-		/** client/html/catalog/filter/decorators/local
-		 * Adds a list of local decorators only to the catalog filter html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/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/filter/decorators/excludes
-		 * @see client/html/catalog/filter/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/filter/' . $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 )
-	{
-		$content = parent::modifyBody( $content, $uid );
-
-		return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.filter.csrf' );
-	}
-
-
-	/**
-	 * 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
-		{
-			parent::process();
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', 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->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-	}
-
-
-	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 ) )
-		{
-			$config = $this->getContext()->getConfig();
-
-			/** client/html/catalog/count/enable
-			 * Enables or disables displaying product counts in the catalog filter
-			 *
-			 * This configuration option allows shop owners to display product
-			 * counts in the catalog filter or to disable fetching product count
-			 * information.
-			 *
-			 * The product count information is fetched via AJAX and inserted via
-			 * Javascript. This allows to cache parts of the catalog filter by
-			 * leaving out such highly dynamic content like product count which
-			 * changes with used filter parameter.
-			 *
-			 * @param boolean Value of "1" to display product counts, "0" to disable them
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/count/url/target
-			 * @see client/html/catalog/count/url/controller
-			 * @see client/html/catalog/count/url/action
-			 * @see client/html/catalog/count/url/config
-			 */
-			if( $config->get( 'client/html/catalog/count/enable', true ) == true )
-			{
-				/** client/html/catalog/count/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/count/url/controller
-				 * @see client/html/catalog/count/url/action
-				 * @see client/html/catalog/count/url/config
-				 */
-				$target = $config->get( 'client/html/catalog/count/url/target' );
-
-				/** client/html/catalog/count/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/count/url/target
-				 * @see client/html/catalog/count/url/action
-				 * @see client/html/catalog/count/url/config
-				 */
-				$controller = $config->get( 'client/html/catalog/count/url/controller', 'catalog' );
-
-				/** client/html/catalog/count/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/count/url/target
-				 * @see client/html/catalog/count/url/controller
-				 * @see client/html/catalog/count/url/config
-				 */
-				$action = $config->get( 'client/html/catalog/count/url/action', 'count' );
-
-				/** client/html/catalog/count/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/count/url/target
-				 * @see client/html/catalog/count/url/controller
-				 * @see client/html/catalog/count/url/action
-				 * @see client/html/url/config
-				 */
-				$config = $config->get( 'client/html/catalog/count/url/config', array() );
-
-				$params = $this->getClientParams( $view->param(), array( 'f' ) );
-
-				$view->filterCountUrl = $view->url( $target, $controller, $action, $params, array(), $config );
-			}
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    private static $headerSingleton;
+
+    /** client/html/catalog/filter/standard/subparts
+     * List of HTML sub-clients rendered within the catalog filter section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/filter/standard/subparts';
+
+    /** client/html/catalog/filter/search/name
+     * Name of the search part used by the catalog filter client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Search\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/filter/tree/name
+     * Name of the tree part used by the catalog filter client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Tree\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/filter/attribute/name
+     * Name of the attribute part used by the catalog filter client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Attribute\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( 'search', 'tree', 'attribute' );
+    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' );
+        $context = $this->getContext();
+
+        /** client/html/catalog/filter
+         * All parameters defined for the catalog filter 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#filter
+         */
+        $confkey = 'client/html/catalog/filter';
+
+        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->filterBody = $html;
+            }
+            catch( \Aimeos\Client\Html\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+                $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\Controller\Frontend\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+                $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\MShop\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+                $view->filterErrorList = $view->get( 'filterErrorList', 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->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+            }
+
+            /** client/html/catalog/filter/standard/template-body
+             * Relative path to the HTML body template of the catalog filter client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the result shown in the body of the frontend. The
+             * configuration string is the path to the template file relative
+             * to the templates directory (usually in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page body
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/filter/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/filter/standard/template-body';
+            $default = 'catalog/filter/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 )
+    {
+        if( self::$headerSingleton !== null ) {
+            return '';
+        }
+
+        self::$headerSingleton = true;
+
+        $prefixes = array( 'f' );
+        $context = $this->getContext();
+        $confkey = 'client/html/catalog/filter';
+
+        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->filterHeader = $html;
+            }
+            catch( \Exception $e )
+            {
+                $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            }
+
+            /** client/html/catalog/filter/standard/template-header
+             * Relative path to the HTML header template of the catalog filter client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the HTML code that is inserted into the HTML page header
+             * of the rendered page in the frontend. The configuration string is the
+             * path to the template file relative to the templates directory (usually
+             * in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page head
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/filter/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/filter/standard/template-header';
+            $default = 'catalog/filter/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/filter/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog filter html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/filter/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/filter/decorators/global
+         * @see client/html/catalog/filter/decorators/local
+         */
+
+        /** client/html/catalog/filter/decorators/global
+         * Adds a list of globally available decorators only to the catalog filter html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/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/filter/decorators/excludes
+         * @see client/html/catalog/filter/decorators/local
+         */
+
+        /** client/html/catalog/filter/decorators/local
+         * Adds a list of local decorators only to the catalog filter html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/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/filter/decorators/excludes
+         * @see client/html/catalog/filter/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/filter/' . $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 )
+    {
+        $content = parent::modifyBody( $content, $uid );
+
+        return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.filter.csrf' );
+    }
+
+
+    /**
+     * 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
+        {
+            parent::process();
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->filterErrorList = $view->get( 'filterErrorList', 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->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+        }
+    }
+
+
+    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 ) )
+        {
+            $config = $this->getContext()->getConfig();
+
+            /** client/html/catalog/count/enable
+             * Enables or disables displaying product counts in the catalog filter
+             *
+             * This configuration option allows shop owners to display product
+             * counts in the catalog filter or to disable fetching product count
+             * information.
+             *
+             * The product count information is fetched via AJAX and inserted via
+             * Javascript. This allows to cache parts of the catalog filter by
+             * leaving out such highly dynamic content like product count which
+             * changes with used filter parameter.
+             *
+             * @param boolean Value of "1" to display product counts, "0" to disable them
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/count/url/target
+             * @see client/html/catalog/count/url/controller
+             * @see client/html/catalog/count/url/action
+             * @see client/html/catalog/count/url/config
+             */
+            if( $config->get( 'client/html/catalog/count/enable', true ) == true )
+            {
+                /** client/html/catalog/count/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/count/url/controller
+                 * @see client/html/catalog/count/url/action
+                 * @see client/html/catalog/count/url/config
+                 */
+                $target = $config->get( 'client/html/catalog/count/url/target' );
+
+                /** client/html/catalog/count/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/count/url/target
+                 * @see client/html/catalog/count/url/action
+                 * @see client/html/catalog/count/url/config
+                 */
+                $controller = $config->get( 'client/html/catalog/count/url/controller', 'catalog' );
+
+                /** client/html/catalog/count/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/count/url/target
+                 * @see client/html/catalog/count/url/controller
+                 * @see client/html/catalog/count/url/config
+                 */
+                $action = $config->get( 'client/html/catalog/count/url/action', 'count' );
+
+                /** client/html/catalog/count/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/count/url/target
+                 * @see client/html/catalog/count/url/controller
+                 * @see client/html/catalog/count/url/action
+                 * @see client/html/url/config
+                 */
+                $config = $config->get( 'client/html/catalog/count/url/config', array() );
+
+                $params = $this->getClientParams( $view->param(), array( 'f' ) );
+
+                $view->filterCountUrl = $view->url( $target, $controller, $action, $params, array(), $config );
+            }
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }

Spacing +63 added lines, -63 removed lines

@@ -91,7 +91,7 @@ 
 	 * @since 2014.03
 	 * @category Developer
 	 */
-	private $subPartNames = array( 'search', 'tree', 'attribute' );
+	private $subPartNames = array('search', 'tree', 'attribute');
 	private $cache;
 
 
@@ -103,9 +103,9 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$prefixes = array( 'f' );
+		$prefixes = array('f');
 		$context = $this->getContext();
 
 		/** client/html/catalog/filter
@@ -120,41 +120,41 @@ 
 		 */
 		$confkey = 'client/html/catalog/filter';
 
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
+		if ($context->getUserId() != null || ($html = $this->getCached('body', $uid, $prefixes, $confkey)) === null)
 		{
 			$view = $this->getView();
 
 			try
 			{
-				$view = $this->setViewParams( $view, $tags, $expire );
+				$view = $this->setViewParams($view, $tags, $expire);
 
 				$html = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+				foreach ($this->getSubClients() as $subclient) {
+					$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 				}
 				$view->filterBody = $html;
 			}
-			catch( \Aimeos\Client\Html\Exception $e )
+			catch (\Aimeos\Client\Html\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', $e->getMessage()));
+				$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
+			catch (\Aimeos\Controller\Frontend\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
+				$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 			}
-			catch( \Aimeos\MShop\Exception $e )
+			catch (\Aimeos\MShop\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
+				$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 			}
-			catch( \Exception $e )
+			catch (\Exception $e)
 			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+				$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 
-				$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+				$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 			}
 
 			/** client/html/catalog/filter/standard/template-body
@@ -180,13 +180,13 @@ 
 			$tplconf = 'client/html/catalog/filter/standard/template-body';
 			$default = 'catalog/filter/body-default.php';
 
-			$html = $view->render( $view->config( $tplconf, $default ) );
+			$html = $view->render($view->config($tplconf, $default));
 
-			$this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
+			$this->setCached('body', $uid, $prefixes, $confkey, $html, $tags, $expire);
 		}
 		else
 		{
-			$html = $this->modifyBody( $html, $uid );
+			$html = $this->modifyBody($html, $uid);
 		}
 
 		return $html;
@@ -201,35 +201,35 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		if( self::$headerSingleton !== null ) {
+		if (self::$headerSingleton !== null) {
 			return '';
 		}
 
 		self::$headerSingleton = true;
 
-		$prefixes = array( 'f' );
+		$prefixes = array('f');
 		$context = $this->getContext();
 		$confkey = 'client/html/catalog/filter';
 
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
+		if ($context->getUserId() != null || ($html = $this->getCached('header', $uid, $prefixes, $confkey)) === null)
 		{
 			$view = $this->getView();
 
 			try
 			{
-				$view = $this->setViewParams( $view, $tags, $expire );
+				$view = $this->setViewParams($view, $tags, $expire);
 
 				$html = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+				foreach ($this->getSubClients() as $subclient) {
+					$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 				}
 				$view->filterHeader = $html;
 			}
-			catch( \Exception $e )
+			catch (\Exception $e)
 			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+				$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 			}
 
 			/** client/html/catalog/filter/standard/template-header
@@ -256,13 +256,13 @@ 
 			$tplconf = 'client/html/catalog/filter/standard/template-header';
 			$default = 'catalog/filter/header-default.php';
 
-			$html = $view->render( $view->config( $tplconf, $default ) );
+			$html = $view->render($view->config($tplconf, $default));
 
-			$this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
+			$this->setCached('header', $uid, $prefixes, $confkey, $html, $tags, $expire);
 		}
 		else
 		{
-			$html = $this->modifyHeader( $html, $uid );
+			$html = $this->modifyHeader($html, $uid);
 		}
 
 		return $html;
@@ -276,7 +276,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/filter/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog filter html client
@@ -352,7 +352,7 @@ 
 		 * @see client/html/catalog/filter/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/filter/' . $type, $name );
+		return $this->createSubClient('catalog/filter/'.$type, $name);
 	}
 
 
@@ -363,11 +363,11 @@ 
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @return string Modified body content
 	 */
-	public function modifyBody( $content, $uid )
+	public function modifyBody($content, $uid)
 	{
-		$content = parent::modifyBody( $content, $uid );
+		$content = parent::modifyBody($content, $uid);
 
-		return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.filter.csrf' );
+		return $this->replaceSection($content, $this->getView()->csrf()->formfield(), 'catalog.filter.csrf');
 	}
 
 
@@ -385,34 +385,34 @@ 
 		{
 			parent::process();
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
+			$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', $e->getMessage()));
+			$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+			$context->getLogger()->log($e->getMessage().PHP_EOL.$e->getTraceAsString());
 
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->filterErrorList = $view->get('filterErrorList', array()) + $error;
 		}
 	}
 
 
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -424,9 +424,9 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$config = $this->getContext()->getConfig();
 
@@ -451,7 +451,7 @@ 
 			 * @see client/html/catalog/count/url/action
 			 * @see client/html/catalog/count/url/config
 			 */
-			if( $config->get( 'client/html/catalog/count/enable', true ) == true )
+			if ($config->get('client/html/catalog/count/enable', true) == true)
 			{
 				/** client/html/catalog/count/url/target
 				 * Destination of the URL where the controller specified in the URL is known
@@ -467,7 +467,7 @@ 
 				 * @see client/html/catalog/count/url/action
 				 * @see client/html/catalog/count/url/config
 				 */
-				$target = $config->get( 'client/html/catalog/count/url/target' );
+				$target = $config->get('client/html/catalog/count/url/target');
 
 				/** client/html/catalog/count/url/controller
 				 * Name of the controller whose action should be called
@@ -483,7 +483,7 @@ 
 				 * @see client/html/catalog/count/url/action
 				 * @see client/html/catalog/count/url/config
 				 */
-				$controller = $config->get( 'client/html/catalog/count/url/controller', 'catalog' );
+				$controller = $config->get('client/html/catalog/count/url/controller', 'catalog');
 
 				/** client/html/catalog/count/url/action
 				 * Name of the action that should create the output
@@ -499,7 +499,7 @@ 
 				 * @see client/html/catalog/count/url/controller
 				 * @see client/html/catalog/count/url/config
 				 */
-				$action = $config->get( 'client/html/catalog/count/url/action', 'count' );
+				$action = $config->get('client/html/catalog/count/url/action', 'count');
 
 				/** client/html/catalog/count/url/config
 				 * Associative list of configuration options used for generating the URL
@@ -522,11 +522,11 @@ 
 				 * @see client/html/catalog/count/url/action
 				 * @see client/html/url/config
 				 */
-				$config = $config->get( 'client/html/catalog/count/url/config', array() );
+				$config = $config->get('client/html/catalog/count/url/config', array());
 
-				$params = $this->getClientParams( $view->param(), array( 'f' ) );
+				$params = $this->getClientParams($view->param(), array('f'));
 
-				$view->filterCountUrl = $view->url( $target, $controller, $action, $params, array(), $config );
+				$view->filterCountUrl = $view->url($target, $controller, $action, $params, array(), $config);
 			}
 
 			$this->cache = $view;

Braces +11 added lines, -22 removed lines

@@ -133,23 +133,19 @@ 
 					$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
 				}
 				$view->filterBody = $html;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
+			} catch( \Aimeos\Client\Html\Exception $e )
 			{
 				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
 				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
+			} catch( \Aimeos\Controller\Frontend\Exception $e )
 			{
 				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
 				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
+			} catch( \Aimeos\MShop\Exception $e )
 			{
 				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
 				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Exception $e )
+			} catch( \Exception $e )
 			{
 				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 
@@ -183,8 +179,7 @@ 
 			$html = $view->render( $view->config( $tplconf, $default ) );
 
 			$this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		else
+		} else
 		{
 			$html = $this->modifyBody( $html, $uid );
 		}
@@ -226,8 +221,7 @@ 
 					$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
 				}
 				$view->filterHeader = $html;
-			}
-			catch( \Exception $e )
+			} catch( \Exception $e )
 			{
 				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 			}
@@ -259,8 +253,7 @@ 
 			$html = $view->render( $view->config( $tplconf, $default ) );
 
 			$this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		else
+		} else
 		{
 			$html = $this->modifyHeader( $html, $uid );
 		}
@@ -384,23 +377,19 @@ 
 		try
 		{
 			parent::process();
-		}
-		catch( \Aimeos\MShop\Exception $e )
+		} catch( \Aimeos\MShop\Exception $e )
 		{
 			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
 			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		} catch( \Aimeos\Controller\Frontend\Exception $e )
 		{
 			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
 			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		} catch( \Aimeos\Client\Html\Exception $e )
 		{
 			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
 			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
+		} catch( \Exception $e )
 		{
 			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 

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

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

Indentation +443 added lines, -443 removed lines

@@ -19,448 +19,448 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/filter/tree/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog filter tree section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/filter/tree/standard/subparts';
-	private $subPartNames = array();
-	private $tags = array();
-	private $expire;
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->treeBody = $html;
-
-		/** client/html/catalog/filter/tree/standard/template-body
-		 * Relative path to the HTML body template of the catalog filter tree client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/filter/tree/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/filter/tree/standard/template-body';
-		$default = 'catalog/filter/tree-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->treeHeader = $html;
-
-		/** client/html/catalog/filter/tree/standard/template-header
-		 * Relative path to the HTML header template of the catalog filter tree client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/filter/tree/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/filter/tree/standard/template-header';
-		$default = 'catalog/filter/tree-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/filter/tree/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog filter tree html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/filter/tree/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/tree/decorators/global
-		 * @see client/html/catalog/filter/tree/decorators/local
-		 */
-
-		/** client/html/catalog/filter/tree/decorators/global
-		 * Adds a list of globally available decorators only to the catalog filter tree html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/tree/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/tree/decorators/excludes
-		 * @see client/html/catalog/filter/tree/decorators/local
-		 */
-
-		/** client/html/catalog/filter/tree/decorators/local
-		 * Adds a list of local decorators only to the catalog filter tree html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/tree/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/tree/decorators/excludes
-		 * @see client/html/catalog/filter/tree/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/filter/tree/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$catItems = array();
-			$context = $this->getContext();
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-			$currentid = (string) $view->param( 'f_catid', '' );
-			$currentid = ( $currentid != '' ? $currentid : null );
-
-			/** client/html/catalog/filter/tree/startid
-			 * The ID of the category node that should be the root of the displayed category tree
-			 *
-			 * If you want to display only a part of your category tree, you can
-			 * configure the ID of the category node from which rendering the
-			 * remaining sub-tree should start.
-			 *
-			 * In most cases you can set this value via the administration interface
-			 * of the shop application. In that case you often can configure the
-			 * start ID individually for each catalog filter.
-			 *
-			 * @param string Category ID
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/filter/tree/levels-always
-			 * @see client/html/catalog/filter/tree/levels-only
-			 * @see client/html/catalog/filter/tree/domains
-			 */
-			$startid = $view->config( 'client/html/catalog/filter/tree/startid', '' );
-			$startid = ( $startid != '' ? $startid : null );
-
-			/** client/html/catalog/filter/tree/domains
-			 * List of domain names whose items should be fetched with the filter categories
-			 *
-			 * The templates rendering the categories in the catalog filter usually
-			 * add the images and texts associated to each item. If you want to
-			 * display additional content, you can configure your own list of
-			 * domains (attribute, media, price, product, text, etc. are domains)
-			 * whose items are fetched from the storage. Please keep in mind that
-			 * the more domains you add to the configuration, the more time is
-			 * required for fetching the content!
-			 *
-			 * @param array List of domain item names
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/filter/tree/startid
-			 * @see client/html/catalog/filter/tree/levels-always
-			 * @see client/html/catalog/filter/tree/levels-only
-			 */
-			$ref = $view->config( 'client/html/catalog/filter/tree/domains', array( 'text', 'media' ) );
-
-
-			if( $currentid )
-			{
-				$catItems = $controller->getCatalogPath( $currentid );
-
-				if( $startid )
-				{
-					foreach( $catItems as $key => $item )
-					{
-						if( $key == $startid ) {
-							break;
-						}
-						unset( $catItems[$key] );
-					}
-				}
-			}
-
-			if( ( $node = reset( $catItems ) ) === false )
-			{
-				$node = $controller->getCatalogTree( $startid, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
-				$catItems = array( $node->getId() => $node );
-			}
-
-
-			$search = $controller->createCatalogFilter();
-			$expr = $search->compare( '==', 'catalog.parentid', array_keys( $catItems ) );
-			$expr = $search->combine( '||', array( $expr, $search->compare( '==', 'catalog.id', $node->getId() ) ) );
-
-			/** client/html/catalog/filter/tree/levels-always
-			 * The number of levels in the category tree that should be always displayed
-			 *
-			 * Usually, only the root node and the first level of the category
-			 * tree is shown in the frontend. Only if the user clicks on a
-			 * node in the first level, the page reloads and the sub-nodes of
-			 * the chosen category are rendered as well.
-			 *
-			 * Using this configuration option you can enforce the given number
-			 * of levels to be always displayed. The root node uses level 0, the
-			 * categories below level 1 and so on.
-			 *
-			 * In most cases you can set this value via the administration interface
-			 * of the shop application. In that case you often can configure the
-			 * levels individually for each catalog filter.
-			 *
-			 * @param integer Number of tree levels
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/filter/tree/startid
-			 * @see client/html/catalog/filter/tree/levels-only
-			 * @see client/html/catalog/filter/tree/domains
-			 */
-			if( ( $levels = $view->config( 'client/html/catalog/filter/tree/levels-always' ) ) != null ) {
-				$expr = $search->combine( '||', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
-			}
-
-			/** client/html/catalog/filter/tree/levels-only
-			 * No more than this number of levels in the category tree should be displayed
-			 *
-			 * If the user clicks on a category node, the page reloads and the
-			 * sub-nodes of the chosen category are rendered as well.
-			 * Using this configuration option you can enforce that no more than
-			 * the given number of levels will be displayed at all. The root
-			 * node uses level 0, the categories below level 1 and so on.
-			 *
-			 * In most cases you can set this value via the administration interface
-			 * of the shop application. In that case you often can configure the
-			 * levels individually for each catalog filter.
-			 *
-			 * @param integer Number of tree levels
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/filter/tree/startid
-			 * @see client/html/catalog/filter/tree/levels-always
-			 * @see client/html/catalog/filter/tree/domains
-			 */
-			if( ( $levels = $view->config( 'client/html/catalog/filter/tree/levels-only' ) ) != null ) {
-				$expr = $search->combine( '&&', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
-			}
-
-			$search->setConditions( $expr );
-
-			$level = \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE;
-
-			$view->treeCatalogPath = $catItems;
-			$view->treeCatalogTree = $controller->getCatalogTree( $startid, $ref, $level, $search );
-			$view->treeCatalogIds = $this->getCatalogIds( $view->treeCatalogTree, $catItems, $currentid );
-			$view->treeFilterParams = $this->getClientParams( $view->param(), array( 'f' ) );
-
-			$this->addMetaItemCatalog( $view->treeCatalogTree, $this->expire, $this->tags );
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Returns the category IDs of the given catalog tree.
-	 *
-	 * Only the IDs of the children of the current category are returned.
-	 *
-	 * @param \Aimeos\MShop\Catalog\Item\Iface $tree Catalog node as entry point of the tree
-	 * @param array $path Associative list of category IDs as keys and the catalog
-	 * 	nodes from the currently selected category up to the root node
-	 * @param string $currentId Currently selected category
-	 * @return array List of category IDs
-	 */
-	protected function getCatalogIds( \Aimeos\MShop\Catalog\Item\Iface $tree, array $path, $currentId )
-	{
-		if( $tree->getId() == $currentId )
-		{
-			$ids = array();
-			foreach( $tree->getChildren() as $item ) {
-				$ids[] = $item->getId();
-			}
-
-			return $ids;
-		}
-
-		foreach( $tree->getChildren() as $child )
-		{
-			if( isset( $path[$child->getId()] ) ) {
-				return $this->getCatalogIds( $child, $path, $currentId );
-			}
-		}
-
-		return array();
-	}
-
-
-	/**
-	 * Adds the cache tags to the given list and sets a new expiration date if necessary based on the given catalog tree.
-	 *
-	 * @param \Aimeos\MShop\Catalog\Item\Iface $tree Tree node, maybe with sub-nodes
-	 * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
-	 * @param array &$tags List of tags the new tags will be added to
-	 */
-	protected function addMetaItemCatalog( \Aimeos\MShop\Catalog\Item\Iface $tree, &$expire, array &$tags = array() )
-	{
-		$this->addMetaItem( $tree, 'catalog', $expire, $tags );
-
-		foreach( $tree->getChildren() as $child ) {
-			$this->addMetaItemCatalog( $child, $expire, $tags );
-		}
-	}
+    /** client/html/catalog/filter/tree/standard/subparts
+     * List of HTML sub-clients rendered within the catalog filter tree section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/filter/tree/standard/subparts';
+    private $subPartNames = array();
+    private $tags = array();
+    private $expire;
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->treeBody = $html;
+
+        /** client/html/catalog/filter/tree/standard/template-body
+         * Relative path to the HTML body template of the catalog filter tree client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/filter/tree/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/filter/tree/standard/template-body';
+        $default = 'catalog/filter/tree-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->treeHeader = $html;
+
+        /** client/html/catalog/filter/tree/standard/template-header
+         * Relative path to the HTML header template of the catalog filter tree client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/filter/tree/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/filter/tree/standard/template-header';
+        $default = 'catalog/filter/tree-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/filter/tree/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog filter tree html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/filter/tree/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/tree/decorators/global
+         * @see client/html/catalog/filter/tree/decorators/local
+         */
+
+        /** client/html/catalog/filter/tree/decorators/global
+         * Adds a list of globally available decorators only to the catalog filter tree html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/tree/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/tree/decorators/excludes
+         * @see client/html/catalog/filter/tree/decorators/local
+         */
+
+        /** client/html/catalog/filter/tree/decorators/local
+         * Adds a list of local decorators only to the catalog filter tree html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/tree/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/tree/decorators/excludes
+         * @see client/html/catalog/filter/tree/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/filter/tree/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $catItems = array();
+            $context = $this->getContext();
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+            $currentid = (string) $view->param( 'f_catid', '' );
+            $currentid = ( $currentid != '' ? $currentid : null );
+
+            /** client/html/catalog/filter/tree/startid
+             * The ID of the category node that should be the root of the displayed category tree
+             *
+             * If you want to display only a part of your category tree, you can
+             * configure the ID of the category node from which rendering the
+             * remaining sub-tree should start.
+             *
+             * In most cases you can set this value via the administration interface
+             * of the shop application. In that case you often can configure the
+             * start ID individually for each catalog filter.
+             *
+             * @param string Category ID
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/filter/tree/levels-always
+             * @see client/html/catalog/filter/tree/levels-only
+             * @see client/html/catalog/filter/tree/domains
+             */
+            $startid = $view->config( 'client/html/catalog/filter/tree/startid', '' );
+            $startid = ( $startid != '' ? $startid : null );
+
+            /** client/html/catalog/filter/tree/domains
+             * List of domain names whose items should be fetched with the filter categories
+             *
+             * The templates rendering the categories in the catalog filter usually
+             * add the images and texts associated to each item. If you want to
+             * display additional content, you can configure your own list of
+             * domains (attribute, media, price, product, text, etc. are domains)
+             * whose items are fetched from the storage. Please keep in mind that
+             * the more domains you add to the configuration, the more time is
+             * required for fetching the content!
+             *
+             * @param array List of domain item names
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/filter/tree/startid
+             * @see client/html/catalog/filter/tree/levels-always
+             * @see client/html/catalog/filter/tree/levels-only
+             */
+            $ref = $view->config( 'client/html/catalog/filter/tree/domains', array( 'text', 'media' ) );
+
+
+            if( $currentid )
+            {
+                $catItems = $controller->getCatalogPath( $currentid );
+
+                if( $startid )
+                {
+                    foreach( $catItems as $key => $item )
+                    {
+                        if( $key == $startid ) {
+                            break;
+                        }
+                        unset( $catItems[$key] );
+                    }
+                }
+            }
+
+            if( ( $node = reset( $catItems ) ) === false )
+            {
+                $node = $controller->getCatalogTree( $startid, array(), \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE );
+                $catItems = array( $node->getId() => $node );
+            }
+
+
+            $search = $controller->createCatalogFilter();
+            $expr = $search->compare( '==', 'catalog.parentid', array_keys( $catItems ) );
+            $expr = $search->combine( '||', array( $expr, $search->compare( '==', 'catalog.id', $node->getId() ) ) );
+
+            /** client/html/catalog/filter/tree/levels-always
+             * The number of levels in the category tree that should be always displayed
+             *
+             * Usually, only the root node and the first level of the category
+             * tree is shown in the frontend. Only if the user clicks on a
+             * node in the first level, the page reloads and the sub-nodes of
+             * the chosen category are rendered as well.
+             *
+             * Using this configuration option you can enforce the given number
+             * of levels to be always displayed. The root node uses level 0, the
+             * categories below level 1 and so on.
+             *
+             * In most cases you can set this value via the administration interface
+             * of the shop application. In that case you often can configure the
+             * levels individually for each catalog filter.
+             *
+             * @param integer Number of tree levels
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/filter/tree/startid
+             * @see client/html/catalog/filter/tree/levels-only
+             * @see client/html/catalog/filter/tree/domains
+             */
+            if( ( $levels = $view->config( 'client/html/catalog/filter/tree/levels-always' ) ) != null ) {
+                $expr = $search->combine( '||', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
+            }
+
+            /** client/html/catalog/filter/tree/levels-only
+             * No more than this number of levels in the category tree should be displayed
+             *
+             * If the user clicks on a category node, the page reloads and the
+             * sub-nodes of the chosen category are rendered as well.
+             * Using this configuration option you can enforce that no more than
+             * the given number of levels will be displayed at all. The root
+             * node uses level 0, the categories below level 1 and so on.
+             *
+             * In most cases you can set this value via the administration interface
+             * of the shop application. In that case you often can configure the
+             * levels individually for each catalog filter.
+             *
+             * @param integer Number of tree levels
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/filter/tree/startid
+             * @see client/html/catalog/filter/tree/levels-always
+             * @see client/html/catalog/filter/tree/domains
+             */
+            if( ( $levels = $view->config( 'client/html/catalog/filter/tree/levels-only' ) ) != null ) {
+                $expr = $search->combine( '&&', array( $expr, $search->compare( '<=', 'catalog.level', $levels ) ) );
+            }
+
+            $search->setConditions( $expr );
+
+            $level = \Aimeos\MW\Tree\Manager\Base::LEVEL_TREE;
+
+            $view->treeCatalogPath = $catItems;
+            $view->treeCatalogTree = $controller->getCatalogTree( $startid, $ref, $level, $search );
+            $view->treeCatalogIds = $this->getCatalogIds( $view->treeCatalogTree, $catItems, $currentid );
+            $view->treeFilterParams = $this->getClientParams( $view->param(), array( 'f' ) );
+
+            $this->addMetaItemCatalog( $view->treeCatalogTree, $this->expire, $this->tags );
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Returns the category IDs of the given catalog tree.
+     *
+     * Only the IDs of the children of the current category are returned.
+     *
+     * @param \Aimeos\MShop\Catalog\Item\Iface $tree Catalog node as entry point of the tree
+     * @param array $path Associative list of category IDs as keys and the catalog
+     * 	nodes from the currently selected category up to the root node
+     * @param string $currentId Currently selected category
+     * @return array List of category IDs
+     */
+    protected function getCatalogIds( \Aimeos\MShop\Catalog\Item\Iface $tree, array $path, $currentId )
+    {
+        if( $tree->getId() == $currentId )
+        {
+            $ids = array();
+            foreach( $tree->getChildren() as $item ) {
+                $ids[] = $item->getId();
+            }
+
+            return $ids;
+        }
+
+        foreach( $tree->getChildren() as $child )
+        {
+            if( isset( $path[$child->getId()] ) ) {
+                return $this->getCatalogIds( $child, $path, $currentId );
+            }
+        }
+
+        return array();
+    }
+
+
+    /**
+     * Adds the cache tags to the given list and sets a new expiration date if necessary based on the given catalog tree.
+     *
+     * @param \Aimeos\MShop\Catalog\Item\Iface $tree Tree node, maybe with sub-nodes
+     * @param string|null &$expire Expiration date that will be overwritten if an earlier date is found
+     * @param array &$tags List of tags the new tags will be added to
+     */
+    protected function addMetaItemCatalog( \Aimeos\MShop\Catalog\Item\Iface $tree, &$expire, array &$tags = array() )
+    {
+        $this->addMetaItem( $tree, 'catalog', $expire, $tags );
+
+        foreach( $tree->getChildren() as $child ) {
+            $this->addMetaItemCatalog( $child, $expire, $tags );
+        }
+    }
 }

Spacing +53 added lines, -53 removed lines

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

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

Doc Comments +1 added lines, -1 removed lines

@@ -110,7 +110,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

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

Spacing +13 added lines, -13 removed lines

@@ -67,13 +67,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->headBody = $html;
 
@@ -100,7 +100,7 @@ 
 		$tplconf = 'client/html/catalog/lists/head/standard/template-body';
 		$default = 'catalog/lists/head-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -112,13 +112,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->headHeader = $html;
 
@@ -146,7 +146,7 @@ 
 		$tplconf = 'client/html/catalog/lists/head/standard/template-header';
 		$default = 'catalog/lists/head-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -157,7 +157,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/lists/head/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog list head html client
@@ -233,7 +233,7 @@ 
 		 * @see client/html/catalog/lists/head/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/lists/head/' . $type, $name );
+		return $this->createSubClient('catalog/lists/head/'.$type, $name);
 	}
 
 
@@ -244,6 +244,6 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 }
\ No newline at end of file

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

Doc Comments +1 added lines, -1 removed lines

@@ -113,7 +113,7 @@
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{

Indentation +457 added lines, -457 removed lines

@@ -19,462 +19,462 @@
  * @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/items/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog list items 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/items/standard/subparts';
-	private $subPartNames = array();
-	private $tags = array();
-	private $expire;
-	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->itemsBody = $html;
-
-		/** client/html/catalog/lists/items/standard/template-body
-		 * Relative path to the HTML body template of the catalog list items 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/items/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/lists/items/standard/template-body';
-		$default = 'catalog/lists/items-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->itemsHeader = $html;
-
-		/** client/html/catalog/lists/items/standard/template-header
-		 * Relative path to the HTML header template of the catalog list items 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/items/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/lists/items/standard/template-header';
-		$default = 'catalog/lists/items-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/items/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog list items 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/items/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/items/decorators/global
-		 * @see client/html/catalog/lists/items/decorators/local
-		 */
-
-		/** client/html/catalog/lists/items/decorators/global
-		 * Adds a list of globally available decorators only to the catalog list items 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/items/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/items/decorators/excludes
-		 * @see client/html/catalog/lists/items/decorators/local
-		 */
-
-		/** client/html/catalog/lists/items/decorators/local
-		 * Adds a list of local decorators only to the catalog list items 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/items/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/items/decorators/excludes
-		 * @see client/html/catalog/lists/items/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/lists/items/' . $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 );
-	}
-
-
-	/**
-	 * 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 )
-	{
-		$content = parent::modifyBody( $content, $uid );
-
-		return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.lists.items.csrf' );
-	}
-
-
-	/**
-	 * 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 ) )
-		{
-			$view->itemPosition = ( $this->getProductListPage( $view ) - 1 ) * $this->getProductListSize( $view );
-
-			if( $this->getContext()->getConfig()->get( 'client/html/catalog/lists/basket-add', false ) )
-			{
-				$view = $this->addSelectionProducts( $view, $tags, $expire );
-				$view = $this->addConfigAttributes( $view, $tags, $expire );
-			}
-
-			$this->view = $view;
-		}
-
-		return $this->view;
-	}
-
-
-	/**
-	 * Adds the necessary view parameters for adding selection products to the basket
-	 *
-	 * @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 addSelectionProducts( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$config = $context->getConfig();
-		$subProdMap = $prodMap = $prodIds = array();
-
-		foreach( (array) $view->get( 'listProductItems', array() ) as $product )
-		{
-			if( $product->getType() === 'select' )
-			{
-				foreach( $product->getListItems( 'product', 'default' ) as $listItem )
-				{
-					$prodMap[$listItem->getParentId()][] = $listItem->getRefId();
-					$prodIds[$listItem->getRefId()] = null;
-				}
-			}
-		}
-
-		$prodIds = array_keys( $prodIds );
-
-
-		$domains = array( 'text', 'price', 'media', 'attribute' );
-		$domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', $domains );
-
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-		$subproducts = $controller->getProductItems( $prodIds, $domains );
-		$attrIds = $prodDeps = $attrDeps = $attrTypeDeps = array();
-
-		foreach( $prodMap as $prodId => $list )
-		{
-			foreach( $list as $subProdId )
-			{
-				if( isset( $subproducts[$subProdId] ) )
-				{
-					$subProduct = $subproducts[$subProdId];
-					$subProdMap[$prodId][$subProdId] = $subProduct;
-
-					foreach( $subProduct->getRefItems( 'attribute', null, 'variant' ) as $attrId => $attrItem )
-					{
-						$attrTypeDeps[$prodId][$attrItem->getType()][$attrId] = $attrItem->getPosition();
-						$attrDeps[$prodId][$attrId][] = $subProdId;
-						$prodDeps[$prodId][$subProdId][] = $attrId;
-						$attrIds[$attrId] = null;
-					}
-				}
-			}
-
-			ksort( $attrTypeDeps[$prodId] );
-		}
-
-		$this->addMetaItem( $subproducts, 'product', $this->expire, $this->tags );
-		$this->addMetaList( array_keys( $subproducts ), 'product', $this->expire );
-
-
-		$attrManager = $controller->createManager( 'attribute' );
-
-		$search = $attrManager->createSearch( true );
-		$expr = array(
-			$search->compare( '==', 'attribute.id', array_keys( $attrIds ) ),
-			$search->getConditions(),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-
-		$domains = $config->get( 'client/html/catalog/lists/items/domains-attributes', array( 'text', 'price', 'media' ) );
-		$attributes = $attrManager->searchItems( $search, $domains );
-
-		$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
-		$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
-
-
-		if( !empty( $prodIds ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true ) {
-			$view->itemsStockUrl = $this->getStockUrl( $view, $prodIds );
-		}
-
-		$view->itemsSelectionProducts = $subProdMap;
-		$view->itemsSelectionProductDependencies = $prodDeps;
-		$view->itemsSelectionAttributeDependencies = $attrDeps;
-		$view->itemsSelectionAttributeTypeDependencies = $attrTypeDeps;
-		$view->itemsSelectionAttributeItems = $attributes;
-
-		return $view;
-	}
-
-
-	/**
-	 * Adds the necessary view parameters for adding config attributes to the basket
-	 *
-	 * @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 addConfigAttributes( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$config = $context->getConfig();
-		$attrIds = $attributeTypes = array();
-
-		foreach( (array) $view->get( 'listProductItems', array() ) as $product )
-		{
-			foreach( $product->getListItems( 'attribute' ) as $listItem ) {
-				$attrIds[$listItem->getRefId()] = null;
-			}
-		}
-
-
-		/** client/html/catalog/lists/items/domains-attributes
-		 * A list of domain names whose items should be available for the attributes
-		 * in the "items" part of the catalog list view templates
-		 *
-		 * The templates rendering attributes usually add images, texts and
-		 * maybe prices associated to each item. If you want to display
-		 * additional content like the attributes, you can configure your own
-		 * list of domains (attribute, media, price, product, text, etc. are
-		 * domains) whose items are fetched from the storage.
-		 *
-		 * Please keep in mind that the more domains you add to the
-		 * configuration, the more time is required for fetching the content!
-		 *
-		 * @param array List of domain names
-		 * @since 2016.01
-		 * @category Developer
-		 */
-		$domains = $config->get( 'client/html/catalog/lists/items/domains-attributes', array( 'text', 'price', 'media' ) );
-
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-		$attrManager = $controller->createManager( 'attribute' );
-
-		$search = $attrManager->createSearch( true );
-		$expr = array(
-			$search->compare( '==', 'attribute.id', array_keys( $attrIds ) ),
-			$search->getConditions(),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-
-		$attrItems = $attrManager->searchItems( $search, $domains );
-
-		$this->addMetaItem( $attrItems, 'attribute', $this->expire, $this->tags );
-		$this->addMetaList( array_keys( $attrItems ), 'attribute', $this->expire );
-
-
-		foreach( (array) $view->get( 'listProductItems', array() ) as $prodId => $product )
-		{
-			foreach( $product->getRefItems( 'attribute', null, 'config' ) as $id => $attribute )
-			{
-				if( isset( $attrItems[$id] ) ) {
-					$attributeTypes[$prodId][$attrItems[$id]->getType()][$id] = $attrItems[$id];
-				}
-			}
-		}
-
-		$view->itemsAttributeConfigItems = $attributeTypes;
-
-		return $view;
-	}
-
-
-	/**
-	 * 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 )
-	{
-		$stockTarget = $view->config( 'client/html/catalog/stock/url/target' );
-		$stockController = $view->config( 'client/html/catalog/stock/url/controller', 'catalog' );
-		$stockAction = $view->config( 'client/html/catalog/stock/url/action', 'stock' );
-		$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/items/standard/subparts
+     * List of HTML sub-clients rendered within the catalog list items 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/items/standard/subparts';
+    private $subPartNames = array();
+    private $tags = array();
+    private $expire;
+    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->itemsBody = $html;
+
+        /** client/html/catalog/lists/items/standard/template-body
+         * Relative path to the HTML body template of the catalog list items 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/items/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/lists/items/standard/template-body';
+        $default = 'catalog/lists/items-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->itemsHeader = $html;
+
+        /** client/html/catalog/lists/items/standard/template-header
+         * Relative path to the HTML header template of the catalog list items 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/items/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/lists/items/standard/template-header';
+        $default = 'catalog/lists/items-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/items/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog list items 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/items/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/items/decorators/global
+         * @see client/html/catalog/lists/items/decorators/local
+         */
+
+        /** client/html/catalog/lists/items/decorators/global
+         * Adds a list of globally available decorators only to the catalog list items 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/items/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/items/decorators/excludes
+         * @see client/html/catalog/lists/items/decorators/local
+         */
+
+        /** client/html/catalog/lists/items/decorators/local
+         * Adds a list of local decorators only to the catalog list items 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/items/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/items/decorators/excludes
+         * @see client/html/catalog/lists/items/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/lists/items/' . $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 );
+    }
+
+
+    /**
+     * 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 )
+    {
+        $content = parent::modifyBody( $content, $uid );
+
+        return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.lists.items.csrf' );
+    }
+
+
+    /**
+     * 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 ) )
+        {
+            $view->itemPosition = ( $this->getProductListPage( $view ) - 1 ) * $this->getProductListSize( $view );
+
+            if( $this->getContext()->getConfig()->get( 'client/html/catalog/lists/basket-add', false ) )
+            {
+                $view = $this->addSelectionProducts( $view, $tags, $expire );
+                $view = $this->addConfigAttributes( $view, $tags, $expire );
+            }
+
+            $this->view = $view;
+        }
+
+        return $this->view;
+    }
+
+
+    /**
+     * Adds the necessary view parameters for adding selection products to the basket
+     *
+     * @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 addSelectionProducts( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $config = $context->getConfig();
+        $subProdMap = $prodMap = $prodIds = array();
+
+        foreach( (array) $view->get( 'listProductItems', array() ) as $product )
+        {
+            if( $product->getType() === 'select' )
+            {
+                foreach( $product->getListItems( 'product', 'default' ) as $listItem )
+                {
+                    $prodMap[$listItem->getParentId()][] = $listItem->getRefId();
+                    $prodIds[$listItem->getRefId()] = null;
+                }
+            }
+        }
+
+        $prodIds = array_keys( $prodIds );
+
+
+        $domains = array( 'text', 'price', 'media', 'attribute' );
+        $domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', $domains );
+
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+        $subproducts = $controller->getProductItems( $prodIds, $domains );
+        $attrIds = $prodDeps = $attrDeps = $attrTypeDeps = array();
+
+        foreach( $prodMap as $prodId => $list )
+        {
+            foreach( $list as $subProdId )
+            {
+                if( isset( $subproducts[$subProdId] ) )
+                {
+                    $subProduct = $subproducts[$subProdId];
+                    $subProdMap[$prodId][$subProdId] = $subProduct;
+
+                    foreach( $subProduct->getRefItems( 'attribute', null, 'variant' ) as $attrId => $attrItem )
+                    {
+                        $attrTypeDeps[$prodId][$attrItem->getType()][$attrId] = $attrItem->getPosition();
+                        $attrDeps[$prodId][$attrId][] = $subProdId;
+                        $prodDeps[$prodId][$subProdId][] = $attrId;
+                        $attrIds[$attrId] = null;
+                    }
+                }
+            }
+
+            ksort( $attrTypeDeps[$prodId] );
+        }
+
+        $this->addMetaItem( $subproducts, 'product', $this->expire, $this->tags );
+        $this->addMetaList( array_keys( $subproducts ), 'product', $this->expire );
+
+
+        $attrManager = $controller->createManager( 'attribute' );
+
+        $search = $attrManager->createSearch( true );
+        $expr = array(
+            $search->compare( '==', 'attribute.id', array_keys( $attrIds ) ),
+            $search->getConditions(),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+
+        $domains = $config->get( 'client/html/catalog/lists/items/domains-attributes', array( 'text', 'price', 'media' ) );
+        $attributes = $attrManager->searchItems( $search, $domains );
+
+        $this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
+        $this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
+
+
+        if( !empty( $prodIds ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true ) {
+            $view->itemsStockUrl = $this->getStockUrl( $view, $prodIds );
+        }
+
+        $view->itemsSelectionProducts = $subProdMap;
+        $view->itemsSelectionProductDependencies = $prodDeps;
+        $view->itemsSelectionAttributeDependencies = $attrDeps;
+        $view->itemsSelectionAttributeTypeDependencies = $attrTypeDeps;
+        $view->itemsSelectionAttributeItems = $attributes;
+
+        return $view;
+    }
+
+
+    /**
+     * Adds the necessary view parameters for adding config attributes to the basket
+     *
+     * @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 addConfigAttributes( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $config = $context->getConfig();
+        $attrIds = $attributeTypes = array();
+
+        foreach( (array) $view->get( 'listProductItems', array() ) as $product )
+        {
+            foreach( $product->getListItems( 'attribute' ) as $listItem ) {
+                $attrIds[$listItem->getRefId()] = null;
+            }
+        }
+
+
+        /** client/html/catalog/lists/items/domains-attributes
+         * A list of domain names whose items should be available for the attributes
+         * in the "items" part of the catalog list view templates
+         *
+         * The templates rendering attributes usually add images, texts and
+         * maybe prices associated to each item. If you want to display
+         * additional content like the attributes, you can configure your own
+         * list of domains (attribute, media, price, product, text, etc. are
+         * domains) whose items are fetched from the storage.
+         *
+         * Please keep in mind that the more domains you add to the
+         * configuration, the more time is required for fetching the content!
+         *
+         * @param array List of domain names
+         * @since 2016.01
+         * @category Developer
+         */
+        $domains = $config->get( 'client/html/catalog/lists/items/domains-attributes', array( 'text', 'price', 'media' ) );
+
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+        $attrManager = $controller->createManager( 'attribute' );
+
+        $search = $attrManager->createSearch( true );
+        $expr = array(
+            $search->compare( '==', 'attribute.id', array_keys( $attrIds ) ),
+            $search->getConditions(),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+
+        $attrItems = $attrManager->searchItems( $search, $domains );
+
+        $this->addMetaItem( $attrItems, 'attribute', $this->expire, $this->tags );
+        $this->addMetaList( array_keys( $attrItems ), 'attribute', $this->expire );
+
+
+        foreach( (array) $view->get( 'listProductItems', array() ) as $prodId => $product )
+        {
+            foreach( $product->getRefItems( 'attribute', null, 'config' ) as $id => $attribute )
+            {
+                if( isset( $attrItems[$id] ) ) {
+                    $attributeTypes[$prodId][$attrItems[$id]->getType()][$id] = $attrItems[$id];
+                }
+            }
+        }
+
+        $view->itemsAttributeConfigItems = $attributeTypes;
+
+        return $view;
+    }
+
+
+    /**
+     * 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 )
+    {
+        $stockTarget = $view->config( 'client/html/catalog/stock/url/target' );
+        $stockController = $view->config( 'client/html/catalog/stock/url/controller', 'catalog' );
+        $stockAction = $view->config( 'client/html/catalog/stock/url/action', 'stock' );
+        $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 );
+    }
 }
\ No newline at end of file

Spacing +71 added lines, -71 removed lines

@@ -70,13 +70,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->itemsBody = $html;
 
@@ -103,7 +103,7 @@ 
 		$tplconf = 'client/html/catalog/lists/items/standard/template-body';
 		$default = 'catalog/lists/items-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -115,13 +115,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->itemsHeader = $html;
 
@@ -149,7 +149,7 @@ 
 		$tplconf = 'client/html/catalog/lists/items/standard/template-header';
 		$default = 'catalog/lists/items-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -160,7 +160,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/catalog/lists/items/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog list items html client
@@ -236,7 +236,7 @@ 
 		 * @see client/html/catalog/lists/items/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/lists/items/' . $type, $name );
+		return $this->createSubClient('catalog/lists/items/'.$type, $name);
 	}
 
 
@@ -247,7 +247,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -258,11 +258,11 @@ 
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @return string Modified body content
 	 */
-	public function modifyBody( $content, $uid )
+	public function modifyBody($content, $uid)
 	{
-		$content = parent::modifyBody( $content, $uid );
+		$content = parent::modifyBody($content, $uid);
 
-		return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.lists.items.csrf' );
+		return $this->replaceSection($content, $this->getView()->csrf()->formfield(), 'catalog.lists.items.csrf');
 	}
 
 
@@ -274,16 +274,16 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->view ) )
+		if (!isset($this->view))
 		{
-			$view->itemPosition = ( $this->getProductListPage( $view ) - 1 ) * $this->getProductListSize( $view );
+			$view->itemPosition = ($this->getProductListPage($view) - 1) * $this->getProductListSize($view);
 
-			if( $this->getContext()->getConfig()->get( 'client/html/catalog/lists/basket-add', false ) )
+			if ($this->getContext()->getConfig()->get('client/html/catalog/lists/basket-add', false))
 			{
-				$view = $this->addSelectionProducts( $view, $tags, $expire );
-				$view = $this->addConfigAttributes( $view, $tags, $expire );
+				$view = $this->addSelectionProducts($view, $tags, $expire);
+				$view = $this->addConfigAttributes($view, $tags, $expire);
 			}
 
 			$this->view = $view;
@@ -301,17 +301,17 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function addSelectionProducts( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function addSelectionProducts(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
 		$context = $this->getContext();
 		$config = $context->getConfig();
 		$subProdMap = $prodMap = $prodIds = array();
 
-		foreach( (array) $view->get( 'listProductItems', array() ) as $product )
+		foreach ((array) $view->get('listProductItems', array()) as $product)
 		{
-			if( $product->getType() === 'select' )
+			if ($product->getType() === 'select')
 			{
-				foreach( $product->getListItems( 'product', 'default' ) as $listItem )
+				foreach ($product->getListItems('product', 'default') as $listItem)
 				{
 					$prodMap[$listItem->getParentId()][] = $listItem->getRefId();
 					$prodIds[$listItem->getRefId()] = null;
@@ -319,26 +319,26 @@ 
 			}
 		}
 
-		$prodIds = array_keys( $prodIds );
+		$prodIds = array_keys($prodIds);
 
 
-		$domains = array( 'text', 'price', 'media', 'attribute' );
-		$domains = $config->get( 'client/html/catalog/detail/basket/selection/domains', $domains );
+		$domains = array('text', 'price', 'media', 'attribute');
+		$domains = $config->get('client/html/catalog/detail/basket/selection/domains', $domains);
 
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-		$subproducts = $controller->getProductItems( $prodIds, $domains );
+		$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
+		$subproducts = $controller->getProductItems($prodIds, $domains);
 		$attrIds = $prodDeps = $attrDeps = $attrTypeDeps = array();
 
-		foreach( $prodMap as $prodId => $list )
+		foreach ($prodMap as $prodId => $list)
 		{
-			foreach( $list as $subProdId )
+			foreach ($list as $subProdId)
 			{
-				if( isset( $subproducts[$subProdId] ) )
+				if (isset($subproducts[$subProdId]))
 				{
 					$subProduct = $subproducts[$subProdId];
 					$subProdMap[$prodId][$subProdId] = $subProduct;
 
-					foreach( $subProduct->getRefItems( 'attribute', null, 'variant' ) as $attrId => $attrItem )
+					foreach ($subProduct->getRefItems('attribute', null, 'variant') as $attrId => $attrItem)
 					{
 						$attrTypeDeps[$prodId][$attrItem->getType()][$attrId] = $attrItem->getPosition();
 						$attrDeps[$prodId][$attrId][] = $subProdId;
@@ -348,31 +348,31 @@ 
 				}
 			}
 
-			ksort( $attrTypeDeps[$prodId] );
+			ksort($attrTypeDeps[$prodId]);
 		}
 
-		$this->addMetaItem( $subproducts, 'product', $this->expire, $this->tags );
-		$this->addMetaList( array_keys( $subproducts ), 'product', $this->expire );
+		$this->addMetaItem($subproducts, 'product', $this->expire, $this->tags);
+		$this->addMetaList(array_keys($subproducts), 'product', $this->expire);
 
 
-		$attrManager = $controller->createManager( 'attribute' );
+		$attrManager = $controller->createManager('attribute');
 
-		$search = $attrManager->createSearch( true );
+		$search = $attrManager->createSearch(true);
 		$expr = array(
-			$search->compare( '==', 'attribute.id', array_keys( $attrIds ) ),
+			$search->compare('==', 'attribute.id', array_keys($attrIds)),
 			$search->getConditions(),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
+		$search->setConditions($search->combine('&&', $expr));
 
-		$domains = $config->get( 'client/html/catalog/lists/items/domains-attributes', array( 'text', 'price', 'media' ) );
-		$attributes = $attrManager->searchItems( $search, $domains );
+		$domains = $config->get('client/html/catalog/lists/items/domains-attributes', array('text', 'price', 'media'));
+		$attributes = $attrManager->searchItems($search, $domains);
 
-		$this->addMetaItem( $attributes, 'attribute', $this->expire, $this->tags );
-		$this->addMetaList( array_keys( $attributes ), 'attribute', $this->expire );
+		$this->addMetaItem($attributes, 'attribute', $this->expire, $this->tags);
+		$this->addMetaList(array_keys($attributes), 'attribute', $this->expire);
 
 
-		if( !empty( $prodIds ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true ) {
-			$view->itemsStockUrl = $this->getStockUrl( $view, $prodIds );
+		if (!empty($prodIds) && $config->get('client/html/catalog/lists/stock/enable', true) === true) {
+			$view->itemsStockUrl = $this->getStockUrl($view, $prodIds);
 		}
 
 		$view->itemsSelectionProducts = $subProdMap;
@@ -393,15 +393,15 @@ 
 	 * @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 addConfigAttributes( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function addConfigAttributes(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
 		$context = $this->getContext();
 		$config = $context->getConfig();
 		$attrIds = $attributeTypes = array();
 
-		foreach( (array) $view->get( 'listProductItems', array() ) as $product )
+		foreach ((array) $view->get('listProductItems', array()) as $product)
 		{
-			foreach( $product->getListItems( 'attribute' ) as $listItem ) {
+			foreach ($product->getListItems('attribute') as $listItem) {
 				$attrIds[$listItem->getRefId()] = null;
 			}
 		}
@@ -424,29 +424,29 @@ 
 		 * @since 2016.01
 		 * @category Developer
 		 */
-		$domains = $config->get( 'client/html/catalog/lists/items/domains-attributes', array( 'text', 'price', 'media' ) );
+		$domains = $config->get('client/html/catalog/lists/items/domains-attributes', array('text', 'price', 'media'));
 
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-		$attrManager = $controller->createManager( 'attribute' );
+		$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
+		$attrManager = $controller->createManager('attribute');
 
-		$search = $attrManager->createSearch( true );
+		$search = $attrManager->createSearch(true);
 		$expr = array(
-			$search->compare( '==', 'attribute.id', array_keys( $attrIds ) ),
+			$search->compare('==', 'attribute.id', array_keys($attrIds)),
 			$search->getConditions(),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
+		$search->setConditions($search->combine('&&', $expr));
 
-		$attrItems = $attrManager->searchItems( $search, $domains );
+		$attrItems = $attrManager->searchItems($search, $domains);
 
-		$this->addMetaItem( $attrItems, 'attribute', $this->expire, $this->tags );
-		$this->addMetaList( array_keys( $attrItems ), 'attribute', $this->expire );
+		$this->addMetaItem($attrItems, 'attribute', $this->expire, $this->tags);
+		$this->addMetaList(array_keys($attrItems), 'attribute', $this->expire);
 
 
-		foreach( (array) $view->get( 'listProductItems', array() ) as $prodId => $product )
+		foreach ((array) $view->get('listProductItems', array()) as $prodId => $product)
 		{
-			foreach( $product->getRefItems( 'attribute', null, 'config' ) as $id => $attribute )
+			foreach ($product->getRefItems('attribute', null, 'config') as $id => $attribute)
 			{
-				if( isset( $attrItems[$id] ) ) {
+				if (isset($attrItems[$id])) {
 					$attributeTypes[$prodId][$attrItems[$id]->getType()][$id] = $attrItems[$id];
 				}
 			}
@@ -465,16 +465,16 @@ 
 	 * @param array $productIds List of product IDs
 	 * @return string Generated stock level URL
 	 */
-	protected function getStockUrl( \Aimeos\MW\View\Iface $view, array $productIds )
+	protected function getStockUrl(\Aimeos\MW\View\Iface $view, array $productIds)
 	{
-		$stockTarget = $view->config( 'client/html/catalog/stock/url/target' );
-		$stockController = $view->config( 'client/html/catalog/stock/url/controller', 'catalog' );
-		$stockAction = $view->config( 'client/html/catalog/stock/url/action', 'stock' );
-		$stockConfig = $view->config( 'client/html/catalog/stock/url/config', array() );
+		$stockTarget = $view->config('client/html/catalog/stock/url/target');
+		$stockController = $view->config('client/html/catalog/stock/url/controller', 'catalog');
+		$stockAction = $view->config('client/html/catalog/stock/url/action', 'stock');
+		$stockConfig = $view->config('client/html/catalog/stock/url/config', array());
 
-		sort( $productIds );
+		sort($productIds);
 
-		$params = array( 's_prodid' => implode( ' ', $productIds ) );
-		return $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
+		$params = array('s_prodid' => implode(' ', $productIds));
+		return $view->url($stockTarget, $stockController, $stockAction, $params, array(), $stockConfig);
 	}
 }
\ No newline at end of file