aimeos / ai-client-html

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

Spacing +68 added lines, -68 removed lines

@@ -89,7 +89,7 @@ 
 	 * @since 2014.09
 	 * @category Developer
 	 */
-	private $subPartNames = array( 'image', 'breadcrumb', 'navigator' );
+	private $subPartNames = array('image', 'breadcrumb', 'navigator');
 
 	private $tags = array();
 	private $expire;
@@ -104,9 +104,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/stage
@@ -121,41 +121,41 @@ 
 		 */
 		$confkey = 'client/html/catalog/stage';
 
-		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->stageBody = $output;
 			}
-			catch( \Aimeos\Client\Html\Exception $e )
+			catch (\Aimeos\Client\Html\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', $e->getMessage()));
+				$view->stageErrorList = $view->get('stageErrorList', array()) + $error;
 			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
+			catch (\Aimeos\Controller\Frontend\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
+				$view->stageErrorList = $view->get('stageErrorList', array()) + $error;
 			}
-			catch( \Aimeos\MShop\Exception $e )
+			catch (\Aimeos\MShop\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
+				$view->stageErrorList = $view->get('stageErrorList', 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->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+				$view->stageErrorList = $view->get('stageErrorList', array()) + $error;
 			}
 
 			/** client/html/catalog/stage/standard/template-body
@@ -181,13 +181,13 @@ 
 			$tplconf = 'client/html/catalog/stage/standard/template-body';
 			$default = 'catalog/stage/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;
@@ -202,29 +202,29 @@ 
 	 * @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( 'f' );
+		$prefixes = array('f');
 		$context = $this->getContext();
 		$confkey = 'client/html/catalog/stage';
 
-		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->stageHeader = $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/stage/standard/template-header
@@ -251,13 +251,13 @@ 
 			$tplconf = 'client/html/catalog/stage/standard/template-header';
 			$default = 'catalog/stage/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;
@@ -271,7 +271,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/stage/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog stage html client
@@ -346,7 +346,7 @@ 
 		 * @see client/html/catalog/stage/decorators/excludes
 		 * @see client/html/catalog/stage/decorators/global
 		 */
-		return $this->createSubClient( 'catalog/stage/' . $type, $name );
+		return $this->createSubClient('catalog/stage/'.$type, $name);
 	}
 
 
@@ -363,28 +363,28 @@ 
 		{
 			parent::process();
 		}
-		catch( \Aimeos\Client\Html\Exception $e )
+		catch (\Aimeos\Client\Html\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('client', $e->getMessage()));
+			$view->stageErrorList = $view->get('stageErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->stageErrorList = $view->get('stageErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+			$error = array($this->getContext()->getI18n()->dt('mshop', $e->getMessage()));
+			$view->stageErrorList = $view->get('stageErrorList', array()) + $error;
 		}
-		catch( \Exception $e )
+		catch (\Exception $e)
 		{
 			$context = $this->getContext();
-			$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->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->stageErrorList = $view->get('stageErrorList', array()) + $error;
 		}
 	}
 
@@ -396,15 +396,15 @@ 
 	 * @param array $prefixes List of prefixes the parameters must start with
 	 * @return array Associative list of parameters used by the html client
 	 */
