aimeos / ai-client-html

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

Indentation +443 added lines, -443 removed lines

@@ -19,448 +19,448 @@
  * @subpackage Html
  */
 abstract class Base
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
 {
-	private $controller;
-	private $productList;
-	private $productTotal = 0;
-
-
-	/**
-	 * Adds the conditions for the selected attributes to the given search filter.
-	 *
-	 * @param array $params Associative list of parameters that should be used for filtering
-	 * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching
-	 */
-	protected function addAttributeFilterByParam( array $params, \Aimeos\MW\Criteria\Iface $filter )
-	{
-		$attrids = ( isset( $params['f_attrid'] ) ? (array) $params['f_attrid'] : array() );
-
-		if( !empty( $attrids ) )
-		{
-			$func = $filter->createFunction( 'index.attributeaggregate', array( array_keys( $attrids ) ) );
-			$expr = array(
-				$filter->getConditions(),
-				$filter->compare( '==', $func, count( $attrids ) ),
-			);
-			$filter->setConditions( $filter->combine( '&&', $expr ) );
-		}
-	}
-
-
-	/**
-	 * Adds the conditions for the selected attributes to the given search filter.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching
-	 */
-	protected function addAttributeFilter( \Aimeos\MW\View\Iface $view, \Aimeos\MW\Criteria\Iface $filter )
-	{
-		$this->addAttributeFilterByParam( $view->param(), $filter );
-	}
-
-
-	/**
-	 * Creates the filter from the given parameters for the product list.
-	 *
-	 * @param string $text Text to search for
-	 * @param string $catid Category ID to search for
-	 * @param string $sort Sortation string (relevance, name, price)
-	 * @param string $sortdir Sortation direction (+ or -)
-	 * @param integer $page Page number starting from 1
-	 * @param integer $size Page size
-	 * @param boolean $catfilter True to include catalog criteria in product filter, false if not
-	 * @param boolean $textfilter True to include text criteria in product filter, false if not
-	 * @return \Aimeos\MW\Criteria\Iface Search criteria object
-	 */
-	protected function createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter )
-	{
-		$controller = $this->getCatalogController();
-
-		if( $text !== '' && $textfilter === true )
-		{
-			$filter = $controller->createIndexFilterText( $text, $sort, $sortdir, ( $page - 1 ) * $size, $size );
-
-			if( $catid !== '' && $catfilter === true ) {
-				$filter = $controller->addIndexFilterCategory( $filter, $this->getCatalogIds( $catid ) );
-			}
-
-			return $filter;
-		}
-		elseif( $catid !== '' && $catfilter === true )
-		{
-			$catIds = $this->getCatalogIds( $catid );
-			return $controller->createIndexFilterCategory( $catIds, $sort, $sortdir, ( $page - 1 ) * $size, $size );
-		}
-		else
-		{
-			return $controller->createIndexFilter( $sort, $sortdir, ( $page - 1 ) * $size, $size );
-		}
-	}
-
-
-	/**
-	 * Returns the catalog controller object
-	 *
-	 * @return \Aimeos\Controller\Frontend\Catalog\Interface Catalog controller
-	 */
-	protected function getCatalogController()
-	{
-		if( !isset( $this->controller ) )
-		{
-			$context = $this->getContext();
-			$this->controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-		}
-
-		return $this->controller;
-	}
-
-
-	/**
-	 * Returns the list of catetory IDs if subcategories should be included
-	 *
-	 * @param string $catId Category ID
-	 * @return string|array Cateogory ID or list of catetory IDs
-	 */
-	protected function getCatalogIds( $catId )
-	{
-		$config = $this->getContext()->getConfig();
-		$default = \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE;
-
-		/** client/html/catalog/lists/levels
-		 * Include products of sub-categories in the product list of the current category
-		 *
-		 * Sometimes it may be useful to show products of sub-categories in the
-		 * current category product list, e.g. if the current category contains
-		 * no products at all or if there are only a few products in all categories.
-		 *
-		 * Possible constant values for this setting are:
-		 * * 1 : Only products from the current category
-		 * * 2 : Products from the current category and the direct child categories
-		 * * 3 : Products from the current category and the whole category sub-tree
-		 *
-		 * Caution: Please keep in mind that displaying products of sub-categories
-		 * can slow down your shop, especially if it contains more than a few
-		 * products! You have no real control over the positions of the products
-		 * in the result list too because all products from different categories
-		 * with the same position value are placed randomly.
-		 *
-		 * Usually, a better way is to associate products to all categories they
-		 * should be listed in. This can be done manually if there are only a few
-		 * ones or during the product import automatically.
-		 *
-		 * @param integer Tree level constant
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/catalog/lists/catid-default
-		 * @see client/html/catalog/lists/domains
-		 * @see client/html/catalog/lists/size
-		 */
-		$level = $config->get( 'client/html/catalog/lists/levels', $default );
-
-		if( $level != $default )
-		{
-			$tree = $this->getCatalogController()->getCatalogTree( $catId, array(), $level );
-			$catId = $this->getCatalogIdsFromTree( $tree );
-		}
-
-		return $catId;
-	}
-
-
-	/**
-	 * Returns the list of catalog IDs for the given catalog tree
-	 *
-	 * @param \Aimeos\MShop\Catalog\Item\Iface $item Catalog item with children
-	 * @return array List of catalog IDs
-	 */
-	protected function getCatalogIdsFromTree( \Aimeos\MShop\Catalog\Item\Iface $item )
-	{
-		$list = array( $item->getId() );
-
-		foreach( $item->getChildren() as $child ) {
-			$list = array_merge( $list, $this->getCatalogIdsFromTree( $child ) );
-		}
-
-		return $list;
-	}
-
-
-	/**
-	 * Returns the products found for the current parameters.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return array List of products implementing \Aimeos\MShop\Product\Item\Iface
-	 */
-	protected function getProductList( \Aimeos\MW\View\Iface $view )
-	{
-		if( $this->productList === null ) {
-			$this->searchProducts( $view );
-		}
-
-		return $this->productList;
-	}
-
-
-	/**
-	 * Returns the filter from the given parameters for the product list.
-	 *
-	 * @param array $params Associative list of parameters that should be used for filtering
-	 * @param boolean $catfilter True to include catalog criteria in product filter, false if not
-	 * @param boolean $textfilter True to include text criteria in product filter, false if not
-	 * @param boolean $attrfilter True to include attribute criteria in product filter, false if not
-	 * @return \Aimeos\MW\Criteria\Iface Search criteria object
-	 */
-	protected function getProductListFilterByParam( array $params, $catfilter = true, $textfilter = true, $attrfilter = true )
-	{
-		$sortdir = '+';
-		$context = $this->getContext();
-		$config = $context->getConfig();
-
-		$text = ( isset( $params['f_search'] ) ? (string) $params['f_search'] : '' );
-		$catid = ( isset( $params['f_catid'] ) ? (string) $params['f_catid'] : '' );
-
-		if( $catid == '' && $catfilter === true )
-		{
-			/** client/html/catalog/lists/catid-default
-			 * The default category ID used if none is given as parameter
-			 *
-			 * If users view a product list page without a category ID in the
-			 * parameter list, the first found products are displayed with a
-			 * random order. You can circumvent this by configuring a default
-			 * category ID that should be used in this case (the ID of the root
-			 * category is best for this). In most cases you can set this value
-			 * via the administration interface of the shop application.
-			 *
-			 * @param string Category ID
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/lists/size
-			 * @see client/html/catalog/lists/domains
-			 * @see client/html/catalog/lists/levels
-			 * @see client/html/catalog/detail/prodid-default
-			 */
-			$catid = $config->get( 'client/html/catalog/lists/catid-default', '' );
-		}
-
-		$page = $this->getProductListPageByParam( $params );
-		$size = $this->getProductListSizeByParam( $params );
-		$sort = $this->getProductListSortByParam( $params, $sortdir );
-
-		$filter = $this->createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter );
-
-		if( $attrfilter === true ) {
-			$this->addAttributeFilterByParam( $params, $filter );
-		}
-
-
-		return $filter;
-	}
-
-
-	/**
-	 * Returns the filter created from the view parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @param boolean $catfilter True to include catalog criteria in product filter, false if not
-	 * @param boolean $textfilter True to include text criteria in product filter, false if not
-	 * @param boolean $attrfilter True to include attribute criteria in product filter, false if not
-	 * @return \Aimeos\MW\Criteria\Iface Search criteria object
-	 */
-	protected function getProductListFilter( \Aimeos\MW\View\Iface $view, $catfilter = true, $textfilter = true, $attrfilter = true )
-	{
-		return $this->getProductListFilterByParam( $view->param(), $catfilter, $textfilter, $attrfilter );
-	}
-
-
-	/**
-	 * Returns the total number of products available for the current parameters.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return integer Total number of products
-	 */
-	protected function getProductListTotal( \Aimeos\MW\View\Iface $view )
-	{
-		if( $this->productList === null ) {
-			$this->searchProducts( $view );
-		}
-
-		return $this->productTotal;
-	}
-
-
-	/**
-	 * Returns the sanitized page from the parameters for the product list.
-	 *
-	 * @param array $params Associative list of parameters that should be used for filtering
-	 * @return integer Page number starting from 1
-	 */
-	protected function getProductListPageByParam( array $params )
-	{
-		return ( isset( $params['l_page'] ) && $params['l_page'] > 0 ? (int) $params['l_page'] : 1 );
-	}
-
-
-	/**
-	 * Returns the sanitized page from the parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return integer Page number starting from 1
-	 */
-	protected function getProductListPage( \Aimeos\MW\View\Iface $view )
-	{
-		return $this->getProductListPageByParam( $view->param() );
-	}
-
-
-	/**
-	 * Returns the sanitized page size from the parameters for the product list.
-	 *
-	 * @param array $params Associative list of parameters that should be used for filtering
-	 * @return integer Page size
-	 */
-	protected function getProductListSizeByParam( array $params )
-	{
-		/** client/html/catalog/lists/size
-		 * The number of products shown in a list page
-		 *
-		 * Limits the number of products that is shown in the list pages to the
-		 * given value. If more products are available, the products are split
-		 * into bunches which will be shown on their own list page. The user is
-		 * able to move to the next page (or previous one if it's not the first)
-		 * to display the next (or previous) products.
-		 *
-		 * The value must be an integer number from 1 to 100. Negative values as
-		 * well as values above 100 are not allowed. The value can be overwritten
-		 * per request if the "l_size" parameter is part of the URL.
-		 *
-		 * @param integer Number of products
-		 * @since 2014.03
-		 * @category User
-		 * @category Developer
-		 * @see client/html/catalog/lists/catid-default
-		 * @see client/html/catalog/lists/domains
-		 * @see client/html/catalog/lists/levels
-		 */
-		$defaultSize = $this->getContext()->getConfig()->get( 'client/html/catalog/lists/size', 48 );
-
-		$size = ( isset( $params['l_size'] ) ? (int) $params['l_size'] : $defaultSize );
-		return ( $size < 1 || $size > 100 ? $defaultSize : $size );
-	}
-
-
-	/**
-	 * Returns the sanitized page size from the parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return integer Page size
-	 */
-	protected function getProductListSize( \Aimeos\MW\View\Iface $view )
-	{
-		return $this->getProductListSizeByParam( $view->param() );
-	}
-
-
-	/**
-	 * Returns the sanitized sortation from the parameters for the product list.
-	 *
-	 * @param array $params Associative list of parameters that should be used for filtering
-	 * @param string &$sortdir Value-result parameter where the sort direction will be stored
-	 * @return string Sortation string (relevance, name, price)
-	 */
-	protected function getProductListSortByParam( array $params, &$sortdir )
-	{
-		$sortation = ( isset( $params['f_sort'] ) ? (string) $params['f_sort'] : 'relevance' );
-
-		$sortdir = ( $sortation[0] === '-' ? '-' : '+' );
-		$sort = ltrim( $sortation, '-' );
-
-		return ( strlen( $sort ) > 0 ? $sort : 'relevance' );
-	}
-
-
-	/**
-	 * Returns the sanitized sortation from the parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @param string &$sortdir Value-result parameter where the sort direction will be stored
-	 * @return string Sortation string (relevance, name, price)
-	 */
-	protected function getProductListSort( \Aimeos\MW\View\Iface $view, &$sortdir )
-	{
-		return $this->getProductListSortByParam( $view->param(), $sortdir );
-	}
-
-
-	/**
-	 * Searches for the products based on the current paramters.
-	 *
-	 * The found products and the total number of available products can be
-	 * retrieved using the getProductList() and getProductTotal() methods.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 */
-	protected function searchProducts( \Aimeos\MW\View\Iface $view )
-	{
-		$context = $this->getContext();
-		$config = $context->getConfig();
-
-		/** client/html/catalog/domains
-		 * A list of domain names whose items should be available in the catalog view templates
-		 *
-		 * The templates rendering catalog related data usually add the images and
-		 * texts associated to each item. If you want to display additional
-		 * content like the attributes, you can configure your own list of
-		 * domains (attribute, media, price, product, text, etc. are domains)
-		 * whose items are fetched from the storage. Please keep in mind that
-		 * the more domains you add to the configuration, the more time is required
-		 * for fetching the content!
-		 *
-		 * This configuration option can be overwritten by the "client/html/catalog/lists/domains"
-		 * configuration option that allows to configure the domain names of the
-		 * items fetched specifically for all types of product listings.
-		 *
-		 * @param array List of domain names
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/lists/domains
-		 * @see client/html/catalog/lists/catid-default
-		 * @see client/html/catalog/lists/size
-		 * @see client/html/catalog/lists/levels
-		 */
-		$domains = $config->get( 'client/html/catalog/domains', array( 'media', 'price', 'text' ) );
-
-		/** client/html/catalog/lists/domains
-		 * A list of domain names whose items should be available in the product list view template
-		 *
-		 * The templates rendering product lists usually add the images, prices
-		 * and texts associated to each product item. If you want to display additional
-		 * content like the product attributes, you can configure your own list of
-		 * domains (attribute, media, price, product, text, etc. are domains)
-		 * whose items are fetched from the storage. Please keep in mind that
-		 * the more domains you add to the configuration, the more time is required
-		 * for fetching the content!
-		 *
-		 * This configuration option 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/stage/domains
-		 * @see client/html/catalog/lists/catid-default
-		 * @see client/html/catalog/lists/size
-		 * @see client/html/catalog/lists/levels
-		 */
-		$domains = $config->get( 'client/html/catalog/lists/domains', $domains );
-
-		$controller = $this->getCatalogController();
-		$productFilter = $this->getProductListFilter( $view );
-
-		$this->productList = $controller->getIndexItems( $productFilter, $domains, $this->productTotal );
-	}
+    private $controller;
+    private $productList;
+    private $productTotal = 0;
+
+
+    /**
+     * Adds the conditions for the selected attributes to the given search filter.
+     *
+     * @param array $params Associative list of parameters that should be used for filtering
+     * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching
+     */
+    protected function addAttributeFilterByParam( array $params, \Aimeos\MW\Criteria\Iface $filter )
+    {
+        $attrids = ( isset( $params['f_attrid'] ) ? (array) $params['f_attrid'] : array() );
+
+        if( !empty( $attrids ) )
+        {
+            $func = $filter->createFunction( 'index.attributeaggregate', array( array_keys( $attrids ) ) );
+            $expr = array(
+                $filter->getConditions(),
+                $filter->compare( '==', $func, count( $attrids ) ),
+            );
+            $filter->setConditions( $filter->combine( '&&', $expr ) );
+        }
+    }
+
+
+    /**
+     * Adds the conditions for the selected attributes to the given search filter.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @param \Aimeos\MW\Criteria\Iface $filter Criteria object for searching
+     */
+    protected function addAttributeFilter( \Aimeos\MW\View\Iface $view, \Aimeos\MW\Criteria\Iface $filter )
+    {
+        $this->addAttributeFilterByParam( $view->param(), $filter );
+    }
+
+
+    /**
+     * Creates the filter from the given parameters for the product list.
+     *
+     * @param string $text Text to search for
+     * @param string $catid Category ID to search for
+     * @param string $sort Sortation string (relevance, name, price)
+     * @param string $sortdir Sortation direction (+ or -)
+     * @param integer $page Page number starting from 1
+     * @param integer $size Page size
+     * @param boolean $catfilter True to include catalog criteria in product filter, false if not
+     * @param boolean $textfilter True to include text criteria in product filter, false if not
+     * @return \Aimeos\MW\Criteria\Iface Search criteria object
+     */
+    protected function createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter )
+    {
+        $controller = $this->getCatalogController();
+
+        if( $text !== '' && $textfilter === true )
+        {
+            $filter = $controller->createIndexFilterText( $text, $sort, $sortdir, ( $page - 1 ) * $size, $size );
+
+            if( $catid !== '' && $catfilter === true ) {
+                $filter = $controller->addIndexFilterCategory( $filter, $this->getCatalogIds( $catid ) );
+            }
+
+            return $filter;
+        }
+        elseif( $catid !== '' && $catfilter === true )
+        {
+            $catIds = $this->getCatalogIds( $catid );
+            return $controller->createIndexFilterCategory( $catIds, $sort, $sortdir, ( $page - 1 ) * $size, $size );
+        }
+        else
+        {
+            return $controller->createIndexFilter( $sort, $sortdir, ( $page - 1 ) * $size, $size );
+        }
+    }
+
+
+    /**
+     * Returns the catalog controller object
+     *
+     * @return \Aimeos\Controller\Frontend\Catalog\Interface Catalog controller
+     */
+    protected function getCatalogController()
+    {
+        if( !isset( $this->controller ) )
+        {
+            $context = $this->getContext();
+            $this->controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+        }
+
+        return $this->controller;
+    }
+
+
+    /**
+     * Returns the list of catetory IDs if subcategories should be included
+     *
+     * @param string $catId Category ID
+     * @return string|array Cateogory ID or list of catetory IDs
+     */
+    protected function getCatalogIds( $catId )
+    {
+        $config = $this->getContext()->getConfig();
+        $default = \Aimeos\MW\Tree\Manager\Base::LEVEL_ONE;
+
+        /** client/html/catalog/lists/levels
+         * Include products of sub-categories in the product list of the current category
+         *
+         * Sometimes it may be useful to show products of sub-categories in the
+         * current category product list, e.g. if the current category contains
+         * no products at all or if there are only a few products in all categories.
+         *
+         * Possible constant values for this setting are:
+         * * 1 : Only products from the current category
+         * * 2 : Products from the current category and the direct child categories
+         * * 3 : Products from the current category and the whole category sub-tree
+         *
+         * Caution: Please keep in mind that displaying products of sub-categories
+         * can slow down your shop, especially if it contains more than a few
+         * products! You have no real control over the positions of the products
+         * in the result list too because all products from different categories
+         * with the same position value are placed randomly.
+         *
+         * Usually, a better way is to associate products to all categories they
+         * should be listed in. This can be done manually if there are only a few
+         * ones or during the product import automatically.
+         *
+         * @param integer Tree level constant
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/catalog/lists/catid-default
+         * @see client/html/catalog/lists/domains
+         * @see client/html/catalog/lists/size
+         */
+        $level = $config->get( 'client/html/catalog/lists/levels', $default );
+
+        if( $level != $default )
+        {
+            $tree = $this->getCatalogController()->getCatalogTree( $catId, array(), $level );
+            $catId = $this->getCatalogIdsFromTree( $tree );
+        }
+
+        return $catId;
+    }
+
+
+    /**
+     * Returns the list of catalog IDs for the given catalog tree
+     *
+     * @param \Aimeos\MShop\Catalog\Item\Iface $item Catalog item with children
+     * @return array List of catalog IDs
+     */
+    protected function getCatalogIdsFromTree( \Aimeos\MShop\Catalog\Item\Iface $item )
+    {
+        $list = array( $item->getId() );
+
+        foreach( $item->getChildren() as $child ) {
+            $list = array_merge( $list, $this->getCatalogIdsFromTree( $child ) );
+        }
+
+        return $list;
+    }
+
+
+    /**
+     * Returns the products found for the current parameters.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return array List of products implementing \Aimeos\MShop\Product\Item\Iface
+     */
+    protected function getProductList( \Aimeos\MW\View\Iface $view )
+    {
+        if( $this->productList === null ) {
+            $this->searchProducts( $view );
+        }
+
+        return $this->productList;
+    }
+
+
+    /**
+     * Returns the filter from the given parameters for the product list.
+     *
+     * @param array $params Associative list of parameters that should be used for filtering
+     * @param boolean $catfilter True to include catalog criteria in product filter, false if not
+     * @param boolean $textfilter True to include text criteria in product filter, false if not
+     * @param boolean $attrfilter True to include attribute criteria in product filter, false if not
+     * @return \Aimeos\MW\Criteria\Iface Search criteria object
+     */
+    protected function getProductListFilterByParam( array $params, $catfilter = true, $textfilter = true, $attrfilter = true )
+    {
+        $sortdir = '+';
+        $context = $this->getContext();
+        $config = $context->getConfig();
+
+        $text = ( isset( $params['f_search'] ) ? (string) $params['f_search'] : '' );
+        $catid = ( isset( $params['f_catid'] ) ? (string) $params['f_catid'] : '' );
+
+        if( $catid == '' && $catfilter === true )
+        {
+            /** client/html/catalog/lists/catid-default
+             * The default category ID used if none is given as parameter
+             *
+             * If users view a product list page without a category ID in the
+             * parameter list, the first found products are displayed with a
+             * random order. You can circumvent this by configuring a default
+             * category ID that should be used in this case (the ID of the root
+             * category is best for this). In most cases you can set this value
+             * via the administration interface of the shop application.
+             *
+             * @param string Category ID
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/lists/size
+             * @see client/html/catalog/lists/domains
+             * @see client/html/catalog/lists/levels
+             * @see client/html/catalog/detail/prodid-default
+             */
+            $catid = $config->get( 'client/html/catalog/lists/catid-default', '' );
+        }
+
+        $page = $this->getProductListPageByParam( $params );
+        $size = $this->getProductListSizeByParam( $params );
+        $sort = $this->getProductListSortByParam( $params, $sortdir );
+
+        $filter = $this->createProductListFilter( $text, $catid, $sort, $sortdir, $page, $size, $catfilter, $textfilter );
+
+        if( $attrfilter === true ) {
+            $this->addAttributeFilterByParam( $params, $filter );
+        }
+
+
+        return $filter;
+    }
+
+
+    /**
+     * Returns the filter created from the view parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @param boolean $catfilter True to include catalog criteria in product filter, false if not
+     * @param boolean $textfilter True to include text criteria in product filter, false if not
+     * @param boolean $attrfilter True to include attribute criteria in product filter, false if not
+     * @return \Aimeos\MW\Criteria\Iface Search criteria object
+     */
+    protected function getProductListFilter( \Aimeos\MW\View\Iface $view, $catfilter = true, $textfilter = true, $attrfilter = true )
+    {
+        return $this->getProductListFilterByParam( $view->param(), $catfilter, $textfilter, $attrfilter );
+    }
+
+
+    /**
+     * Returns the total number of products available for the current parameters.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return integer Total number of products
+     */
+    protected function getProductListTotal( \Aimeos\MW\View\Iface $view )
+    {
+        if( $this->productList === null ) {
+            $this->searchProducts( $view );
+        }
+
+        return $this->productTotal;
+    }
+
+
+    /**
+     * Returns the sanitized page from the parameters for the product list.
+     *
+     * @param array $params Associative list of parameters that should be used for filtering
+     * @return integer Page number starting from 1
+     */
+    protected function getProductListPageByParam( array $params )
+    {
+        return ( isset( $params['l_page'] ) && $params['l_page'] > 0 ? (int) $params['l_page'] : 1 );
+    }
+
+
+    /**
+     * Returns the sanitized page from the parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return integer Page number starting from 1
+     */
+    protected function getProductListPage( \Aimeos\MW\View\Iface $view )
+    {
+        return $this->getProductListPageByParam( $view->param() );
+    }
+
+
+    /**
+     * Returns the sanitized page size from the parameters for the product list.
+     *
+     * @param array $params Associative list of parameters that should be used for filtering
+     * @return integer Page size
+     */
+    protected function getProductListSizeByParam( array $params )
+    {
+        /** client/html/catalog/lists/size
+         * The number of products shown in a list page
+         *
+         * Limits the number of products that is shown in the list pages to the
+         * given value. If more products are available, the products are split
+         * into bunches which will be shown on their own list page. The user is
+         * able to move to the next page (or previous one if it's not the first)
+         * to display the next (or previous) products.
+         *
+         * The value must be an integer number from 1 to 100. Negative values as
+         * well as values above 100 are not allowed. The value can be overwritten
+         * per request if the "l_size" parameter is part of the URL.
+         *
+         * @param integer Number of products
+         * @since 2014.03
+         * @category User
+         * @category Developer
+         * @see client/html/catalog/lists/catid-default
+         * @see client/html/catalog/lists/domains
+         * @see client/html/catalog/lists/levels
+         */
+        $defaultSize = $this->getContext()->getConfig()->get( 'client/html/catalog/lists/size', 48 );
+
+        $size = ( isset( $params['l_size'] ) ? (int) $params['l_size'] : $defaultSize );
+        return ( $size < 1 || $size > 100 ? $defaultSize : $size );
+    }
+
+
+    /**
+     * Returns the sanitized page size from the parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return integer Page size
+     */
+    protected function getProductListSize( \Aimeos\MW\View\Iface $view )
+    {
+        return $this->getProductListSizeByParam( $view->param() );
+    }
+
+
+    /**
+     * Returns the sanitized sortation from the parameters for the product list.
+     *
+     * @param array $params Associative list of parameters that should be used for filtering
+     * @param string &$sortdir Value-result parameter where the sort direction will be stored
+     * @return string Sortation string (relevance, name, price)
+     */
+    protected function getProductListSortByParam( array $params, &$sortdir )
+    {
+        $sortation = ( isset( $params['f_sort'] ) ? (string) $params['f_sort'] : 'relevance' );
+
+        $sortdir = ( $sortation[0] === '-' ? '-' : '+' );
+        $sort = ltrim( $sortation, '-' );
+
+        return ( strlen( $sort ) > 0 ? $sort : 'relevance' );
+    }
+
+
+    /**
+     * Returns the sanitized sortation from the parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @param string &$sortdir Value-result parameter where the sort direction will be stored
+     * @return string Sortation string (relevance, name, price)
+     */
+    protected function getProductListSort( \Aimeos\MW\View\Iface $view, &$sortdir )
+    {
+        return $this->getProductListSortByParam( $view->param(), $sortdir );
+    }
+
+
+    /**
+     * Searches for the products based on the current paramters.
+     *
+     * The found products and the total number of available products can be
+     * retrieved using the getProductList() and getProductTotal() methods.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     */
+    protected function searchProducts( \Aimeos\MW\View\Iface $view )
+    {
+        $context = $this->getContext();
+        $config = $context->getConfig();
+
+        /** client/html/catalog/domains
+         * A list of domain names whose items should be available in the catalog view templates
+         *
+         * The templates rendering catalog related data usually add the images and
+         * texts associated to each item. If you want to display additional
+         * content like the attributes, you can configure your own list of
+         * domains (attribute, media, price, product, text, etc. are domains)
+         * whose items are fetched from the storage. Please keep in mind that
+         * the more domains you add to the configuration, the more time is required
+         * for fetching the content!
+         *
+         * This configuration option can be overwritten by the "client/html/catalog/lists/domains"
+         * configuration option that allows to configure the domain names of the
+         * items fetched specifically for all types of product listings.
+         *
+         * @param array List of domain names
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/lists/domains
+         * @see client/html/catalog/lists/catid-default
+         * @see client/html/catalog/lists/size
+         * @see client/html/catalog/lists/levels
+         */
+        $domains = $config->get( 'client/html/catalog/domains', array( 'media', 'price', 'text' ) );
+
+        /** client/html/catalog/lists/domains
+         * A list of domain names whose items should be available in the product list view template
+         *
+         * The templates rendering product lists usually add the images, prices
+         * and texts associated to each product item. If you want to display additional
+         * content like the product attributes, you can configure your own list of
+         * domains (attribute, media, price, product, text, etc. are domains)
+         * whose items are fetched from the storage. Please keep in mind that
+         * the more domains you add to the configuration, the more time is required
+         * for fetching the content!
+         *
+         * This configuration option 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/stage/domains
+         * @see client/html/catalog/lists/catid-default
+         * @see client/html/catalog/lists/size
+         * @see client/html/catalog/lists/levels
+         */
+        $domains = $config->get( 'client/html/catalog/lists/domains', $domains );
+
+        $controller = $this->getCatalogController();
+        $productFilter = $this->getProductListFilter( $view );
+
+        $this->productList = $controller->getIndexItems( $productFilter, $domains, $this->productTotal );
+    }
 }

