aimeos / ai-client-html

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

Doc Comments +2 added lines, -2 removed lines

@@ -200,7 +200,7 @@ 
 	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
 	 * @param array &$tags Result array for the list of tags that are associated to the output
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
+	 * @return string String including HTML tags for the header on error
 	 */
 	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
 	{
@@ -393,7 +393,7 @@ 
 	 * Returns the parameters used by the html client.
 	 *
 	 * @param array $params Associative list of all parameters
-	 * @param array $prefixes List of prefixes the parameters must start with
+	 * @param string[] $prefixes List of prefixes the parameters must start with
 	 * @return array Associative list of parameters used by the html client
 	 */
 	protected function getClientParams( array $params, array $prefixes = array( 'f', 'l', 'd', 'a' ) )

Indentation +475 added lines, -475 removed lines

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

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

Doc Comments -1 removed lines

@@ -27,7 +27,6 @@
 	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
 	 * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
 	 * 	and a list of relative paths inside the core or the extension as values
-	 * @param \Aimeos\Client\Html\Iface $client Client object
 	 */
 	public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
 	{

Indentation +14 added lines, -14 removed lines

@@ -18,19 +18,19 @@
  * @subpackage Html
  */
 abstract class Base
-	extends \Aimeos\Client\Html\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/**
-	 * Initializes the object instance
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
-	 * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
-	 * 	and a list of relative paths inside the core or the extension as values
-	 * @param \Aimeos\Client\Html\Iface $client Client object
-	 */
-	public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
-	{
-		parent::__construct( $context, $templatePaths );
-	}
+    /**
+     * Initializes the object instance
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
+     * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
+     * 	and a list of relative paths inside the core or the extension as values
+     * @param \Aimeos\Client\Html\Iface $client Client object
+     */
+    public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
+    {
+        parent::__construct( $context, $templatePaths );
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Locale/Select/Language/Standard.php

Doc Comments +1 added lines, -1 removed lines

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

Indentation +226 added lines, -226 removed lines

@@ -19,253 +19,253 @@
  * @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/locale/select/language/standard/subparts
-	 * List of HTML sub-clients rendered within the locale select language section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.09
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/locale/select/language/standard/subparts';
-	private $subPartNames = array();
+    /** client/html/locale/select/language/standard/subparts
+     * List of HTML sub-clients rendered within the locale select language section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.09
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/locale/select/language/standard/subparts';
+    private $subPartNames = array();
 
 
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+    /**
+     * 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->languageBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->languageBody = $html;
 
-		/** client/html/locale/select/language/standard/template-body
-		 * Relative path to the HTML body template of the locale select language client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.09
-		 * @category Developer
-		 * @see client/html/locale/select/language/standard/template-header
-		 */
-		$tplconf = 'client/html/locale/select/language/standard/template-body';
-		$default = 'locale/select/language-body-default.php';
+        /** client/html/locale/select/language/standard/template-body
+         * Relative path to the HTML body template of the locale select language client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.09
+         * @category Developer
+         * @see client/html/locale/select/language/standard/template-header
+         */
+        $tplconf = 'client/html/locale/select/language/standard/template-body';
+        $default = 'locale/select/language-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->languageHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->languageHeader = $html;
 
-		/** client/html/locale/select/language/standard/template-header
-		 * Relative path to the HTML header template of the locale select language client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2014.09
-		 * @category Developer
-		 * @see client/html/locale/select/language/standard/template-body
-		 */
-		$tplconf = 'client/html/locale/select/language/standard/template-header';
-		$default = 'locale/select/language-header-default.php';
+        /** client/html/locale/select/language/standard/template-header
+         * Relative path to the HTML header template of the locale select language client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2014.09
+         * @category Developer
+         * @see client/html/locale/select/language/standard/template-body
+         */
+        $tplconf = 'client/html/locale/select/language/standard/template-header';
+        $default = 'locale/select/language-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/locale/select/language/decorators/excludes
-		 * Excludes decorators added by the "common" option from the locale select language 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/locale/select/language/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/locale/select/language/decorators/global
-		 * @see client/html/locale/select/language/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/locale/select/language/decorators/excludes
+         * Excludes decorators added by the "common" option from the locale select language 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/locale/select/language/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/locale/select/language/decorators/global
+         * @see client/html/locale/select/language/decorators/local
+         */
 
-		/** client/html/locale/select/language/decorators/global
-		 * Adds a list of globally available decorators only to the locale select language 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/locale/select/language/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/locale/select/language/decorators/excludes
-		 * @see client/html/locale/select/language/decorators/local
-		 */
+        /** client/html/locale/select/language/decorators/global
+         * Adds a list of globally available decorators only to the locale select language 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/locale/select/language/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/locale/select/language/decorators/excludes
+         * @see client/html/locale/select/language/decorators/local
+         */
 
-		/** client/html/locale/select/language/decorators/local
-		 * Adds a list of local decorators only to the locale select language 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\Checkout\Decorator\*") around the html client.
-		 *
-		 *  client/html/locale/select/language/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Checkout\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/locale/select/language/decorators/excludes
-		 * @see client/html/locale/select/language/decorators/global
-		 */
+        /** client/html/locale/select/language/decorators/local
+         * Adds a list of local decorators only to the locale select language 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\Checkout\Decorator\*") around the html client.
+         *
+         *  client/html/locale/select/language/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Checkout\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/locale/select/language/decorators/excludes
+         * @see client/html/locale/select/language/decorators/global
+         */
 
-		return $this->createSubClient( 'locale/select/language/' . $type, $name );
-	}
+        return $this->createSubClient( 'locale/select/language/' . $type, $name );
+    }
 
 
-	/**
-	 * Processes the input, e.g. store given values.
-	 * A view must be available and this method doesn't generate any output
-	 * besides setting view variables.
-	 */
-	public function process()
-	{
-		$view = $this->getView();
-		$context = $this->getContext();
-		$config = $context->getConfig();
-		$session = $context->getSession();
+    /**
+     * Processes the input, e.g. store given values.
+     * A view must be available and this method doesn't generate any output
+     * besides setting view variables.
+     */
+    public function process()
+    {
+        $view = $this->getView();
+        $context = $this->getContext();
+        $config = $context->getConfig();
+        $session = $context->getSession();
 
-		$name = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
+        $name = $config->get( 'client/html/locale/select/language/param-name', 'loc_languageid' );
 
-		if( ( $languageId = $view->param( $name ) ) !== null ) {
-			$session->set( 'aimeos/locale/languageid', $languageId );
-		}
+        if( ( $languageId = $view->param( $name ) ) !== null ) {
+            $session->set( 'aimeos/locale/languageid', $languageId );
+        }
 
-		parent::process();
-	}
+        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 );
-	}
+    /**
+     * 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/Common/Summary/Detail/Base.php

Indentation +73 added lines, -73 removed lines

@@ -19,88 +19,88 @@
  * @subpackage Html
  */
 abstract class Base
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
 {
-	/**
-	 * Returns a list of tax rates and values for the given basket.
-	 *
-	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket containing the products, services, etc.
-	 * @return array Associative list of tax rates as key and corresponding amounts as value
-	 */
-	protected function getTaxRates( \Aimeos\MShop\Order\Item\Base\Iface $basket )
-	{
-		$taxrates = array();
+    /**
+     * Returns a list of tax rates and values for the given basket.
+     *
+     * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket containing the products, services, etc.
+     * @return array Associative list of tax rates as key and corresponding amounts as value
+     */
+    protected function getTaxRates( \Aimeos\MShop\Order\Item\Base\Iface $basket )
+    {
+        $taxrates = array();
 
-		foreach( $basket->getProducts() as $product )
-		{
-			$price = clone $product->getPrice();
-			$taxrate = $price->getTaxrate();
+        foreach( $basket->getProducts() as $product )
+        {
+            $price = clone $product->getPrice();
+            $taxrate = $price->getTaxrate();
 
-			if( isset( $taxrates[$taxrate] ) ) {
-				$taxrates[$taxrate]->addItem( $price, $product->getQuantity() );
-			} else {
-				$taxrates[$taxrate] = $price->addItem( $price, $product->getQuantity() - 1 );
-			}
-		}
+            if( isset( $taxrates[$taxrate] ) ) {
+                $taxrates[$taxrate]->addItem( $price, $product->getQuantity() );
+            } else {
+                $taxrates[$taxrate] = $price->addItem( $price, $product->getQuantity() - 1 );
+            }
+        }
 
-		try
-		{
-			$price = clone $basket->getService( 'delivery' )->getPrice();
-			$taxrate = $price->getTaxrate();
+        try
+        {
+            $price = clone $basket->getService( 'delivery' )->getPrice();
+            $taxrate = $price->getTaxrate();
 
-			if( isset( $taxrates[$taxrate] ) ) {
-				$taxrates[$taxrate]->addItem( $price );
-			} else {
-				$taxrates[$taxrate] = $price;
-			}
-		}
-		catch( \Exception $e ) { ; } // if delivery service isn't available
+            if( isset( $taxrates[$taxrate] ) ) {
+                $taxrates[$taxrate]->addItem( $price );
+            } else {
+                $taxrates[$taxrate] = $price;
+            }
+        }
+        catch( \Exception $e ) { ; } // if delivery service isn't available
 
-		try
-		{
-			$price = clone $basket->getService( 'payment' )->getPrice();
-			$taxrate = $price->getTaxrate();
+        try
+        {
+            $price = clone $basket->getService( 'payment' )->getPrice();
+            $taxrate = $price->getTaxrate();
 
-			if( isset( $taxrates[$taxrate] ) ) {
-				$taxrates[$taxrate]->addItem( $price );
-			} else {
-				$taxrates[$taxrate] = $price;
-			}
-		}
-		catch( \Exception $e ) { ; } // if payment service isn't available
+            if( isset( $taxrates[$taxrate] ) ) {
+                $taxrates[$taxrate]->addItem( $price );
+            } else {
+                $taxrates[$taxrate] = $price;
+            }
+        }
+        catch( \Exception $e ) { ; } // if payment service isn't available
 
-		return $taxrates;
-	}
+        return $taxrates;
+    }
 
 
-	/**
-	 * Returns the payment status at which download files are shown
-	 *
-	 * @return integer Payment status from \Aimeos\MShop\Order\Item\Base
-	 */
-	protected function getDownloadPaymentStatus()
-	{
-		$config = $this->getContext()->getConfig();
-		$default = \Aimeos\MShop\Order\Item\Base::PAY_RECEIVED;
+    /**
+     * Returns the payment status at which download files are shown
+     *
+     * @return integer Payment status from \Aimeos\MShop\Order\Item\Base
+     */
+    protected function getDownloadPaymentStatus()
+    {
+        $config = $this->getContext()->getConfig();
+        $default = \Aimeos\MShop\Order\Item\Base::PAY_RECEIVED;
 
-		/** client/html/common/summary/detail/download/payment-status
-		 * Minium payment status value for product download files
-		 *
-		 * This setting specifies the payment status value of an order for which
-		 * links to bought product download files are shown on the "thank you"
-		 * page, in the "MyAccount" and in the e-mails sent to the customers.
-		 *
-		 * The value is one of the payment constant values from
-		 * {@link https://github.com/aimeos/aimeos-core/blob/master/lib/mshoplib/src/MShop/Order/Item/Base.php#L105}.
-		 * Most of the time, only two values are of interest:
-		 * * 5: payment authorized
-		 * * 6: payment received
-		 *
-		 * @param integer Order payment constant value
-		 * @since 2016.3
-		 * @category User
-		 * @category Developer
-		 */
-		return $config->get( 'client/html/common/summary/detail/download/payment-status', $default );
-	}
+        /** client/html/common/summary/detail/download/payment-status
+         * Minium payment status value for product download files
+         *
+         * This setting specifies the payment status value of an order for which
+         * links to bought product download files are shown on the "thank you"
+         * page, in the "MyAccount" and in the e-mails sent to the customers.
+         *
+         * The value is one of the payment constant values from
+         * {@link https://github.com/aimeos/aimeos-core/blob/master/lib/mshoplib/src/MShop/Order/Item/Base.php#L105}.
+         * Most of the time, only two values are of interest:
+         * * 5: payment authorized
+         * * 6: payment received
+         *
+         * @param integer Order payment constant value
+         * @since 2016.3
+         * @category User
+         * @category Developer
+         */
+        return $config->get( 'client/html/common/summary/detail/download/payment-status', $default );
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Common/Summary/Address/Base.php

Indentation +1 added lines, -1 removed lines

@@ -19,6 +19,6 @@
  * @subpackage Html
  */
 abstract class Base
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
 {
 }
\ No newline at end of file

client/html/src/Client/Html/Common/Client/Factory/Iface.php

Indentation +10 added lines, -10 removed lines

@@ -19,15 +19,15 @@
  * @subpackage Html
  */
 interface Iface
-	extends \Aimeos\Client\Html\Iface
+    extends \Aimeos\Client\Html\Iface
 {
-	/**
-	 * Initializes the class instance.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object
-	 * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
-	 * 	and a list of relative paths inside the core or the extension as values
-	 * @return void
-	 */
-	public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths );
+    /**
+     * Initializes the class instance.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context object
+     * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
+     * 	and a list of relative paths inside the core or the extension as values
+     * @return void
+     */
+    public function __construct( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths );
 }

client/html/src/Client/Html/Common/Decorator/Iface.php

Indentation +11 added lines, -11 removed lines

@@ -19,16 +19,16 @@
  * @subpackage Html
  */
 interface Iface
-	extends \Aimeos\Client\Html\Iface
+    extends \Aimeos\Client\Html\Iface
 {
-	/**
-	 * Initializes a new client decorator object.
-	 *
-	 * @param \Aimeos\Client\Html\Iface $client Client object
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
-	 * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
-	 * 	and a list of relative paths inside the core or the extension as values
-	 */
-	public function __construct( \Aimeos\Client\Html\Iface $client,
-		\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths );
+    /**
+     * Initializes a new client decorator object.
+     *
+     * @param \Aimeos\Client\Html\Iface $client Client object
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
+     * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
+     * 	and a list of relative paths inside the core or the extension as values
+     */
+    public function __construct( \Aimeos\Client\Html\Iface $client,
+        \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths );
 }
\ No newline at end of file

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

Indentation +162 added lines, -162 removed lines

@@ -19,167 +19,167 @@
  * @subpackage Html
  */
 abstract class Base
-	extends \Aimeos\Client\Html\Base
-	implements \Aimeos\Client\Html\Common\Decorator\Iface
+    extends \Aimeos\Client\Html\Base
+    implements \Aimeos\Client\Html\Common\Decorator\Iface
 {
-	private $client;
-
-
-	/**
-	 * Initializes a new client decorator object.
-	 *
-	 * @param \Aimeos\Client\Html\Iface $client Client object
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
-	 * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
-	 * 	and a list of relative paths inside the core or the extension as values
-	 */
-	public function __construct( \Aimeos\Client\Html\Iface $client,
-		\Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
-	{
-		parent::__construct( $context, $templatePaths );
-
-		$this->client = $client;
-	}
-
-
-	/**
-	 * Passes unknown methods to wrapped objects.
-	 *
-	 * @param string $name Name of the method
-	 * @param array $param List of method parameter
-	 * @return mixed Returns the value of the called method
-	 * @throws \Aimeos\Client\Html\Exception If method call failed
-	 */
-	public function __call( $name, array $param )
-	{
-		if( ( $result = call_user_func_array( array( $this->client, $name ), $param ) ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Unable to call method "%1$s"', $name ) );
-		}
-
-		return $result;
-	}
-
-
-	/**
-	 * 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 )
-	{
-		return $this->client->getSubClient( $type, $name );
-	}
-
-
-	/**
-	 * 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 )
-	{
-		return $this->client->getHeader( $uid, $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 )
-	{
-		return $this->client->getBody( $uid, $tags, $expire );
-	}
-
-
-	/**
-	 * Returns the view object that will generate the HTML output.
-	 *
-	 * @return \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 */
-	public function getView()
-	{
-		return $this->client->getView();
-	}
-
-
-	/**
-	 * Sets the view object that will generate the HTML output.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @return \Aimeos\Client\Html\Iface Reference to this object for fluent calls
-	 */
-	public function setView( \Aimeos\MW\View\Iface $view )
-	{
-		$this->client->setView( $view );
-		return $this;
-	}
-
-
-	/**
-	 * Modifies the cached body content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified body content
-	 */
-	public function modifyBody( $content, $uid )
-	{
-		return $this->client->modifyBody( $content, $uid );
-	}
-
-
-	/**
-	 * Modifies the cached header content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified header content
-	 */
-	public function modifyHeader( $content, $uid )
-	{
-		return $this->client->modifyHeader( $content, $uid );
-	}
-
-
-	/**
-	 * 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()
-	{
-		$this->client->process();
-	}
-
-
-	/**
-	 * Returns the inner client object
-	 *
-	 * @return \Aimeos\Client\Html\Iface HTML client
-	 */
-	protected function getClient()
-	{
-		return $this->client;
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return array();
-	}
+    private $client;
+
+
+    /**
+     * Initializes a new client decorator object.
+     *
+     * @param \Aimeos\Client\Html\Iface $client Client object
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context object with required objects
+     * @param array $templatePaths Associative list of the file system paths to the core or the extensions as key
+     * 	and a list of relative paths inside the core or the extension as values
+     */
+    public function __construct( \Aimeos\Client\Html\Iface $client,
+        \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths )
+    {
+        parent::__construct( $context, $templatePaths );
+
+        $this->client = $client;
+    }
+
+
+    /**
+     * Passes unknown methods to wrapped objects.
+     *
+     * @param string $name Name of the method
+     * @param array $param List of method parameter
+     * @return mixed Returns the value of the called method
+     * @throws \Aimeos\Client\Html\Exception If method call failed
+     */
+    public function __call( $name, array $param )
+    {
+        if( ( $result = call_user_func_array( array( $this->client, $name ), $param ) ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Unable to call method "%1$s"', $name ) );
+        }
+
+        return $result;
+    }
+
+
+    /**
+     * 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 )
+    {
+        return $this->client->getSubClient( $type, $name );
+    }
+
+
+    /**
+     * 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 )
+    {
+        return $this->client->getHeader( $uid, $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 )
+    {
+        return $this->client->getBody( $uid, $tags, $expire );
+    }
+
+
+    /**
+     * Returns the view object that will generate the HTML output.
+     *
+     * @return \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     */
+    public function getView()
+    {
+        return $this->client->getView();
+    }
+
+
+    /**
+     * Sets the view object that will generate the HTML output.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @return \Aimeos\Client\Html\Iface Reference to this object for fluent calls
+     */
+    public function setView( \Aimeos\MW\View\Iface $view )
+    {
+        $this->client->setView( $view );
+        return $this;
+    }
+
+
+    /**
+     * Modifies the cached body content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified body content
+     */
+    public function modifyBody( $content, $uid )
+    {
+        return $this->client->modifyBody( $content, $uid );
+    }
+
+
+    /**
+     * Modifies the cached header content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified header content
+     */
+    public function modifyHeader( $content, $uid )
+    {
+        return $this->client->modifyHeader( $content, $uid );
+    }
+
+
+    /**
+     * 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()
+    {
+        $this->client->process();
+    }
+
+
+    /**
+     * Returns the inner client object
+     *
+     * @return \Aimeos\Client\Html\Iface HTML client
+     */
+    protected function getClient()
+    {
+        return $this->client;
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return array();
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Common/Factory/Iface.php

Indentation +9 added lines, -9 removed lines

@@ -20,13 +20,13 @@
  */
 interface Iface
 {
-	/**
-	 *	Creates a client object.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
-	 * @param array List of file system paths where the templates are stored
-	 * @param string $name Client name (from configuration or "Standard" if null)
-	 * @return \Aimeos\Client\Html\Iface New client object
-	 */
-	public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null );
+    /**
+     *	Creates a client object.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
+     * @param array List of file system paths where the templates are stored
+     * @param string $name Client name (from configuration or "Standard" if null)
+     * @return \Aimeos\Client\Html\Iface New client object
+     */
+    public static function createClient( \Aimeos\MShop\Context\Item\Iface $context, array $templatePaths, $name = null );
 }