-	protected function getClientParams( array $params, array $prefixes = array( 'f', 'l', 'd', 'a' ) )
+	protected function getClientParams(array $params, array $prefixes = array('f', 'l', 'd', 'a'))
 	{
-		$list = parent::getClientParams( $params, array_merge( $prefixes, array( 'l', 'd' ) ) );
+		$list = parent::getClientParams($params, array_merge($prefixes, array('l', 'd')));
 
-		if( isset( $list['l_pos'] ) && isset( $list['d_prodid'] ) )
+		if (isset($list['l_pos']) && isset($list['d_prodid']))
 		{
 			$context = $this->getContext();
 			$site = $context->getLocale()->getSite()->getCode();
-			$list += (array) $context->getSession()->get( 'aimeos/catalog/lists/params/last/' . $site, array() );
+			$list += (array) $context->getSession()->get('aimeos/catalog/lists/params/last/'.$site, array());
 		}
 
 		return $list;
@@ -418,7 +418,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -430,26 +430,26 @@ 
 	 * @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))
 		{
-			$params = $this->getClientParams( $view->param(), array( 'f' ) );
+			$params = $this->getClientParams($view->param(), array('f'));
 
-			if( isset( $params['f_catid'] ) && $params['f_catid'] != '' )
+			if (isset($params['f_catid']) && $params['f_catid'] != '')
 			{
 				$context = $this->getContext();
 				$config = $context->getConfig();
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+				$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
 
-				$default = array( 'attribute', 'media', 'text' );
+				$default = array('attribute', 'media', 'text');
 
 				/** client/html/catalog/domains
 				 * A list of domain names whose items should be available in the catalog view templates
 				 *
 				 * @see client/html/catalog/stage/domains
 				 */
-				$domains = $config->get( 'client/html/catalog/domains', $default );
+				$domains = $config->get('client/html/catalog/domains', $default);
 
 				/** client/html/catalog/stage/standard/domains
 				 * A list of domain names whose items should be available in the catalog stage view template
@@ -472,15 +472,15 @@ 
 				 * @see client/html/catalog/detail/domains
 				 * @see client/html/catalog/lists/domains
 				 */
-				$domains = $config->get( 'client/html/catalog/stage/standard/domains', $domains );
-				$stageCatPath = $controller->getCatalogPath( $params['f_catid'], $domains );
+				$domains = $config->get('client/html/catalog/stage/standard/domains', $domains);
+				$stageCatPath = $controller->getCatalogPath($params['f_catid'], $domains);
 
-				if( ( $categoryItem = end( $stageCatPath ) ) !== false ) {
+				if (($categoryItem = end($stageCatPath)) !== false) {
 					$view->stageCurrentCatItem = $categoryItem;
 				}
 
-				$this->addMetaItem( $stageCatPath, 'catalog', $this->expire, $this->tags );
-				$this->addMetaList( array_keys( $stageCatPath ), 'catalog', $this->expire );
+				$this->addMetaItem($stageCatPath, 'catalog', $this->expire, $this->tags);
+				$this->addMetaList(array_keys($stageCatPath), 'catalog', $this->expire);
 
 				$view->stageCatPath = $stageCatPath;
 			}
@@ -490,8 +490,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 +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() );
 

Indentation +475 added lines, -475 removed lines

@@ -19,480 +19,480 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/stage/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog stage section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/stage/standard/subparts';
-
-	/** client/html/catalog/stage/image/name
-	 * Name of the image part used by the catalog stage client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Stage\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/stage/breadcrumb/name
-	 * Name of the breadcrumb part used by the catalog stage client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Stage\Breadcrumb\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/stage/navigator/name
-	 * Name of the navigator part used by the catalog stage client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Stage\Breadcrumb\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
-	 */
-	private $subPartNames = array( 'image', 'breadcrumb', 'navigator' );
-
-	private $tags = array();
-	private $expire;
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$prefixes = array( 'f' );
-		$context = $this->getContext();
-
-		/** client/html/catalog/stage
-		 * All parameters defined for the catalog stage component and its subparts
-		 *
-		 * This returns all settings related to the stage component.
-		 * Please refer to the single settings for details.
-		 *
-		 * @param array Associative list of name/value settings
-		 * @category Developer
-		 * @see client/html/catalog#stage
-		 */
-		$confkey = 'client/html/catalog/stage';
-
-		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->stageBody = $output;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->stageErrorList = $view->get( 'stageErrorList', 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->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
-			}
-
-			/** client/html/catalog/stage/standard/template-body
-			 * Relative path to the HTML body template of the catalog stage client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the result shown in the body of the frontend. The
-			 * configuration string is the path to the template file relative
-			 * to the templates directory (usually in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page body
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/stage/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/stage/standard/template-body';
-			$default = 'catalog/stage/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 String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$prefixes = array( 'f' );
-		$context = $this->getContext();
-		$confkey = 'client/html/catalog/stage';
-
-		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->stageHeader = $html;
-			}
-			catch( \Exception $e )
-			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-			}
-
-			/** client/html/catalog/stage/standard/template-header
-			 * Relative path to the HTML header template of the catalog stage client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the HTML code that is inserted into the HTML page header
-			 * of the rendered page in the frontend. The configuration string is the
-			 * path to the template file relative to the templates directory (usually
-			 * in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page head
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/stage/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/stage/standard/template-header';
-			$default = 'catalog/stage/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/stage/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog stage html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/stage/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/stage/decorators/global
-		 * @see client/html/catalog/stage/decorators/local
-		 */
-
-		/** client/html/catalog/stage/decorators/global
-		 * Adds a list of globally available decorators only to the catalog stage html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/stage/decorators/excludes
-		 * @see client/html/catalog/stage/decorators/local
-		 */
-
-		/** client/html/catalog/stage/decorators/local
-		 * Adds a list of local decorators only to the catalog stage html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/stage/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/stage/decorators/excludes
-		 * @see client/html/catalog/stage/decorators/global
-		 */
-		return $this->createSubClient( 'catalog/stage/' . $type, $name );
-	}
-
-
-	/**
-	 * Processes the input, e.g. store given values.
-	 * A view must be available and this method doesn't generate any output
-	 * besides setting view variables.
-	 */
-	public function process()
-	{
-		$view = $this->getView();
-
-		try
-		{
-			parent::process();
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context = $this->getContext();
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
-		}
-	}
-
-
-	/**
-	 * Returns the parameters used by the html client.
-	 *
-	 * @param array $params Associative list of all parameters
-	 * @param string[] $prefixes List of prefixes the parameters must start with
-	 * @return array Associative list of parameters used by the html client
-	 */
-	protected function getClientParams( array $params, array $prefixes = array( 'f', 'l', 'd', 'a' ) )
-	{
-		$list = parent::getClientParams( $params, array_merge( $prefixes, array( 'l', 'd' ) ) );
-
-		if( isset( $list['l_pos'] ) && isset( $list['d_prodid'] ) )
-		{
-			$context = $this->getContext();
-			$site = $context->getLocale()->getSite()->getCode();
-			$list += (array) $context->getSession()->get( 'aimeos/catalog/lists/params/last/' . $site, array() );
-		}
-
-		return $list;
-	}
-
-
-	/**
-	 * 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 ) )
-		{
-			$params = $this->getClientParams( $view->param(), array( 'f' ) );
-
-			if( isset( $params['f_catid'] ) && $params['f_catid'] != '' )
-			{
-				$context = $this->getContext();
-				$config = $context->getConfig();
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-				$default = array( 'attribute', 'media', 'text' );
-
-				/** client/html/catalog/domains
-				 * A list of domain names whose items should be available in the catalog view templates
-				 *
-				 * @see client/html/catalog/stage/domains
-				 */
-				$domains = $config->get( 'client/html/catalog/domains', $default );
-
-				/** client/html/catalog/stage/standard/domains
-				 * A list of domain names whose items should be available in the catalog stage view template
-				 *
-				 * The templates rendering the catalog stage section use the texts and
-				 * maybe images and attributes associated to the categories. 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 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/detail/domains
-				 * @see client/html/catalog/lists/domains
-				 */
-				$domains = $config->get( 'client/html/catalog/stage/standard/domains', $domains );
-				$stageCatPath = $controller->getCatalogPath( $params['f_catid'], $domains );
-
-				if( ( $categoryItem = end( $stageCatPath ) ) !== false ) {
-					$view->stageCurrentCatItem = $categoryItem;
-				}
-
-				$this->addMetaItem( $stageCatPath, 'catalog', $this->expire, $this->tags );
-				$this->addMetaList( array_keys( $stageCatPath ), 'catalog', $this->expire );
-
-				$view->stageCatPath = $stageCatPath;
-			}
-
-			$view->stageParams = $params;
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
+    /** client/html/catalog/stage/standard/subparts
+     * List of HTML sub-clients rendered within the catalog stage section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/stage/standard/subparts';
+
+    /** client/html/catalog/stage/image/name
+     * Name of the image part used by the catalog stage client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Stage\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/stage/breadcrumb/name
+     * Name of the breadcrumb part used by the catalog stage client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Stage\Breadcrumb\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/stage/navigator/name
+     * Name of the navigator part used by the catalog stage client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Stage\Breadcrumb\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
+     */
+    private $subPartNames = array( 'image', 'breadcrumb', 'navigator' );
+
+    private $tags = array();
+    private $expire;
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $prefixes = array( 'f' );
+        $context = $this->getContext();
+
+        /** client/html/catalog/stage
+         * All parameters defined for the catalog stage component and its subparts
+         *
+         * This returns all settings related to the stage component.
+         * Please refer to the single settings for details.
+         *
+         * @param array Associative list of name/value settings
+         * @category Developer
+         * @see client/html/catalog#stage
+         */
+        $confkey = 'client/html/catalog/stage';
+
+        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->stageBody = $output;
+            }
+            catch( \Aimeos\Client\Html\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+                $view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\Controller\Frontend\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+                $view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\MShop\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+                $view->stageErrorList = $view->get( 'stageErrorList', 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->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+            }
+
+            /** client/html/catalog/stage/standard/template-body
+             * Relative path to the HTML body template of the catalog stage client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the result shown in the body of the frontend. The
+             * configuration string is the path to the template file relative
+             * to the templates directory (usually in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page body
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/stage/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/stage/standard/template-body';
+            $default = 'catalog/stage/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 String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $prefixes = array( 'f' );
+        $context = $this->getContext();
+        $confkey = 'client/html/catalog/stage';
+
+        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->stageHeader = $html;
+            }
+            catch( \Exception $e )
+            {
+                $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            }
+
+            /** client/html/catalog/stage/standard/template-header
+             * Relative path to the HTML header template of the catalog stage client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the HTML code that is inserted into the HTML page header
+             * of the rendered page in the frontend. The configuration string is the
+             * path to the template file relative to the templates directory (usually
+             * in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page head
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/stage/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/stage/standard/template-header';
+            $default = 'catalog/stage/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/stage/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog stage html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/stage/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/stage/decorators/global
+         * @see client/html/catalog/stage/decorators/local
+         */
+
+        /** client/html/catalog/stage/decorators/global
+         * Adds a list of globally available decorators only to the catalog stage html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/stage/decorators/excludes
+         * @see client/html/catalog/stage/decorators/local
+         */
+
+        /** client/html/catalog/stage/decorators/local
+         * Adds a list of local decorators only to the catalog stage html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/stage/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/stage/decorators/excludes
+         * @see client/html/catalog/stage/decorators/global
+         */
+        return $this->createSubClient( 'catalog/stage/' . $type, $name );
+    }
+
+
+    /**
+     * Processes the input, e.g. store given values.
+     * A view must be available and this method doesn't generate any output
+     * besides setting view variables.
+     */
+    public function process()
+    {
+        $view = $this->getView();
+
+        try
+        {
+            parent::process();
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+        }
+        catch( \Exception $e )
+        {
+            $context = $this->getContext();
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->stageErrorList = $view->get( 'stageErrorList', array() ) + $error;
+        }
+    }
+
+
+    /**
+     * Returns the parameters used by the html client.
+     *
+     * @param array $params Associative list of all parameters
+     * @param string[] $prefixes List of prefixes the parameters must start with
+     * @return array Associative list of parameters used by the html client
+     */
+    protected function getClientParams( array $params, array $prefixes = array( 'f', 'l', 'd', 'a' ) )
+    {
+        $list = parent::getClientParams( $params, array_merge( $prefixes, array( 'l', 'd' ) ) );
+
+        if( isset( $list['l_pos'] ) && isset( $list['d_prodid'] ) )
+        {
+            $context = $this->getContext();
+            $site = $context->getLocale()->getSite()->getCode();
+            $list += (array) $context->getSession()->get( 'aimeos/catalog/lists/params/last/' . $site, array() );
+        }
+
+        return $list;
+    }
+
+
+    /**
+     * 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 ) )
+        {
+            $params = $this->getClientParams( $view->param(), array( 'f' ) );
+
+            if( isset( $params['f_catid'] ) && $params['f_catid'] != '' )
+            {
+                $context = $this->getContext();
+                $config = $context->getConfig();
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+                $default = array( 'attribute', 'media', 'text' );
+
+                /** client/html/catalog/domains
+                 * A list of domain names whose items should be available in the catalog view templates
+                 *
+                 * @see client/html/catalog/stage/domains
+                 */
+                $domains = $config->get( 'client/html/catalog/domains', $default );
+
+                /** client/html/catalog/stage/standard/domains
+                 * A list of domain names whose items should be available in the catalog stage view template
+                 *
+                 * The templates rendering the catalog stage section use the texts and
+                 * maybe images and attributes associated to the categories. 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 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/detail/domains
+                 * @see client/html/catalog/lists/domains
+                 */
+                $domains = $config->get( 'client/html/catalog/stage/standard/domains', $domains );
+                $stageCatPath = $controller->getCatalogPath( $params['f_catid'], $domains );
+
+                if( ( $categoryItem = end( $stageCatPath ) ) !== false ) {
+                    $view->stageCurrentCatItem = $categoryItem;
+                }
+
+                $this->addMetaItem( $stageCatPath, 'catalog', $this->expire, $this->tags );
+                $this->addMetaList( array_keys( $stageCatPath ), 'catalog', $this->expire );
+
+                $view->stageCatPath = $stageCatPath;
+            }
+
+            $view->stageParams = $params;
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
 }

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