client/html/src/Client/Html/Catalog/Session/Pinned/Standard.php

Indentation +401 added lines, -401 removed lines

@@ -19,406 +19,406 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/catalog/session/pinned/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog session pinned 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/session/pinned/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$session = $context->getSession();
-
-		/** client/html/catalog/session/pinned
-		 * All parameters defined for the catalog session pinned subpart
-		 *
-		 * This returns all settings related to the catalog session pinned subpart.
-		 * Please refer to the single settings for details.
-		 *
-		 * @param array Associative list of name/value settings
-		 * @category Developer
-		 * @see client/html/catalog/session#pinned
-		 */
-		$config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() );
-		$key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-body', $config );
-
-		if( ( $html = $session->get( $key ) ) === null )
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$output = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->pinnedBody = $output;
-
-			/** client/html/catalog/session/pinned/standard/template-body
-			 * Relative path to the HTML body template of the catalog session pinned 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/session/pinned/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/session/pinned/standard/template-body';
-			$default = 'catalog/session/pinned-body-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true );
-			$session->set( 'aimeos/catalog/session/pinned/cache', $cached );
-			$session->set( $key, $html );
-		}
-
-		return $html;
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$session = $context->getSession();
-
-		$config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() );
-		$key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-header', $config );
-
-		if( ( $html = $session->get( $key ) ) === null )
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$output = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->pinnedHeader = $output;
-
-			/** client/html/catalog/session/pinned/standard/template-header
-			 * Relative path to the HTML header template of the catalog session pinned 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/session/pinned/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/session/pinned/standard/template-header';
-			$default = 'catalog/session/pinned-header-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true );
-			$session->set( 'aimeos/catalog/session/pinned/cache', $cached );
-			$session->set( $key, $html );
-		}
-
-		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/session/pinned/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog session pinned 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/session/pinned/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/session/pinned/decorators/global
-		 * @see client/html/catalog/session/pinned/decorators/local
-		 */
-
-		/** client/html/catalog/session/pinned/decorators/global
-		 * Adds a list of globally available decorators only to the catalog session pinned 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/session/pinned/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/session/pinned/decorators/excludes
-		 * @see client/html/catalog/session/pinned/decorators/local
-		 */
-
-		/** client/html/catalog/session/pinned/decorators/local
-		 * Adds a list of local decorators only to the catalog session pinned 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/session/pinned/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/session/pinned/decorators/excludes
-		 * @see client/html/catalog/session/pinned/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/session/pinned/' . $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()
-	{
-		$refresh = false;
-		$view = $this->getView();
-		$context = $this->getContext();
-		$session = $context->getSession();
-		$pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() );
-
-		switch( $view->param( 'pin_action' ) )
-		{
-			case 'add':
-
-				foreach( (array) $view->param( 'pin_id', array() ) as $id ) {
-					$pinned[$id] = $id;
-				}
-
-				/** client/html/catalog/session/pinned/standard/maxitems
-				 * Maximum number of products displayed in the "pinned" section
-				 *
-				 * This option limits the number of products that are shown in the
-				 * "pinned" section after the users added the product to their list
-				 * of pinned products. It must be a positive integer value greater
-				 * than 0.
-				 *
-				 * Note: The higher the value is the more data has to be transfered
-				 * to the client each time the user loads a page with the list of
-				 * pinned products.
-				 *
-				 * @param integer Number of products
-				 * @since 2014.09
-				 * @category User
-				 * @category Developer
-				 */
-				$max = $context->getConfig()->get( 'client/html/catalog/session/pinned/standard/maxitems', 50 );
-
-				$pinned = array_slice( $pinned, -$max, $max, true );
-				$refresh = true;
-				break;
-
-			case 'delete':
-
-				foreach( (array) $view->param( 'pin_id', array() ) as $id ) {
-					unset( $pinned[$id] );
-				}
-
-				$refresh = true;
-				break;
-		}
-
-
-		if( $refresh )
-		{
-			$session->set( 'aimeos/catalog/session/pinned/list', $pinned );
-
-			foreach( $session->get( 'aimeos/catalog/session/pinned/cache', array() ) as $key => $value ) {
-				$session->set( $key, null );
-			}
-		}
-
-		parent::process();
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * 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 ) )
-		{
-			$expire = null;
-			$tags = $items = array();
-			$context = $this->getContext();
-			$config = $context->getConfig();
-			$session = $context->getSession();
-
-			$default = array( 'media', 'price', 'text' );
-			$domains = $config->get( 'client/html/catalog/domains', $default );
-
-			/** client/html/catalog/session/pinned/domains
-			 * A list of domain names whose items should be available in the pinned view template for the product
-			 *
-			 * The templates rendering product details usually add the images,
-			 * prices and texts, etc. associated to the product
-			 * item. If you want to display additional or less content, you can
-			 * configure your own list of domains (attribute, media, price, product,
-			 * text, etc. are domains) whose items are fetched from the storage.
-			 * Please keep in mind that the more domains you add to the configuration,
-			 * the more time is required for fetching the content!
-			 *
-			 * From 2014.09 to 2015.03, this setting was available as
-			 * client/html/catalog/detail/pinned/domains
-			 *
-			 * @param array List of domain names
-			 * @since 2015.04
-			 * @category Developer
-			 * @see client/html/catalog/domains
-			 * @see client/html/catalog/lists/domains
-			 * @see client/html/catalog/detail/domains
-			 */
-			$domains = $config->get( 'client/html/catalog/session/pinned/domains', $domains );
-
-			$pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() );
-
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-			$result = $controller->getProductItems( $pinned, $domains );
-
-			foreach( array_reverse( $pinned ) as $id )
-			{
-				if( isset( $result[$id] ) ) {
-					$items[$id] = $result[$id];
-				}
-			}
-
-			$view->pinnedProductItems = $items;
-			$view->pinnedParams = $this->getClientParams( $view->param() );
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/catalog/session/pinned/standard/subparts
+     * List of HTML sub-clients rendered within the catalog session pinned 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/session/pinned/standard/subparts';
+    private $subPartNames = array();
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $session = $context->getSession();
+
+        /** client/html/catalog/session/pinned
+         * All parameters defined for the catalog session pinned subpart
+         *
+         * This returns all settings related to the catalog session pinned subpart.
+         * Please refer to the single settings for details.
+         *
+         * @param array Associative list of name/value settings
+         * @category Developer
+         * @see client/html/catalog/session#pinned
+         */
+        $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() );
+        $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-body', $config );
+
+        if( ( $html = $session->get( $key ) ) === null )
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $output = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->pinnedBody = $output;
+
+            /** client/html/catalog/session/pinned/standard/template-body
+             * Relative path to the HTML body template of the catalog session pinned 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/session/pinned/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/session/pinned/standard/template-body';
+            $default = 'catalog/session/pinned-body-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true );
+            $session->set( 'aimeos/catalog/session/pinned/cache', $cached );
+            $session->set( $key, $html );
+        }
+
+        return $html;
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $session = $context->getSession();
+
+        $config = $context->getConfig()->get( 'client/html/catalog/session/pinned', array() );
+        $key = $this->getParamHash( array(), $uid . ':catalog:session-pinned-header', $config );
+
+        if( ( $html = $session->get( $key ) ) === null )
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $output = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->pinnedHeader = $output;
+
+            /** client/html/catalog/session/pinned/standard/template-header
+             * Relative path to the HTML header template of the catalog session pinned 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/session/pinned/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/session/pinned/standard/template-header';
+            $default = 'catalog/session/pinned-header-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $cached = $session->get( 'aimeos/catalog/session/pinned/cache', array() ) + array( $key => true );
+            $session->set( 'aimeos/catalog/session/pinned/cache', $cached );
+            $session->set( $key, $html );
+        }
+
+        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/session/pinned/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog session pinned 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/session/pinned/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/session/pinned/decorators/global
+         * @see client/html/catalog/session/pinned/decorators/local
+         */
+
+        /** client/html/catalog/session/pinned/decorators/global
+         * Adds a list of globally available decorators only to the catalog session pinned 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/session/pinned/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/session/pinned/decorators/excludes
+         * @see client/html/catalog/session/pinned/decorators/local
+         */
+
+        /** client/html/catalog/session/pinned/decorators/local
+         * Adds a list of local decorators only to the catalog session pinned 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/session/pinned/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/session/pinned/decorators/excludes
+         * @see client/html/catalog/session/pinned/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/session/pinned/' . $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()
+    {
+        $refresh = false;
+        $view = $this->getView();
+        $context = $this->getContext();
+        $session = $context->getSession();
+        $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() );
+
+        switch( $view->param( 'pin_action' ) )
+        {
+            case 'add':
+
+                foreach( (array) $view->param( 'pin_id', array() ) as $id ) {
+                    $pinned[$id] = $id;
+                }
+
+                /** client/html/catalog/session/pinned/standard/maxitems
+                 * Maximum number of products displayed in the "pinned" section
+                 *
+                 * This option limits the number of products that are shown in the
+                 * "pinned" section after the users added the product to their list
+                 * of pinned products. It must be a positive integer value greater
+                 * than 0.
+                 *
+                 * Note: The higher the value is the more data has to be transfered
+                 * to the client each time the user loads a page with the list of
+                 * pinned products.
+                 *
+                 * @param integer Number of products
+                 * @since 2014.09
+                 * @category User
+                 * @category Developer
+                 */
+                $max = $context->getConfig()->get( 'client/html/catalog/session/pinned/standard/maxitems', 50 );
+
+                $pinned = array_slice( $pinned, -$max, $max, true );
+                $refresh = true;
+                break;
+
+            case 'delete':
+
+                foreach( (array) $view->param( 'pin_id', array() ) as $id ) {
+                    unset( $pinned[$id] );
+                }
+
+                $refresh = true;
+                break;
+        }
+
+
+        if( $refresh )
+        {
+            $session->set( 'aimeos/catalog/session/pinned/list', $pinned );
+
+            foreach( $session->get( 'aimeos/catalog/session/pinned/cache', array() ) as $key => $value ) {
+                $session->set( $key, null );
+            }
+        }
+
+        parent::process();
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * 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 ) )
+        {
+            $expire = null;
+            $tags = $items = array();
+            $context = $this->getContext();
+            $config = $context->getConfig();
+            $session = $context->getSession();
+
+            $default = array( 'media', 'price', 'text' );
+            $domains = $config->get( 'client/html/catalog/domains', $default );
+
+            /** client/html/catalog/session/pinned/domains
+             * A list of domain names whose items should be available in the pinned view template for the product
+             *
+             * The templates rendering product details usually add the images,
+             * prices and texts, etc. associated to the product
+             * item. If you want to display additional or less content, you can
+             * configure your own list of domains (attribute, media, price, product,
+             * text, etc. are domains) whose items are fetched from the storage.
+             * Please keep in mind that the more domains you add to the configuration,
+             * the more time is required for fetching the content!
+             *
+             * From 2014.09 to 2015.03, this setting was available as
+             * client/html/catalog/detail/pinned/domains
+             *
+             * @param array List of domain names
+             * @since 2015.04
+             * @category Developer
+             * @see client/html/catalog/domains
+             * @see client/html/catalog/lists/domains
+             * @see client/html/catalog/detail/domains
+             */
+            $domains = $config->get( 'client/html/catalog/session/pinned/domains', $domains );
+
+            $pinned = $session->get( 'aimeos/catalog/session/pinned/list', array() );
+
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+            $result = $controller->getProductItems( $pinned, $domains );
+
+            foreach( array_reverse( $pinned ) as $id )
+            {
+                if( isset( $result[$id] ) ) {
+                    $items[$id] = $result[$id];
+                }
+            }
+
+            $view->pinnedProductItems = $items;
+            $view->pinnedParams = $this->getClientParams( $view->param() );
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

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

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

Indentation +300 added lines, -300 removed lines

@@ -19,329 +19,329 @@
  * @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/session/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog session 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/session/standard/subparts';
+    /** client/html/catalog/session/standard/subparts
+     * List of HTML sub-clients rendered within the catalog session 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/session/standard/subparts';
 
-	/** client/html/catalog/session/pinned/name
-	 * Name of the pinned part used by the catalog session client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Pinned\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.09
-	 * @category Developer
-	 */
+    /** client/html/catalog/session/pinned/name
+     * Name of the pinned part used by the catalog session client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Pinned\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.09
+     * @category Developer
+     */
 
-	/** client/html/catalog/session/seen/name
-	 * Name of the seen part used by the catalog session client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Seen\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'pinned', 'seen' );
+    /** client/html/catalog/session/seen/name
+     * Name of the seen part used by the catalog session client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Session\Seen\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartNames = array( 'pinned', 'seen' );
 
 
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
 
-		try
-		{
-			$view = $this->setViewParams( $view, $tags, $expire );
+        try
+        {
+            $view = $this->setViewParams( $view, $tags, $expire );
 
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->sessionBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->sessionBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', 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->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
+        }
 
-		/** client/html/catalog/session/standard/template-body
-		 * Relative path to the HTML body template of the catalog session 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/session/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/session/standard/template-body';
-		$default = 'catalog/session/body-default.php';
+        /** client/html/catalog/session/standard/template-body
+         * Relative path to the HTML body template of the catalog session 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/session/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/session/standard/template-body';
+        $default = 'catalog/session/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 )
-	{
-		try
-		{
-			$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 )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
 
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->sessionHeader = $html;
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->sessionHeader = $html;
 
-			/** client/html/catalog/session/standard/template-header
-			 * Relative path to the HTML header template of the catalog session 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/session/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/session/standard/template-header';
-			$default = 'catalog/session/header-default.php';
+            /** client/html/catalog/session/standard/template-header
+             * Relative path to the HTML header template of the catalog session 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/session/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/session/standard/template-header';
+            $default = 'catalog/session/header-default.php';
 
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
 
 
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/session/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog session 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/session/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/session/decorators/global
-		 * @see client/html/catalog/session/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/session/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog session 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/session/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/session/decorators/global
+         * @see client/html/catalog/session/decorators/local
+         */
 
-		/** client/html/catalog/session/decorators/global
-		 * Adds a list of globally available decorators only to the catalog session 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/session/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/session/decorators/excludes
-		 * @see client/html/catalog/session/decorators/local
-		 */
+        /** client/html/catalog/session/decorators/global
+         * Adds a list of globally available decorators only to the catalog session 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/session/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/session/decorators/excludes
+         * @see client/html/catalog/session/decorators/local
+         */
 
-		/** client/html/catalog/session/decorators/local
-		 * Adds a list of local decorators only to the catalog session 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/session/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/session/decorators/excludes
-		 * @see client/html/catalog/session/decorators/global
-		 */
+        /** client/html/catalog/session/decorators/local
+         * Adds a list of local decorators only to the catalog session 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/session/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/session/decorators/excludes
+         * @see client/html/catalog/session/decorators/global
+         */
 
-		return $this->createSubClient( 'catalog/session/' . $type, $name );
-	}
+        return $this->createSubClient( 'catalog/session/' . $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()
-	{
-		try
-		{
-			parent::process();
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$view = $this->getView();
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$view = $this->getView();
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$view = $this->getView();
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context = $this->getContext();
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+    /**
+     * 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()
+    {
+        try
+        {
+            parent::process();
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $view = $this->getView();
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $view = $this->getView();
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $view = $this->getView();
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
+        }
+        catch( \Exception $e )
+        {
+            $context = $this->getContext();
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
 
-			$view = $this->getView();
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->sessionErrorList = $view->get( 'sessionErrorList', array() ) + $error;
-		}
-	}
+            $view = $this->getView();
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->sessionErrorList = $view->get( 'sessionErrorList', 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 );
-	}
+    /**
+     * 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/src/Client/Html/Catalog/Session/Seen/Standard.php

Indentation +291 added lines, -291 removed lines

@@ -19,296 +19,296 @@
  * @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/session/seen/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog session seen 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/session/seen/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$session = $context->getSession();
-
-		/** client/html/catalog/session/seen
-		 * All parameters defined for the catalog session seen subpart
-		 *
-		 * This returns all settings related to the catalog session seen subpart.
-		 * Please refer to the single settings for details.
-		 *
-		 * @param array Associative list of name/value settings
-		 * @category Developer
-		 * @see client/html/catalog#session
-		 */
-		$config = $context->getConfig()->get( 'client/html/catalog/session/seen', array() );
-		$key = $this->getParamHash( array(), $uid . ':catalog:session-seen-body', $config );
-
-		if( ( $html = $session->get( $key ) ) === null )
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$output = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->seenBody = $output;
-
-			/** client/html/catalog/session/seen/standard/template-body
-			 * Relative path to the HTML body template of the catalog session seen 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/session/seen/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/session/seen/standard/template-body';
-			$default = 'catalog/session/seen-body-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$cached = $session->get( 'aimeos/catalog/session/seen/cache', array() ) + array( $key => true );
-			$session->set( 'aimeos/catalog/session/seen/cache', $cached );
-			$session->set( $key, $html );
-		}
-
-		return $html;
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$session = $context->getSession();
-
-		$config = $context->getConfig()->get( 'client/html/catalog/session/seen', array() );
-		$key = $this->getParamHash( array(), $uid . ':catalog:session-seen-header', $config );
-
-		if( ( $html = $session->get( $key ) ) === null )
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$output = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->seenHeader = $output;
-
-			/** client/html/catalog/session/seen/standard/template-header
-			 * Relative path to the HTML header template of the catalog session seen 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/session/seen/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/session/seen/standard/template-header';
-			$default = 'catalog/session/seen-header-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$cached = $session->get( 'aimeos/catalog/session/seen/cache', array() ) + array( $key => true );
-			$session->set( 'aimeos/catalog/session/seen/cache', $cached );
-			$session->set( $key, $html );
-		}
-
-		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/session/seen/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog session seen 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/session/seen/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/session/seen/decorators/global
-		 * @see client/html/catalog/session/seen/decorators/local
-		 */
-
-		/** client/html/catalog/session/seen/decorators/global
-		 * Adds a list of globally available decorators only to the catalog session seen 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/session/seen/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/session/seen/decorators/excludes
-		 * @see client/html/catalog/session/seen/decorators/local
-		 */
-
-		/** client/html/catalog/session/seen/decorators/local
-		 * Adds a list of local decorators only to the catalog session seen 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/session/seen/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/session/seen/decorators/excludes
-		 * @see client/html/catalog/session/seen/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/session/seen/' . $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 ) )
-		{
-			$session = $this->getContext()->getSession();
-			$lastSeen = $session->get( 'aimeos/catalog/session/seen/list', array() );
-
-			$view->seenItems = array_reverse( $lastSeen );
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/catalog/session/seen/standard/subparts
+     * List of HTML sub-clients rendered within the catalog session seen 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/session/seen/standard/subparts';
+    private $subPartNames = array();
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $session = $context->getSession();
+
+        /** client/html/catalog/session/seen
+         * All parameters defined for the catalog session seen subpart
+         *
+         * This returns all settings related to the catalog session seen subpart.
+         * Please refer to the single settings for details.
+         *
+         * @param array Associative list of name/value settings
+         * @category Developer
+         * @see client/html/catalog#session
+         */
+        $config = $context->getConfig()->get( 'client/html/catalog/session/seen', array() );
+        $key = $this->getParamHash( array(), $uid . ':catalog:session-seen-body', $config );
+
+        if( ( $html = $session->get( $key ) ) === null )
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $output = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $output .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->seenBody = $output;
+
+            /** client/html/catalog/session/seen/standard/template-body
+             * Relative path to the HTML body template of the catalog session seen 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/session/seen/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/session/seen/standard/template-body';
+            $default = 'catalog/session/seen-body-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $cached = $session->get( 'aimeos/catalog/session/seen/cache', array() ) + array( $key => true );
+            $session->set( 'aimeos/catalog/session/seen/cache', $cached );
+            $session->set( $key, $html );
+        }
+
+        return $html;
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $session = $context->getSession();
+
+        $config = $context->getConfig()->get( 'client/html/catalog/session/seen', array() );
+        $key = $this->getParamHash( array(), $uid . ':catalog:session-seen-header', $config );
+
+        if( ( $html = $session->get( $key ) ) === null )
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $output = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $output .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->seenHeader = $output;
+
+            /** client/html/catalog/session/seen/standard/template-header
+             * Relative path to the HTML header template of the catalog session seen 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/session/seen/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/session/seen/standard/template-header';
+            $default = 'catalog/session/seen-header-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $cached = $session->get( 'aimeos/catalog/session/seen/cache', array() ) + array( $key => true );
+            $session->set( 'aimeos/catalog/session/seen/cache', $cached );
+            $session->set( $key, $html );
+        }
+
+        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/session/seen/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog session seen 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/session/seen/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/session/seen/decorators/global
+         * @see client/html/catalog/session/seen/decorators/local
+         */
+
+        /** client/html/catalog/session/seen/decorators/global
+         * Adds a list of globally available decorators only to the catalog session seen 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/session/seen/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/session/seen/decorators/excludes
+         * @see client/html/catalog/session/seen/decorators/local
+         */
+
+        /** client/html/catalog/session/seen/decorators/local
+         * Adds a list of local decorators only to the catalog session seen 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/session/seen/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/session/seen/decorators/excludes
+         * @see client/html/catalog/session/seen/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/session/seen/' . $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 ) )
+        {
+            $session = $this->getContext()->getSession();
+            $lastSeen = $session->get( 'aimeos/catalog/session/seen/list', array() );
+
+            $view->seenItems = array_reverse( $lastSeen );
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

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

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

Indentation +349 added lines, -349 removed lines

@@ -19,358 +19,358 @@
  * @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/stock/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog stock 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/stock/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 )
-	{
-		try
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->stockBody = $html;
-
-			/** client/html/catalog/stock/standard/template-body
-			 * Relative path to the HTML body template of the catalog stock 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/stock/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/stock/standard/template-body';
-			$default = 'catalog/stock/body-default.php';
-
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		try
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->stockHeader = $html;
-
-			/** client/html/catalog/stock/standard/template-header
-			 * Relative path to the HTML header template of the catalog stock 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/stock/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/stock/standard/template-header';
-			$default = 'catalog/stock/header-default.php';
-
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/stock/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog stock 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/stock/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/stock/decorators/global
-		 * @see client/html/catalog/stock/decorators/local
-		 */
-
-		/** client/html/catalog/stock/decorators/global
-		 * Adds a list of globally available decorators only to the catalog stock 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/stock/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/stock/decorators/excludes
-		 * @see client/html/catalog/stock/decorators/local
-		 */
-
-		/** client/html/catalog/stock/decorators/local
-		 * Adds a list of local decorators only to the catalog stock 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/stock/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/stock/decorators/excludes
-		 * @see client/html/catalog/stock/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/stock/' . $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()
-	{
-		try
-		{
-			parent::process();
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
-
-
-	/**
-	 * 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();
-			$siteConfig = $context->getLocale()->getSite()->getConfig();
-
-			/** client/html/catalog/stock/sort
-			 * Sortation key if stock levels for different warehouses exist
-			 *
-			 * Products can be shipped from several warehouses with a different
-			 * stock level for each one. The stock levels for each warehouse will
-			 * be shown in the product detail page. To get a consistent sortation
-			 * of this list, the configured key of the product warehouse manager
-			 * will be used.
-			 *
-			 * @param string Key for sorting
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/stock/level/low
-			 */
-			$sortkey = $context->getConfig()->get( 'client/html/catalog/stock/sort', 'product.stock.warehouseid' );
-			$productIds = $view->param( 's_prodid' );
-
-			if( !is_array( $productIds ) ) {
-				$productIds = explode( ' ', $productIds );
-			}
-
-
-			$stockManager = \Aimeos\MShop\Factory::createManager( $context, 'product/stock' );
-
-			$search = $stockManager->createSearch( true );
-			$expr = array( $search->compare( '==', 'product.stock.parentid', $productIds ) );
-
-			if( isset( $siteConfig['warehouse'] ) ) {
-				$expr[] = $search->compare( '==', 'product.stock.warehouse.code', $siteConfig['warehouse'] );
-			}
-
-			$expr[] = $search->getConditions();
-
-			$sortations = array(
-				$search->sort( '+', 'product.stock.parentid' ),
-				$search->sort( '+', $sortkey ),
-			);
-
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( $sortations );
-			$search->setSlice( 0, 0x7fffffff );
-
-			$stockItems = $stockManager->searchItems( $search );
-
-
-			if( !empty( $stockItems ) )
-			{
-				$warehouseIds = $stockItemsByProducts = array();
-
-				foreach( $stockItems as $item )
-				{
-					$warehouseIds[$item->getWarehouseId()] = null;
-					$stockItemsByProducts[$item->getParentId()][] = $item;
-				}
-
-				$warehouseIds = array_keys( $warehouseIds );
-
-
-				$warehouseManager = \Aimeos\MShop\Factory::createManager( $context, 'product/stock/warehouse' );
-
-				$search = $warehouseManager->createSearch();
-				$search->setConditions( $search->compare( '==', 'product.stock.warehouse.id', $warehouseIds ) );
-				$search->setSlice( 0, count( $warehouseIds ) );
-
-
-				$view->stockWarehouseItems = $warehouseManager->searchItems( $search );
-				$view->stockItemsByProducts = $stockItemsByProducts;
-			}
+    /** client/html/catalog/stock/standard/subparts
+     * List of HTML sub-clients rendered within the catalog stock 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/stock/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 )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->stockBody = $html;
+
+            /** client/html/catalog/stock/standard/template-body
+             * Relative path to the HTML body template of the catalog stock 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/stock/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/stock/standard/template-body';
+            $default = 'catalog/stock/body-default.php';
+
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->stockHeader = $html;
+
+            /** client/html/catalog/stock/standard/template-header
+             * Relative path to the HTML header template of the catalog stock 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/stock/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/stock/standard/template-header';
+            $default = 'catalog/stock/header-default.php';
+
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/stock/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog stock 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/stock/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/stock/decorators/global
+         * @see client/html/catalog/stock/decorators/local
+         */
+
+        /** client/html/catalog/stock/decorators/global
+         * Adds a list of globally available decorators only to the catalog stock 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/stock/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/stock/decorators/excludes
+         * @see client/html/catalog/stock/decorators/local
+         */
+
+        /** client/html/catalog/stock/decorators/local
+         * Adds a list of local decorators only to the catalog stock 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/stock/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/stock/decorators/excludes
+         * @see client/html/catalog/stock/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/stock/' . $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()
+    {
+        try
+        {
+            parent::process();
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
+
+
+    /**
+     * 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();
+            $siteConfig = $context->getLocale()->getSite()->getConfig();
+
+            /** client/html/catalog/stock/sort
+             * Sortation key if stock levels for different warehouses exist
+             *
+             * Products can be shipped from several warehouses with a different
+             * stock level for each one. The stock levels for each warehouse will
+             * be shown in the product detail page. To get a consistent sortation
+             * of this list, the configured key of the product warehouse manager
+             * will be used.
+             *
+             * @param string Key for sorting
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/stock/level/low
+             */
+            $sortkey = $context->getConfig()->get( 'client/html/catalog/stock/sort', 'product.stock.warehouseid' );
+            $productIds = $view->param( 's_prodid' );
+
+            if( !is_array( $productIds ) ) {
+                $productIds = explode( ' ', $productIds );
+            }
+
+
+            $stockManager = \Aimeos\MShop\Factory::createManager( $context, 'product/stock' );
+
+            $search = $stockManager->createSearch( true );
+            $expr = array( $search->compare( '==', 'product.stock.parentid', $productIds ) );
+
+            if( isset( $siteConfig['warehouse'] ) ) {
+                $expr[] = $search->compare( '==', 'product.stock.warehouse.code', $siteConfig['warehouse'] );
+            }
+
+            $expr[] = $search->getConditions();
+
+            $sortations = array(
+                $search->sort( '+', 'product.stock.parentid' ),
+                $search->sort( '+', $sortkey ),
+            );
+
+            $search->setConditions( $search->combine( '&&', $expr ) );
+            $search->setSortations( $sortations );
+            $search->setSlice( 0, 0x7fffffff );
+
+            $stockItems = $stockManager->searchItems( $search );
+
+
+            if( !empty( $stockItems ) )
+            {
+                $warehouseIds = $stockItemsByProducts = array();
+
+                foreach( $stockItems as $item )
+                {
+                    $warehouseIds[$item->getWarehouseId()] = null;
+                    $stockItemsByProducts[$item->getParentId()][] = $item;
+                }
+
+                $warehouseIds = array_keys( $warehouseIds );
+
+
+                $warehouseManager = \Aimeos\MShop\Factory::createManager( $context, 'product/stock/warehouse' );
+
+                $search = $warehouseManager->createSearch();
+                $search->setConditions( $search->compare( '==', 'product.stock.warehouse.id', $warehouseIds ) );
+                $search->setSlice( 0, count( $warehouseIds ) );
+
+
+                $view->stockWarehouseItems = $warehouseManager->searchItems( $search );
+                $view->stockItemsByProducts = $stockItemsByProducts;
+            }
 
 
-			$view->stockProductIds = $productIds;
+            $view->stockProductIds = $productIds;
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }

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

Indentation +271 added lines, -271 removed lines

@@ -19,299 +19,299 @@
  * @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/count/attribute/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog count attribute section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/count/attribute/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
+    /** client/html/catalog/count/attribute/standard/subparts
+     * List of HTML sub-clients rendered within the catalog count attribute section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/count/attribute/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->attributeBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->attributeBody = $html;
 
-		/** client/html/catalog/count/attribute/standard/template-body
-		 * Relative path to the HTML body template of the catalog count attribute client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/count/attribute/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/count/attribute/standard/template-body';
-		$default = 'catalog/count/attribute-body-default.php';
+        /** client/html/catalog/count/attribute/standard/template-body
+         * Relative path to the HTML body template of the catalog count attribute client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/count/attribute/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/count/attribute/standard/template-body';
+        $default = 'catalog/count/attribute-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->attributeHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->attributeHeader = $html;
 
-		/** client/html/catalog/count/attribute/standard/template-header
-		 * Relative path to the HTML header template of the catalog count attribute client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/count/attribute/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/count/attribute/standard/template-header';
-		$default = 'catalog/count/attribute-header-default.php';
+        /** client/html/catalog/count/attribute/standard/template-header
+         * Relative path to the HTML header template of the catalog count attribute client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/count/attribute/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/count/attribute/standard/template-header';
+        $default = 'catalog/count/attribute-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/count/attribute/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog count attribute html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/count/attribute/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/count/attribute/decorators/global
-		 * @see client/html/catalog/count/attribute/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/count/attribute/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog count attribute html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/count/attribute/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/count/attribute/decorators/global
+         * @see client/html/catalog/count/attribute/decorators/local
+         */
 
-		/** client/html/catalog/count/attribute/decorators/global
-		 * Adds a list of globally available decorators only to the catalog count attribute html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/count/attribute/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/count/attribute/decorators/excludes
-		 * @see client/html/catalog/count/attribute/decorators/local
-		 */
+        /** client/html/catalog/count/attribute/decorators/global
+         * Adds a list of globally available decorators only to the catalog count attribute html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/count/attribute/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/count/attribute/decorators/excludes
+         * @see client/html/catalog/count/attribute/decorators/local
+         */
 
-		/** client/html/catalog/count/attribute/decorators/local
-		 * Adds a list of local decorators only to the catalog count attribute html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/count/attribute/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/count/attribute/decorators/excludes
-		 * @see client/html/catalog/count/attribute/decorators/global
-		 */
+        /** client/html/catalog/count/attribute/decorators/local
+         * Adds a list of local decorators only to the catalog count attribute html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/count/attribute/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/count/attribute/decorators/excludes
+         * @see client/html/catalog/count/attribute/decorators/global
+         */
 
-		return $this->createSubClient( 'catalog/count/attribute/' . $type, $name );
-	}
+        return $this->createSubClient( 'catalog/count/attribute/' . $type, $name );
+    }
 
 
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /**
+     * 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();
+    /**
+     * 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();
 
-			/** client/html/catalog/count/attribute/aggregate
-			 * Enables or disables generating product counts for the attribute catalog filter
-			 *
-			 * This configuration option allows shop owners to enable or disable product counts
-			 * for the attribute section of the catalog filter HTML client.
-			 *
-			 * @param boolean Disabled if "0", enabled if "1"
-			 * @since 2014.03
-			 * @see client/html/catalog/count/limit
-			 * @category Developer
-			 * @category User
-			 */
-			if( $config->get( 'client/html/catalog/count/attribute/aggregate', true ) == true )
-			{
-				/** client/html/catalog/count/limit
-				 * Limits the number of records that are used for product counts in the catalog filter
-				 *
-				 * The product counts in the catalog filter are generated by searching for all
-				 * products that match the criteria and then counting the number of products
-				 * that are available for each attribute or category.
-				 *
-				 * As counting huge amount of records (several 10 000 records) takes a long time,
-				 * the limit can cut down response times so the counts are available more quickly
-				 * in the front-end and the server load is reduced.
-				 *
-				 * Using a low limit can lead to incorrect numbers if the amount of found products
-				 * is very high. Approximate product counts are normally not a problem but it can
-				 * lead to the situation that visitors see that no products are available for
-				 * an attribute or in a category despite the fact that there would be at least
-				 * one.
-				 *
-				 * @param integer Number of records
-				 * @since 2014.03
-				 * @see client/html/catalog/count/attribute/aggregate
-				 * @category Developer
-				 * @category User
-				 */
-				$filter = $this->getProductListFilter( $view );
-				$filter->setSlice( 0, $config->get( 'client/html/catalog/count/limit', 10000 ) );
-				$filter->setSortations( array() ); // it's not necessary and slows down the query
+            /** client/html/catalog/count/attribute/aggregate
+             * Enables or disables generating product counts for the attribute catalog filter
+             *
+             * This configuration option allows shop owners to enable or disable product counts
+             * for the attribute section of the catalog filter HTML client.
+             *
+             * @param boolean Disabled if "0", enabled if "1"
+             * @since 2014.03
+             * @see client/html/catalog/count/limit
+             * @category Developer
+             * @category User
+             */
+            if( $config->get( 'client/html/catalog/count/attribute/aggregate', true ) == true )
+            {
+                /** client/html/catalog/count/limit
+                 * Limits the number of records that are used for product counts in the catalog filter
+                 *
+                 * The product counts in the catalog filter are generated by searching for all
+                 * products that match the criteria and then counting the number of products
+                 * that are available for each attribute or category.
+                 *
+                 * As counting huge amount of records (several 10 000 records) takes a long time,
+                 * the limit can cut down response times so the counts are available more quickly
+                 * in the front-end and the server load is reduced.
+                 *
+                 * Using a low limit can lead to incorrect numbers if the amount of found products
+                 * is very high. Approximate product counts are normally not a problem but it can
+                 * lead to the situation that visitors see that no products are available for
+                 * an attribute or in a category despite the fact that there would be at least
+                 * one.
+                 *
+                 * @param integer Number of records
+                 * @since 2014.03
+                 * @see client/html/catalog/count/attribute/aggregate
+                 * @category Developer
+                 * @category User
+                 */
+                $filter = $this->getProductListFilter( $view );
+                $filter->setSlice( 0, $config->get( 'client/html/catalog/count/limit', 10000 ) );
+                $filter->setSortations( array() ); // it's not necessary and slows down the query
 
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-				$view->attributeCountList = $controller->aggregateIndex( $filter, 'index.attribute.id' );
-			}
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+                $view->attributeCountList = $controller->aggregateIndex( $filter, 'index.attribute.id' );
+            }
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file

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