Indentation +236 added lines, -236 removed lines

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

Spacing +19 added lines, -19 removed lines

@@ -68,13 +68,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->imageBody = $html;
 
@@ -101,7 +101,7 @@ 
 		$tplconf = 'client/html/catalog/stage/image/standard/template-body';
 		$default = 'catalog/stage/image-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -113,13 +113,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->imageHeader = $html;
 
@@ -147,7 +147,7 @@ 
 		$tplconf = 'client/html/catalog/stage/image/standard/template-header';
 		$default = 'catalog/stage/image-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -158,7 +158,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/stage/image/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog stage image html client
@@ -233,7 +233,7 @@ 
 		 * @see client/html/catalog/stage/image/decorators/excludes
 		 * @see client/html/catalog/stage/image/decorators/global
 		 */
-		return $this->createSubClient( 'catalog/stage/image/' . $type, $name );
+		return $this->createSubClient('catalog/stage/image/'.$type, $name);
 	}
 
 
@@ -244,7 +244,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -256,18 +256,18 @@ 
 	 * @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))
 		{
 			$mediaItems = array();
-			$catPath = $view->get( 'stageCatPath', array() );
+			$catPath = $view->get('stageCatPath', array());
 
-			foreach( array_reverse( $catPath ) as $catItem )
+			foreach (array_reverse($catPath) as $catItem)
 			{
-				$mediaItems = $catItem->getRefItems( 'media', 'default', 'stage' );
+				$mediaItems = $catItem->getRefItems('media', 'default', 'stage');
 
-				if( !empty( $mediaItems ) ) {
+				if (!empty($mediaItems)) {
 					break;
 				}
 			}

Doc Comments +1 added lines, -1 removed lines

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

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

Indentation +226 added lines, -226 removed lines

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

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

Doc Comments +1 added lines, -1 removed lines

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

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

Indentation +59 added lines, -59 removed lines

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

Spacing +9 added lines, -9 removed lines

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

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

Indentation +582 added lines, -582 removed lines

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

Spacing +85 added lines, -85 removed lines

@@ -111,7 +111,7 @@ 
 	 * @since 2014.03
 	 * @category Developer
 	 */
-	private $subPartNames = array( 'head', 'quote', 'promo', 'pagination', 'items', 'pagination' );
+	private $subPartNames = array('head', 'quote', 'promo', 'pagination', 'items', 'pagination');
 
 	private $tags = array();
 	private $expire;
@@ -126,9 +126,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', 'l' );
+		$prefixes = array('f', 'l');
 		$context = $this->getContext();
 
 		/** client/html/catalog/list
@@ -143,41 +143,41 @@ 
 		 */
 		$confkey = 'client/html/catalog/list';
 
-		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->listBody = $html;
 			}
-			catch( \Aimeos\Client\Html\Exception $e )
+			catch (\Aimeos\Client\Html\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', $e->getMessage()));
+				$view->listErrorList = $view->get('listErrorList', array()) + $error;
 			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
+			catch (\Aimeos\Controller\Frontend\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
+				$view->listErrorList = $view->get('listErrorList', array()) + $error;
 			}
-			catch( \Aimeos\MShop\Exception $e )
+			catch (\Aimeos\MShop\Exception $e)
 			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
+				$view->listErrorList = $view->get('listErrorList', 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->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+				$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+				$view->listErrorList = $view->get('listErrorList', array()) + $error;
 			}
 
 			/** client/html/catalog/lists/standard/template-body
@@ -203,13 +203,13 @@ 
 			$tplconf = 'client/html/catalog/lists/standard/template-body';
 			$default = 'catalog/lists/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;
@@ -224,29 +224,29 @@ 
 	 * @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( 'f', 'l' );
+		$prefixes = array('f', 'l');
 		$context = $this->getContext();
 		$confkey = 'client/html/catalog/list';
 
-		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->listHeader = $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/lists/standard/template-header
@@ -273,13 +273,13 @@ 
 			$tplconf = 'client/html/catalog/lists/standard/template-header';
 			$default = 'catalog/lists/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;
@@ -293,7 +293,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/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog list html client
@@ -369,7 +369,7 @@ 
 		 * @see client/html/catalog/lists/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/lists/' . $type, $name );
+		return $this->createSubClient('catalog/lists/'.$type, $name);
 	}
 
 
@@ -386,32 +386,32 @@ 
 		try
 		{
 			$site = $context->getLocale()->getSite()->getCode();
-			$params = $this->getClientParams( $view->param() );
-			$context->getSession()->set( 'aimeos/catalog/lists/params/last/' . $site, $params );
+			$params = $this->getClientParams($view->param());
+			$context->getSession()->set('aimeos/catalog/lists/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->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', $e->getMessage()));
+			$view->listErrorList = $view->get('listErrorList', array()) + $error;
 		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
+		catch (\Aimeos\Controller\Frontend\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('controller/frontend', $e->getMessage()));
+			$view->listErrorList = $view->get('listErrorList', array()) + $error;
 		}
-		catch( \Aimeos\MShop\Exception $e )
+		catch (\Aimeos\MShop\Exception $e)
 		{
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('mshop', $e->getMessage()));
+			$view->listErrorList = $view->get('listErrorList', 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->listErrorList = $view->get( 'listErrorList', array() ) + $error;
+			$error = array($context->getI18n()->dt('client', 'A non-recoverable error occured'));
+			$view->listErrorList = $view->get('listErrorList', array()) + $error;
 		}
 	}
 
@@ -423,7 +423,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -435,37 +435,37 @@ 
 	 * @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();
 			$config = $context->getConfig();
 
-			$products = $this->getProductList( $view );
+			$products = $this->getProductList($view);
 
-			$text = (string) $view->param( 'f_search' );
-			$catid = (string) $view->param( 'f_catid' );
+			$text = (string) $view->param('f_search');
+			$catid = (string) $view->param('f_catid');
 
-			if( $catid == '' ) {
-				$catid = $config->get( 'client/html/catalog/lists/catid-default', '' );
+			if ($catid == '') {
+				$catid = $config->get('client/html/catalog/lists/catid-default', '');
 			}
 
-			if( $text === '' && $catid !== '' )
+			if ($text === '' && $catid !== '')
 			{
-				$domains = $config->get( 'client/html/catalog/domains', array( 'media', 'text' ) );
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+				$domains = $config->get('client/html/catalog/domains', array('media', 'text'));
+				$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
 
-				$listCatPath = $controller->getCatalogPath( $catid, $domains );
+				$listCatPath = $controller->getCatalogPath($catid, $domains);
 
-				if( ( $categoryItem = end( $listCatPath ) ) !== false ) {
+				if (($categoryItem = end($listCatPath)) !== false) {
 					$view->listCurrentCatItem = $categoryItem;
 				}
 
 				$view->listCatPath = $listCatPath;
 
-				$this->addMetaItem( $listCatPath, 'catalog', $this->expire, $this->tags );
-				$this->addMetaList( array_keys( $listCatPath ), 'catalog', $this->expire );
+				$this->addMetaItem($listCatPath, 'catalog', $this->expire, $this->tags);
+				$this->addMetaList(array_keys($listCatPath), 'catalog', $this->expire);
 			}
 
 			/** client/html/catalog/lists/stock/enable
@@ -489,29 +489,29 @@ 
 			 * @see client/html/catalog/stock/url/action
 			 * @see client/html/catalog/stock/url/config
 			 */
-			if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true ) {
-				$view->listStockUrl = $this->getStockUrl( $view, array_keys( $products ) );
+			if (!empty($products) && $config->get('client/html/catalog/lists/stock/enable', true) === true) {
+				$view->listStockUrl = $this->getStockUrl($view, array_keys($products));
 			}
 
 
-			$this->addMetaItem( $products, 'product', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $products ), 'product', $this->expire );
+			$this->addMetaItem($products, 'product', $this->expire, $this->tags);
+			$this->addMetaList(array_keys($products), 'product', $this->expire);
 
 			// Delete cache when products are added or deleted even when in "tag-all" mode
 			$this->tags[] = 'product';
 
-			$view->listParams = $this->getClientParams( $view->param() );
-			$view->listPageCurr = $this->getProductListPage( $view );
-			$view->listPageSize = $this->getProductListSize( $view );
-			$view->listProductTotal = $this->getProductListTotal( $view );
-			$view->listProductSort = $view->param( 'f_sort', 'relevance' );
+			$view->listParams = $this->getClientParams($view->param());
+			$view->listPageCurr = $this->getProductListPage($view);
+			$view->listPageSize = $this->getProductListSize($view);
+			$view->listProductTotal = $this->getProductListTotal($view);
+			$view->listProductSort = $view->param('f_sort', 'relevance');
 			$view->listProductItems = $products;
 
 			$this->cache = $view;
 		}
 
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
+		$expire = $this->expires($this->expire, $expire);
+		$tags = array_merge($tags, $this->tags);
 
 		return $this->cache;
 	}
@@ -524,7 +524,7 @@ 
 	 * @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)
 	{
 		/** client/html/catalog/stock/url/target
 		 * Destination of the URL where the controller specified in the URL is known
@@ -540,7 +540,7 @@ 
 		 * @see client/html/catalog/stock/url/action
 		 * @see client/html/catalog/stock/url/config
 		 */
-		$stockTarget = $view->config( 'client/html/catalog/stock/url/target' );
+		$stockTarget = $view->config('client/html/catalog/stock/url/target');
 
 		/** client/html/catalog/stock/url/controller
 		 * Name of the controller whose action should be called
@@ -556,7 +556,7 @@ 
 		 * @see client/html/catalog/stock/url/action
 		 * @see client/html/catalog/stock/url/config
 		*/
-		$stockController = $view->config( 'client/html/catalog/stock/url/controller', 'catalog' );
+		$stockController = $view->config('client/html/catalog/stock/url/controller', 'catalog');
 
 		/** client/html/catalog/stock/url/action
 		 * Name of the action that should create the output
@@ -572,7 +572,7 @@ 
 		 * @see client/html/catalog/stock/url/controller
 		 * @see client/html/catalog/stock/url/config
 		*/
-		$stockAction = $view->config( 'client/html/catalog/stock/url/action', 'stock' );
+		$stockAction = $view->config('client/html/catalog/stock/url/action', 'stock');
 
 		/** client/html/catalog/stock/url/config
 		 * Associative list of configuration options used for generating the URL
@@ -595,11 +595,11 @@ 
 		 * @see client/html/catalog/stock/url/action
 		 * @see client/html/url/config
 		*/
-		$stockConfig = $view->config( 'client/html/catalog/stock/url/config', array() );
+		$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);
 	}
 }