Indentation +249 added lines, -249 removed lines

@@ -19,277 +19,277 @@
  * @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/count/tree/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog count tree section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/count/tree/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
+    /** client/html/catalog/count/tree/standard/subparts
+     * List of HTML sub-clients rendered within the catalog count tree section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/count/tree/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->treeBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->treeBody = $html;
 
-		/** client/html/catalog/count/tree/standard/template-body
-		 * Relative path to the HTML body template of the catalog count tree client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/count/tree/standard/template-header
-		 */
-		$tplconf = 'client/html/catalog/count/tree/standard/template-body';
-		$default = 'catalog/count/tree-body-default.php';
+        /** client/html/catalog/count/tree/standard/template-body
+         * Relative path to the HTML body template of the catalog count tree client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/count/tree/standard/template-header
+         */
+        $tplconf = 'client/html/catalog/count/tree/standard/template-body';
+        $default = 'catalog/count/tree-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->treeHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->treeHeader = $html;
 
-		/** client/html/catalog/count/tree/standard/template-header
-		 * Relative path to the HTML header template of the catalog count tree client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/catalog/count/tree/standard/template-body
-		 */
-		$tplconf = 'client/html/catalog/count/tree/standard/template-header';
-		$default = 'catalog/count/tree-header-default.php';
+        /** client/html/catalog/count/tree/standard/template-header
+         * Relative path to the HTML header template of the catalog count tree client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/catalog/count/tree/standard/template-body
+         */
+        $tplconf = 'client/html/catalog/count/tree/standard/template-header';
+        $default = 'catalog/count/tree-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/count/tree/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog count tree html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/count/tree/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/count/tree/decorators/global
-		 * @see client/html/catalog/count/tree/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/count/tree/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog count tree html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/count/tree/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/count/tree/decorators/global
+         * @see client/html/catalog/count/tree/decorators/local
+         */
 