Doc Comments +1 added lines, -1 removed lines

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

Braces +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/Lists/Promo/Standard.php

Indentation +310 added lines, -310 removed lines

@@ -19,315 +19,315 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/lists/promo/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog list promo section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/lists/promo/standard/subparts';
-	private $subPartNames = array();
-	private $tags = array();
-	private $expire;
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->promoBody = $html;
-
-		/** client/html/catalog/lists/promo/standard/template-body
-		 * Relative path to the HTML body template of the catalog list promotion client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/lists/promo/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/lists/promo/standard/template-body';
-		$default = 'catalog/lists/promo-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->promoHeader = $html;
-
-		/** client/html/catalog/lists/promo/standard/template-header
-		 * Relative path to the HTML header template of the catalog list promotion client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/lists/promo/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/lists/promo/standard/template-header';
-		$default = 'catalog/lists/promo-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/lists/promo/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog list promo html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/lists/promo/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/promo/decorators/global
-		 * @see client/html/catalog/lists/promo/decorators/local
-		 */
-
-		/** client/html/catalog/lists/promo/decorators/global
-		 * Adds a list of globally available decorators only to the catalog list promo html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/lists/promo/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/promo/decorators/excludes
-		 * @see client/html/catalog/lists/promo/decorators/local
-		 */
-
-		/** client/html/catalog/lists/promo/decorators/local
-		 * Adds a list of local decorators only to the catalog list promo html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/lists/promo/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/lists/promo/decorators/excludes
-		 * @see client/html/catalog/lists/promo/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/lists/promo/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$products = array();
-			$context = $this->getContext();
-			$config = $context->getConfig();
-
-			if( isset( $view->listCurrentCatItem ) ) {
-				$catId = $view->listCurrentCatItem->getId();
-			} else {
-				$catId = $config->get( 'client/html/catalog/lists/catid-default', '' );
-			}
-
-			if( $catId != '' )
-			{
-				/** client/html/catalog/lists/promo/size
-				 * The maximum number of products that should be shown in the promotion section
-				 *
-				 * Each product list can render a list of promoted products on
-				 * top if there are any products associated to that category whose
-				 * list type is "promotion". This option limits the maximum number
-				 * of products that are displayed. It takes only effect if more
-				 * promotional products are added to this category than the set
-				 * value.
-				 *
-				 * @param integer Number of promotion products
-				 * @since 2014.03
-				 * @category User
-				 * @category Developer
-				 */
-				$size = $config->get( 'client/html/catalog/lists/promo/size', 6 );
-				$domains = $config->get( 'client/html/catalog/lists/domains', array( 'media', 'price', 'text' ) );
-
-				$total = null;
-
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-				$filter = $controller->createIndexFilterCategory( $catId, 'relevance', '+', 0, $size, 'promotion' );
-				$products = $controller->getIndexItems( $filter, $domains, $total );
-			}
-
-
-			if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true )
-			{
-				$stockTarget = $config->get( 'client/html/catalog/stock/url/target' );
-				$stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' );
-				$stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' );
-				$stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() );
-
-				$productIds = array_keys( $products );
-				sort( $productIds );
-
-				$params = array( 's_prodid' => implode( ' ', $productIds ) );
-				$view->promoStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
-			}
-
-
-			$this->addMetaItem( $products, 'product', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $products ), 'product', $this->expire );
-
-
-			$view->promoItems = $products;
-
-			$this->cache = $view;
-		}
-
-		$expire = $this->expires( $this->expire, $expire );
-		$tags = array_merge( $tags, $this->tags );
-
-		return $this->cache;
-	}
+    /** client/html/catalog/lists/promo/standard/subparts
+     * List of HTML sub-clients rendered within the catalog list promo section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/lists/promo/standard/subparts';
+    private $subPartNames = array();
+    private $tags = array();
+    private $expire;
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->promoBody = $html;
+
+        /** client/html/catalog/lists/promo/standard/template-body
+         * Relative path to the HTML body template of the catalog list promotion client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/lists/promo/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/lists/promo/standard/template-body';
+        $default = 'catalog/lists/promo-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->promoHeader = $html;
+
+        /** client/html/catalog/lists/promo/standard/template-header
+         * Relative path to the HTML header template of the catalog list promotion client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/lists/promo/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/lists/promo/standard/template-header';
+        $default = 'catalog/lists/promo-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/lists/promo/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog list promo html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/lists/promo/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/promo/decorators/global
+         * @see client/html/catalog/lists/promo/decorators/local
+         */
+
+        /** client/html/catalog/lists/promo/decorators/global
+         * Adds a list of globally available decorators only to the catalog list promo html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/lists/promo/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/promo/decorators/excludes
+         * @see client/html/catalog/lists/promo/decorators/local
+         */
+
+        /** client/html/catalog/lists/promo/decorators/local
+         * Adds a list of local decorators only to the catalog list promo html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/lists/promo/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/lists/promo/decorators/excludes
+         * @see client/html/catalog/lists/promo/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/lists/promo/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $products = array();
+            $context = $this->getContext();
+            $config = $context->getConfig();
+
+            if( isset( $view->listCurrentCatItem ) ) {
+                $catId = $view->listCurrentCatItem->getId();
+            } else {
+                $catId = $config->get( 'client/html/catalog/lists/catid-default', '' );
+            }
+
+            if( $catId != '' )
+            {
+                /** client/html/catalog/lists/promo/size
+                 * The maximum number of products that should be shown in the promotion section
+                 *
+                 * Each product list can render a list of promoted products on
+                 * top if there are any products associated to that category whose
+                 * list type is "promotion". This option limits the maximum number
+                 * of products that are displayed. It takes only effect if more
+                 * promotional products are added to this category than the set
+                 * value.
+                 *
+                 * @param integer Number of promotion products
+                 * @since 2014.03
+                 * @category User
+                 * @category Developer
+                 */
+                $size = $config->get( 'client/html/catalog/lists/promo/size', 6 );
+                $domains = $config->get( 'client/html/catalog/lists/domains', array( 'media', 'price', 'text' ) );
+
+                $total = null;
+
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+                $filter = $controller->createIndexFilterCategory( $catId, 'relevance', '+', 0, $size, 'promotion' );
+                $products = $controller->getIndexItems( $filter, $domains, $total );
+            }
+
+
+            if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true )
+            {
+                $stockTarget = $config->get( 'client/html/catalog/stock/url/target' );
+                $stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' );
+                $stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' );
+                $stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() );
+
+                $productIds = array_keys( $products );
+                sort( $productIds );
+
+                $params = array( 's_prodid' => implode( ' ', $productIds ) );
+                $view->promoStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
+            }
+
+
+            $this->addMetaItem( $products, 'product', $this->expire, $this->tags );
+            $this->addMetaList( array_keys( $products ), 'product', $this->expire );
+
+
+            $view->promoItems = $products;
+
+            $this->cache = $view;
+        }
+
+        $expire = $this->expires( $this->expire, $expire );
+        $tags = array_merge( $tags, $this->tags );
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +36 added lines, -36 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->promoBody = $html;
 
@@ -103,7 +103,7 @@ 
 		$tplconf = 'client/html/catalog/lists/promo/standard/template-body';
 		$default = 'catalog/lists/promo-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->promoHeader = $html;
 
@@ -149,7 +149,7 @@ 
 		$tplconf = 'client/html/catalog/lists/promo/standard/template-header';
 		$default = 'catalog/lists/promo-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/promo/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog list promo html client
@@ -236,7 +236,7 @@ 
 		 * @see client/html/catalog/lists/promo/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/lists/promo/' . $type, $name );
+		return $this->createSubClient('catalog/lists/promo/'.$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,21 +259,21 @@ 
 	 * @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))
 		{
 			$products = array();
 			$context = $this->getContext();
 			$config = $context->getConfig();
 
-			if( isset( $view->listCurrentCatItem ) ) {
+			if (isset($view->listCurrentCatItem)) {
 				$catId = $view->listCurrentCatItem->getId();
 			} else {
-				$catId = $config->get( 'client/html/catalog/lists/catid-default', '' );
+				$catId = $config->get('client/html/catalog/lists/catid-default', '');
 			}
 
-			if( $catId != '' )
+			if ($catId != '')
 			{
 				/** client/html/catalog/lists/promo/size
 				 * The maximum number of products that should be shown in the promotion section
@@ -290,34 +290,34 @@ 
 				 * @category User
 				 * @category Developer
 				 */
-				$size = $config->get( 'client/html/catalog/lists/promo/size', 6 );
-				$domains = $config->get( 'client/html/catalog/lists/domains', array( 'media', 'price', 'text' ) );
+				$size = $config->get('client/html/catalog/lists/promo/size', 6);
+				$domains = $config->get('client/html/catalog/lists/domains', array('media', 'price', 'text'));
 
 				$total = null;
 
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-				$filter = $controller->createIndexFilterCategory( $catId, 'relevance', '+', 0, $size, 'promotion' );
-				$products = $controller->getIndexItems( $filter, $domains, $total );
+				$controller = \Aimeos\Controller\Frontend\Factory::createController($context, 'catalog');
+				$filter = $controller->createIndexFilterCategory($catId, 'relevance', '+', 0, $size, 'promotion');
+				$products = $controller->getIndexItems($filter, $domains, $total);
 			}
 
 
-			if( !empty( $products ) && $config->get( 'client/html/catalog/lists/stock/enable', true ) === true )
+			if (!empty($products) && $config->get('client/html/catalog/lists/stock/enable', true) === true)
 			{
-				$stockTarget = $config->get( 'client/html/catalog/stock/url/target' );
-				$stockController = $config->get( 'client/html/catalog/stock/url/controller', 'catalog' );
-				$stockAction = $config->get( 'client/html/catalog/stock/url/action', 'stock' );
-				$stockConfig = $config->get( 'client/html/catalog/stock/url/config', array() );
+				$stockTarget = $config->get('client/html/catalog/stock/url/target');
+				$stockController = $config->get('client/html/catalog/stock/url/controller', 'catalog');
+				$stockAction = $config->get('client/html/catalog/stock/url/action', 'stock');
+				$stockConfig = $config->get('client/html/catalog/stock/url/config', array());
 
-				$productIds = array_keys( $products );
-				sort( $productIds );
+				$productIds = array_keys($products);
+				sort($productIds);
 
-				$params = array( 's_prodid' => implode( ' ', $productIds ) );
-				$view->promoStockUrl = $view->url( $stockTarget, $stockController, $stockAction, $params, array(), $stockConfig );
+				$params = array('s_prodid' => implode(' ', $productIds));
+				$view->promoStockUrl = $view->url($stockTarget, $stockController, $stockAction, $params, array(), $stockConfig);
 			}
 
 
-			$this->addMetaItem( $products, 'product', $this->expire, $this->tags );
-			$this->addMetaList( array_keys( $products ), 'product', $this->expire );
+			$this->addMetaItem($products, 'product', $this->expire, $this->tags);
+			$this->addMetaList(array_keys($products), 'product', $this->expire);
 
 
 			$view->promoItems = $products;
@@ -325,8 +325,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;
 	}

Doc Comments +1 added lines, -1 removed lines

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

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

Indentation +239 added lines, -239 removed lines

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

Spacing +19 added lines, -19 removed lines

@@ -69,13 +69,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->pagiBody = $html;
 
@@ -102,7 +102,7 @@ 
 		$tplconf = 'client/html/catalog/lists/pagination/standard/template-body';
 		$default = 'catalog/lists/pagination-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -114,19 +114,19 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
 		// output header only once
-		if( $this->header !== null ) {
+		if ($this->header !== null) {
 			return '';
 		}
 
 		$this->header = true;
-		$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->pagiHeader = $html;
 
@@ -154,7 +154,7 @@ 
 		$tplconf = 'client/html/catalog/lists/pagination/standard/template-header';
 		$default = 'catalog/lists/pagination-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -165,7 +165,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/pagination/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog list pagination html client
@@ -241,7 +241,7 @@ 
 		 * @see client/html/catalog/lists/pagination/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/lists/pagination/' . $type, $name );
+		return $this->createSubClient('catalog/lists/pagination/'.$type, $name);
 	}
 
 
@@ -252,7 +252,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -264,17 +264,17 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
 			$total = $view->listProductTotal;
 			$current = $view->listPageCurr;
-			$last = ( $total != 0 ? ceil( $total / $view->listPageSize ) : 1 );
+			$last = ($total != 0 ? ceil($total / $view->listPageSize) : 1);
 
 			$view->pagiPageFirst = 1;
-			$view->pagiPagePrev = ( $current > 1 ? $current - 1 : 1 );
-			$view->pagiPageNext = ( $current < $last ? $current + 1 : $last );
+			$view->pagiPagePrev = ($current > 1 ? $current - 1 : 1);
+			$view->pagiPageNext = ($current < $last ? $current + 1 : $last);
 			$view->pagiPageLast = $last;
 
 			$this->cache = $view;

Doc Comments +1 added lines, -1 removed lines

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

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

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

Doc Comments +1 added lines, -1 removed lines

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

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

Indentation +234 added lines, -234 removed lines

@@ -19,260 +19,260 @@
  * @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/quote/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog list quote 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/quote/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
+    /** client/html/catalog/lists/quote/standard/subparts
+     * List of HTML sub-clients rendered within the catalog list quote 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/quote/standard/subparts';
+    private $subPartNames = array();
+    private $cache;
 
 
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
 
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->quoteBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->quoteBody = $html;
 
-		/** client/html/catalog/lists/quote/standard/template-body
-		 * Relative path to the HTML body template of the catalog list quote 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/quote/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/lists/quote/standard/template-body';
-		$default = 'catalog/lists/quote-body-default.php';
+        /** client/html/catalog/lists/quote/standard/template-body
+         * Relative path to the HTML body template of the catalog list quote 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/quote/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/lists/quote/standard/template-body';
+        $default = 'catalog/lists/quote-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
 
 
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
 
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->quoteHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->quoteHeader = $html;
 
-		/** client/html/catalog/lists/quote/standard/template-header
-		 * Relative path to the HTML header template of the catalog list quote 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/quote/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/lists/quote/standard/template-header';
-		$default = 'catalog/lists/quote-header-default.php';
+        /** client/html/catalog/lists/quote/standard/template-header
+         * Relative path to the HTML header template of the catalog list quote 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/quote/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/lists/quote/standard/template-header';
+        $default = 'catalog/lists/quote-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
 
 
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/lists/quote/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog list quote 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/quote/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/quote/decorators/global
-		 * @see client/html/catalog/lists/quote/decorators/local
-		 */
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/lists/quote/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog list quote 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/quote/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/quote/decorators/global
+         * @see client/html/catalog/lists/quote/decorators/local
+         */
 
-		/** client/html/catalog/lists/quote/decorators/global
-		 * Adds a list of globally available decorators only to the catalog list quote 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/quote/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/quote/decorators/excludes
-		 * @see client/html/catalog/lists/quote/decorators/local
-		 */
+        /** client/html/catalog/lists/quote/decorators/global
+         * Adds a list of globally available decorators only to the catalog list quote 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/quote/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/quote/decorators/excludes
+         * @see client/html/catalog/lists/quote/decorators/local
+         */
 
-		/** client/html/catalog/lists/quote/decorators/local
-		 * Adds a list of local decorators only to the catalog list quote 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/quote/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/quote/decorators/excludes
-		 * @see client/html/catalog/lists/quote/decorators/global
-		 */
+        /** client/html/catalog/lists/quote/decorators/local
+         * Adds a list of local decorators only to the catalog list quote 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/quote/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/quote/decorators/excludes
+         * @see client/html/catalog/lists/quote/decorators/global
+         */
 
-		return $this->createSubClient( 'catalog/lists/quote/' . $type, $name );
-	}
+        return $this->createSubClient( 'catalog/lists/quote/' . $type, $name );
+    }
 
 
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 
 
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$view->quoteItems = array();
-			if( isset( $view->listCatPath ) )
-			{
-				$catPath = $view->listCatPath;
-				if( ( $catItem = end( $catPath ) ) !== false ) {
-					$view->quoteItems = $catItem->getRefItems( 'text', 'quote', 'default' );
-				}
-			}
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $view->quoteItems = array();
+            if( isset( $view->listCatPath ) )
+            {
+                $catPath = $view->listCatPath;
+                if( ( $catItem = end( $catPath ) ) !== false ) {
+                    $view->quoteItems = $catItem->getRefItems( 'text', 'quote', 'default' );
+                }
+            }
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +18 added lines, -18 removed lines

@@ -68,13 +68,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->quoteBody = $html;
 
@@ -101,7 +101,7 @@ 
 		$tplconf = 'client/html/catalog/lists/quote/standard/template-body';
 		$default = 'catalog/lists/quote-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -113,13 +113,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->quoteHeader = $html;
 
@@ -147,7 +147,7 @@ 
 		$tplconf = 'client/html/catalog/lists/quote/standard/template-header';
 		$default = 'catalog/lists/quote-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -158,7 +158,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/quote/decorators/excludes
 		 * Excludes decorators added by the "common" option from the catalog list quote html client
@@ -234,7 +234,7 @@ 
 		 * @see client/html/catalog/lists/quote/decorators/global
 		 */
 
-		return $this->createSubClient( 'catalog/lists/quote/' . $type, $name );
+		return $this->createSubClient('catalog/lists/quote/'.$type, $name);
 	}
 
 
@@ -245,7 +245,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -257,16 +257,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))
 		{
 			$view->quoteItems = array();
-			if( isset( $view->listCatPath ) )
+			if (isset($view->listCatPath))
 			{
 				$catPath = $view->listCatPath;
-				if( ( $catItem = end( $catPath ) ) !== false ) {
-					$view->quoteItems = $catItem->getRefItems( 'text', 'quote', 'default' );
+				if (($catItem = end($catPath)) !== false) {
+					$view->quoteItems = $catItem->getRefItems('text', 'quote', 'default');
 				}
 			}
 

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 )
 	{