-		/** client/html/catalog/count/tree/decorators/global
-		 * Adds a list of globally available decorators only to the catalog count tree html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/count/tree/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/count/tree/decorators/excludes
-		 * @see client/html/catalog/count/tree/decorators/local
-		 */
+        /** client/html/catalog/count/tree/decorators/global
+         * Adds a list of globally available decorators only to the catalog count tree html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/count/tree/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/count/tree/decorators/excludes
+         * @see client/html/catalog/count/tree/decorators/local
+         */
 
-		/** client/html/catalog/count/tree/decorators/local
-		 * Adds a list of local decorators only to the catalog count tree html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/count/tree/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/count/tree/decorators/excludes
-		 * @see client/html/catalog/count/tree/decorators/global
-		 */
+        /** client/html/catalog/count/tree/decorators/local
+         * Adds a list of local decorators only to the catalog count tree html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/count/tree/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/count/tree/decorators/excludes
+         * @see client/html/catalog/count/tree/decorators/global
+         */
 
-		return $this->createSubClient( 'catalog/count/tree/' . $type, $name );
-	}
+        return $this->createSubClient( 'catalog/count/tree/' . $type, $name );
+    }
 
 
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /**
+     * 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();
+    /**
+     * 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();
 
-			/** client/html/catalog/count/tree/aggregate
-			 * Enables or disables generating product counts for the category catalog filter
-			 *
-			 * This configuration option allows shop owners to enable or disable product counts
-			 * for the tree section of the catalog filter HTML client.
-			 *
-			 * @param boolean Disabled if "0", enabled if "1"
-			 * @since 2014.03
-			 * @see client/html/catalog/count/limit
-			 */
-			if( $config->get( 'client/html/catalog/count/tree/aggregate', true ) == true )
-			{
-				/** client/html/catalog/count/limit
-				 * @see client/html/catalog/count/tree/aggregate
-				 */
-				$filter = $this->getProductListFilter( $view, false );
-				$filter->setSlice( 0, $config->get( 'client/html/catalog/count/limit', 10000 ) );
-				$filter->setSortations( array() ); // it's not necessary and slows down the query
+            /** client/html/catalog/count/tree/aggregate
+             * Enables or disables generating product counts for the category catalog filter
+             *
+             * This configuration option allows shop owners to enable or disable product counts
+             * for the tree section of the catalog filter HTML client.
+             *
+             * @param boolean Disabled if "0", enabled if "1"
+             * @since 2014.03
+             * @see client/html/catalog/count/limit
+             */
+            if( $config->get( 'client/html/catalog/count/tree/aggregate', true ) == true )
+            {
+                /** client/html/catalog/count/limit
+                 * @see client/html/catalog/count/tree/aggregate
+                 */
+                $filter = $this->getProductListFilter( $view, false );
+                $filter->setSlice( 0, $config->get( 'client/html/catalog/count/limit', 10000 ) );
+                $filter->setSortations( array() ); // it's not necessary and slows down the query
 
-				$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-				$view->treeCountList = $controller->aggregateIndex( $filter, 'index.catalog.id' );
-			}
+                $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+                $view->treeCountList = $controller->aggregateIndex( $filter, 'index.catalog.id' );
+            }
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }