aimeos / ai-client-html

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

Indentation +226 added lines, -226 removed lines

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

Spacing +13 added lines, -13 removed lines

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

Doc Comments +1 added lines, -1 removed lines

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

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

Spacing +9 added lines, -9 removed lines

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

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

Indentation +514 added lines, -514 removed lines

@@ -19,519 +19,519 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	private static $headerSingleton;
-
-	/** client/html/catalog/filter/standard/subparts
-	 * List of HTML sub-clients rendered within the catalog filter section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/catalog/filter/standard/subparts';
-
-	/** client/html/catalog/filter/search/name
-	 * Name of the search part used by the catalog filter client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Search\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
-
-	/** client/html/catalog/filter/tree/name
-	 * Name of the tree part used by the catalog filter client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Tree\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
-
-	/** client/html/catalog/filter/attribute/name
-	 * Name of the attribute part used by the catalog filter client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Attribute\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'search', 'tree', 'attribute' );
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$prefixes = array( 'f' );
-		$context = $this->getContext();
-
-		/** client/html/catalog/filter
-		 * All parameters defined for the catalog filter component and its subparts
-		 *
-		 * This returns all settings related to the filter component.
-		 * Please refer to the single settings for details.
-		 *
-		 * @param array Associative list of name/value settings
-		 * @category Developer
-		 * @see client/html/catalog#filter
-		 */
-		$confkey = 'client/html/catalog/filter';
-
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
-		{
-			$view = $this->getView();
-
-			try
-			{
-				$view = $this->setViewParams( $view, $tags, $expire );
-
-				$html = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-				}
-				$view->filterBody = $html;
-			}
-			catch( \Aimeos\Client\Html\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\Controller\Frontend\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Aimeos\MShop\Exception $e )
-			{
-				$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-			catch( \Exception $e )
-			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-
-				$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-				$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-			}
-
-			/** client/html/catalog/filter/standard/template-body
-			 * Relative path to the HTML body template of the catalog filter client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the result shown in the body of the frontend. The
-			 * configuration string is the path to the template file relative
-			 * to the templates directory (usually in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page body
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/filter/standard/template-header
-			 */
-			$tplconf = 'client/html/catalog/filter/standard/template-body';
-			$default = 'catalog/filter/body-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		else
-		{
-			$html = $this->modifyBody( $html, $uid );
-		}
-
-		return $html;
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		if( self::$headerSingleton !== null ) {
-			return '';
-		}
-
-		self::$headerSingleton = true;
-
-		$prefixes = array( 'f' );
-		$context = $this->getContext();
-		$confkey = 'client/html/catalog/filter';
-
-		if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
-		{
-			$view = $this->getView();
-
-			try
-			{
-				$view = $this->setViewParams( $view, $tags, $expire );
-
-				$html = '';
-				foreach( $this->getSubClients() as $subclient ) {
-					$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-				}
-				$view->filterHeader = $html;
-			}
-			catch( \Exception $e )
-			{
-				$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-			}
-
-			/** client/html/catalog/filter/standard/template-header
-			 * Relative path to the HTML header template of the catalog filter client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the HTML code that is inserted into the HTML page header
-			 * of the rendered page in the frontend. The configuration string is the
-			 * path to the template file relative to the templates directory (usually
-			 * in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page head
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/catalog/filter/standard/template-body
-			 */
-			$tplconf = 'client/html/catalog/filter/standard/template-header';
-			$default = 'catalog/filter/header-default.php';
-
-			$html = $view->render( $view->config( $tplconf, $default ) );
-
-			$this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
-		}
-		else
-		{
-			$html = $this->modifyHeader( $html, $uid );
-		}
-
-		return $html;
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/catalog/filter/decorators/excludes
-		 * Excludes decorators added by the "common" option from the catalog filter html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/catalog/filter/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/decorators/global
-		 * @see client/html/catalog/filter/decorators/local
-		 */
-
-		/** client/html/catalog/filter/decorators/global
-		 * Adds a list of globally available decorators only to the catalog filter html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/decorators/excludes
-		 * @see client/html/catalog/filter/decorators/local
-		 */
-
-		/** client/html/catalog/filter/decorators/local
-		 * Adds a list of local decorators only to the catalog filter html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
-		 *
-		 *  client/html/catalog/filter/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/catalog/filter/decorators/excludes
-		 * @see client/html/catalog/filter/decorators/global
-		 */
-
-		return $this->createSubClient( 'catalog/filter/' . $type, $name );
-	}
-
-
-	/**
-	 * Modifies the cached body content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified body content
-	 */
-	public function modifyBody( $content, $uid )
-	{
-		$content = parent::modifyBody( $content, $uid );
-
-		return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.filter.csrf' );
-	}
-
-
-	/**
-	 * Processes the input, e.g. store given values.
-	 * A view must be available and this method doesn't generate any output
-	 * besides setting view variables.
-	 */
-	public function process()
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
-
-		try
-		{
-			parent::process();
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-
-			$error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
-			$view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
-		}
-	}
-
-
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$config = $this->getContext()->getConfig();
-
-			/** client/html/catalog/count/enable
-			 * Enables or disables displaying product counts in the catalog filter
-			 *
-			 * This configuration option allows shop owners to display product
-			 * counts in the catalog filter or to disable fetching product count
-			 * information.
-			 *
-			 * The product count information is fetched via AJAX and inserted via
-			 * Javascript. This allows to cache parts of the catalog filter by
-			 * leaving out such highly dynamic content like product count which
-			 * changes with used filter parameter.
-			 *
-			 * @param boolean Value of "1" to display product counts, "0" to disable them
-			 * @since 2014.03
-			 * @category User
-			 * @category Developer
-			 * @see client/html/catalog/count/url/target
-			 * @see client/html/catalog/count/url/controller
-			 * @see client/html/catalog/count/url/action
-			 * @see client/html/catalog/count/url/config
-			 */
-			if( $config->get( 'client/html/catalog/count/enable', true ) == true )
-			{
-				/** client/html/catalog/count/url/target
-				 * Destination of the URL where the controller specified in the URL is known
-				 *
-				 * The destination can be a page ID like in a content management system or the
-				 * module of a software development framework. This "target" must contain or know
-				 * the controller that should be called by the generated URL.
-				 *
-				 * @param string Destination of the URL
-				 * @since 2014.03
-				 * @category Developer
-				 * @see client/html/catalog/count/url/controller
-				 * @see client/html/catalog/count/url/action
-				 * @see client/html/catalog/count/url/config
-				 */
-				$target = $config->get( 'client/html/catalog/count/url/target' );
-
-				/** client/html/catalog/count/url/controller
-				 * Name of the controller whose action should be called
-				 *
-				 * In Model-View-Controller (MVC) applications, the controller contains the methods
-				 * that create parts of the output displayed in the generated HTML page. Controller
-				 * names are usually alpha-numeric.
-				 *
-				 * @param string Name of the controller
-				 * @since 2014.03
-				 * @category Developer
-				 * @see client/html/catalog/count/url/target
-				 * @see client/html/catalog/count/url/action
-				 * @see client/html/catalog/count/url/config
-				 */
-				$controller = $config->get( 'client/html/catalog/count/url/controller', 'catalog' );
-
-				/** client/html/catalog/count/url/action
-				 * Name of the action that should create the output
-				 *
-				 * In Model-View-Controller (MVC) applications, actions are the methods of a
-				 * controller that create parts of the output displayed in the generated HTML page.
-				 * Action names are usually alpha-numeric.
-				 *
-				 * @param string Name of the action
-				 * @since 2014.03
-				 * @category Developer
-				 * @see client/html/catalog/count/url/target
-				 * @see client/html/catalog/count/url/controller
-				 * @see client/html/catalog/count/url/config
-				 */
-				$action = $config->get( 'client/html/catalog/count/url/action', 'count' );
-
-				/** client/html/catalog/count/url/config
-				 * Associative list of configuration options used for generating the URL
-				 *
-				 * You can specify additional options as key/value pairs used when generating
-				 * the URLs, like
-				 *
-				 *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
-				 *
-				 * The available key/value pairs depend on the application that embeds the e-commerce
-				 * framework. This is because the infrastructure of the application is used for
-				 * generating the URLs. The full list of available config options is referenced
-				 * in the "see also" section of this page.
-				 *
-				 * @param string Associative list of configuration options
-				 * @since 2014.03
-				 * @category Developer
-				 * @see client/html/catalog/count/url/target
-				 * @see client/html/catalog/count/url/controller
-				 * @see client/html/catalog/count/url/action
-				 * @see client/html/url/config
-				 */
-				$config = $config->get( 'client/html/catalog/count/url/config', array() );
-
-				$params = $this->getClientParams( $view->param(), array( 'f' ) );
-
-				$view->filterCountUrl = $view->url( $target, $controller, $action, $params, array(), $config );
-			}
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    private static $headerSingleton;
+
+    /** client/html/catalog/filter/standard/subparts
+     * List of HTML sub-clients rendered within the catalog filter section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/catalog/filter/standard/subparts';
+
+    /** client/html/catalog/filter/search/name
+     * Name of the search part used by the catalog filter client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Search\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
+
+    /** client/html/catalog/filter/tree/name
+     * Name of the tree part used by the catalog filter client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Tree\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
+
+    /** client/html/catalog/filter/attribute/name
+     * Name of the attribute part used by the catalog filter client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Catalog\Filter\Attribute\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartNames = array( 'search', 'tree', 'attribute' );
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $prefixes = array( 'f' );
+        $context = $this->getContext();
+
+        /** client/html/catalog/filter
+         * All parameters defined for the catalog filter component and its subparts
+         *
+         * This returns all settings related to the filter component.
+         * Please refer to the single settings for details.
+         *
+         * @param array Associative list of name/value settings
+         * @category Developer
+         * @see client/html/catalog#filter
+         */
+        $confkey = 'client/html/catalog/filter';
+
+        if( $context->getUserId() != null || ( $html = $this->getCached( 'body', $uid, $prefixes, $confkey ) ) === null )
+        {
+            $view = $this->getView();
+
+            try
+            {
+                $view = $this->setViewParams( $view, $tags, $expire );
+
+                $html = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+                }
+                $view->filterBody = $html;
+            }
+            catch( \Aimeos\Client\Html\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+                $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\Controller\Frontend\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+                $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+            }
+            catch( \Aimeos\MShop\Exception $e )
+            {
+                $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+                $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+            }
+            catch( \Exception $e )
+            {
+                $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+
+                $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+                $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+            }
+
+            /** client/html/catalog/filter/standard/template-body
+             * Relative path to the HTML body template of the catalog filter client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the result shown in the body of the frontend. The
+             * configuration string is the path to the template file relative
+             * to the templates directory (usually in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page body
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/filter/standard/template-header
+             */
+            $tplconf = 'client/html/catalog/filter/standard/template-body';
+            $default = 'catalog/filter/body-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $this->setCached( 'body', $uid, $prefixes, $confkey, $html, $tags, $expire );
+        }
+        else
+        {
+            $html = $this->modifyBody( $html, $uid );
+        }
+
+        return $html;
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        if( self::$headerSingleton !== null ) {
+            return '';
+        }
+
+        self::$headerSingleton = true;
+
+        $prefixes = array( 'f' );
+        $context = $this->getContext();
+        $confkey = 'client/html/catalog/filter';
+
+        if( $context->getUserId() != null || ( $html = $this->getCached( 'header', $uid, $prefixes, $confkey ) ) === null )
+        {
+            $view = $this->getView();
+
+            try
+            {
+                $view = $this->setViewParams( $view, $tags, $expire );
+
+                $html = '';
+                foreach( $this->getSubClients() as $subclient ) {
+                    $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+                }
+                $view->filterHeader = $html;
+            }
+            catch( \Exception $e )
+            {
+                $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            }
+
+            /** client/html/catalog/filter/standard/template-header
+             * Relative path to the HTML header template of the catalog filter client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the HTML code that is inserted into the HTML page header
+             * of the rendered page in the frontend. The configuration string is the
+             * path to the template file relative to the templates directory (usually
+             * in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page head
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/catalog/filter/standard/template-body
+             */
+            $tplconf = 'client/html/catalog/filter/standard/template-header';
+            $default = 'catalog/filter/header-default.php';
+
+            $html = $view->render( $view->config( $tplconf, $default ) );
+
+            $this->setCached( 'header', $uid, $prefixes, $confkey, $html, $tags, $expire );
+        }
+        else
+        {
+            $html = $this->modifyHeader( $html, $uid );
+        }
+
+        return $html;
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/catalog/filter/decorators/excludes
+         * Excludes decorators added by the "common" option from the catalog filter html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/catalog/filter/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/decorators/global
+         * @see client/html/catalog/filter/decorators/local
+         */
+
+        /** client/html/catalog/filter/decorators/global
+         * Adds a list of globally available decorators only to the catalog filter html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/decorators/excludes
+         * @see client/html/catalog/filter/decorators/local
+         */
+
+        /** client/html/catalog/filter/decorators/local
+         * Adds a list of local decorators only to the catalog filter html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Catalog\Decorator\*") around the html client.
+         *
+         *  client/html/catalog/filter/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Catalog\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/catalog/filter/decorators/excludes
+         * @see client/html/catalog/filter/decorators/global
+         */
+
+        return $this->createSubClient( 'catalog/filter/' . $type, $name );
+    }
+
+
+    /**
+     * Modifies the cached body content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified body content
+     */
+    public function modifyBody( $content, $uid )
+    {
+        $content = parent::modifyBody( $content, $uid );
+
+        return $this->replaceSection( $content, $this->getView()->csrf()->formfield(), 'catalog.filter.csrf' );
+    }
+
+
+    /**
+     * Processes the input, e.g. store given values.
+     * A view must be available and this method doesn't generate any output
+     * besides setting view variables.
+     */
+    public function process()
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
+
+        try
+        {
+            parent::process();
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $context->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+        }
+        catch( \Exception $e )
+        {
+            $context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->filterErrorList = $view->get( 'filterErrorList', array() ) + $error;
+        }
+    }
+
+
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $config = $this->getContext()->getConfig();
+
+            /** client/html/catalog/count/enable
+             * Enables or disables displaying product counts in the catalog filter
+             *
+             * This configuration option allows shop owners to display product
+             * counts in the catalog filter or to disable fetching product count
+             * information.
+             *
+             * The product count information is fetched via AJAX and inserted via
+             * Javascript. This allows to cache parts of the catalog filter by
+             * leaving out such highly dynamic content like product count which
+             * changes with used filter parameter.
+             *
+             * @param boolean Value of "1" to display product counts, "0" to disable them
+             * @since 2014.03
+             * @category User
+             * @category Developer
+             * @see client/html/catalog/count/url/target
+             * @see client/html/catalog/count/url/controller
+             * @see client/html/catalog/count/url/action
+             * @see client/html/catalog/count/url/config
+             */
+            if( $config->get( 'client/html/catalog/count/enable', true ) == true )
+            {
+                /** client/html/catalog/count/url/target
+                 * Destination of the URL where the controller specified in the URL is known
+                 *
+                 * The destination can be a page ID like in a content management system or the
+                 * module of a software development framework. This "target" must contain or know
+                 * the controller that should be called by the generated URL.
+                 *
+                 * @param string Destination of the URL
+                 * @since 2014.03
+                 * @category Developer
+                 * @see client/html/catalog/count/url/controller
+                 * @see client/html/catalog/count/url/action
+                 * @see client/html/catalog/count/url/config
+                 */
+                $target = $config->get( 'client/html/catalog/count/url/target' );
+
+                /** client/html/catalog/count/url/controller
+                 * Name of the controller whose action should be called
+                 *
+                 * In Model-View-Controller (MVC) applications, the controller contains the methods
+                 * that create parts of the output displayed in the generated HTML page. Controller
+                 * names are usually alpha-numeric.
+                 *
+                 * @param string Name of the controller
+                 * @since 2014.03
+                 * @category Developer
+                 * @see client/html/catalog/count/url/target
+                 * @see client/html/catalog/count/url/action
+                 * @see client/html/catalog/count/url/config
+                 */
+                $controller = $config->get( 'client/html/catalog/count/url/controller', 'catalog' );
+
+                /** client/html/catalog/count/url/action
+                 * Name of the action that should create the output
+                 *
+                 * In Model-View-Controller (MVC) applications, actions are the methods of a
+                 * controller that create parts of the output displayed in the generated HTML page.
+                 * Action names are usually alpha-numeric.
+                 *
+                 * @param string Name of the action
+                 * @since 2014.03
+                 * @category Developer
+                 * @see client/html/catalog/count/url/target
+                 * @see client/html/catalog/count/url/controller
+                 * @see client/html/catalog/count/url/config
+                 */
+                $action = $config->get( 'client/html/catalog/count/url/action', 'count' );
+
+                /** client/html/catalog/count/url/config
+                 * Associative list of configuration options used for generating the URL
+                 *
+                 * You can specify additional options as key/value pairs used when generating
+                 * the URLs, like
+                 *
+                 *  client/html/<clientname>/url/config = array( 'absoluteUri' => true )
+                 *
+                 * The available key/value pairs depend on the application that embeds the e-commerce
+                 * framework. This is because the infrastructure of the application is used for
+                 * generating the URLs. The full list of available config options is referenced
+                 * in the "see also" section of this page.
+                 *
+                 * @param string Associative list of configuration options
+                 * @since 2014.03
+                 * @category Developer
+                 * @see client/html/catalog/count/url/target
+                 * @see client/html/catalog/count/url/controller
+                 * @see client/html/catalog/count/url/action
+                 * @see client/html/url/config
+                 */
+                $config = $config->get( 'client/html/catalog/count/url/config', array() );
+
+                $params = $this->getClientParams( $view->param(), array( 'f' ) );
+
+                $view->filterCountUrl = $view->url( $target, $controller, $action, $params, array(), $config );
+            }
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }

Spacing +63 added lines, -63 removed lines

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

Braces +11 added lines, -22 removed lines

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

Doc Comments +1 added lines, -1 removed lines

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

client/html/src/Client/Html/Checkout/Confirm/Retry/Standard.php

Indentation +226 added lines, -226 removed lines

@@ -19,231 +19,231 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/checkout/confirm/retry/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout confirm retry 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/checkout/confirm/retry/standard/subparts';
-	private $subPartNames = array();
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->retryBody = $html;
-
-		/** client/html/checkout/confirm/retry/standard/template-body
-		 * Relative path to the HTML body template of the checkout confirm retry 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/checkout/confirm/retry/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/confirm/retry/standard/template-body';
-		$default = 'checkout/confirm/retry-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->retryHeader = $html;
-
-		/** client/html/checkout/confirm/retry/standard/template-header
-		 * Relative path to the HTML header template of the checkout confirm retry 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/checkout/confirm/retry/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/confirm/retry/standard/template-header';
-		$default = 'checkout/confirm/retry-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/checkout/confirm/retry/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout confirm retry 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/checkout/confirm/retry/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/checkout/confirm/retry/decorators/global
-		 * @see client/html/checkout/confirm/retry/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/retry/decorators/global
-		 * Adds a list of globally available decorators only to the checkout confirm retry 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/checkout/confirm/retry/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/checkout/confirm/retry/decorators/excludes
-		 * @see client/html/checkout/confirm/retry/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/retry/decorators/local
-		 * Adds a list of local decorators only to the checkout confirm retry 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/checkout/confirm/retry/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/checkout/confirm/retry/decorators/excludes
-		 * @see client/html/checkout/confirm/retry/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/confirm/retry/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /** client/html/checkout/confirm/retry/standard/subparts
+     * List of HTML sub-clients rendered within the checkout confirm retry 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/checkout/confirm/retry/standard/subparts';
+    private $subPartNames = array();
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->retryBody = $html;
+
+        /** client/html/checkout/confirm/retry/standard/template-body
+         * Relative path to the HTML body template of the checkout confirm retry 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/checkout/confirm/retry/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/confirm/retry/standard/template-body';
+        $default = 'checkout/confirm/retry-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->retryHeader = $html;
+
+        /** client/html/checkout/confirm/retry/standard/template-header
+         * Relative path to the HTML header template of the checkout confirm retry 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/checkout/confirm/retry/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/confirm/retry/standard/template-header';
+        $default = 'checkout/confirm/retry-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/checkout/confirm/retry/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout confirm retry 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/checkout/confirm/retry/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/checkout/confirm/retry/decorators/global
+         * @see client/html/checkout/confirm/retry/decorators/local
+         */
+
+        /** client/html/checkout/confirm/retry/decorators/global
+         * Adds a list of globally available decorators only to the checkout confirm retry 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/checkout/confirm/retry/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/checkout/confirm/retry/decorators/excludes
+         * @see client/html/checkout/confirm/retry/decorators/local
+         */
+
+        /** client/html/checkout/confirm/retry/decorators/local
+         * Adds a list of local decorators only to the checkout confirm retry 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/checkout/confirm/retry/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/checkout/confirm/retry/decorators/excludes
+         * @see client/html/checkout/confirm/retry/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/confirm/retry/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 }
\ No newline at end of file

Spacing +13 added lines, -13 removed lines

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

Doc Comments +1 added lines, -1 removed lines

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

client/html/src/Client/Html/Checkout/Confirm/Order/Service/Standard.php

Indentation +227 added lines, -227 removed lines

@@ -18,232 +18,232 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Summary\Service\Base
+    extends \Aimeos\Client\Html\Common\Summary\Service\Base
 {
-	/** client/html/checkout/confirm/order/service/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout confirm order service 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 2015.11
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/checkout/confirm/order/service/standard/subparts';
-	private $subPartNames = array();
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	*/
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->serviceBody = $html;
-
-		/** client/html/checkout/confirm/order/service/standard/template-body
-		 * Relative path to the HTML body template of the checkout confirm order service 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"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/service/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/service/standard/template-body';
-		$default = 'common/summary/service-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->serviceHeader = $html;
-
-		/** client/html/checkout/confirm/order/service/standard/template-header
-		 * Relative path to the HTML header template of the checkout confirm order service 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"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/service/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/service/standard/template-header';
-		$default = 'common/summary/service-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/checkout/confirm/order/service/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout confirm order service 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/checkout/confirm/order/service/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/checkout/confirm/order/service/decorators/global
-		 * @see client/html/checkout/confirm/order/service/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/service/decorators/global
-		 * Adds a list of globally available decorators only to the checkout confirm order service 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/checkout/confirm/order/service/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/checkout/confirm/order/service/decorators/excludes
-		 * @see client/html/checkout/confirm/order/service/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/service/decorators/local
-		 * Adds a list of local decorators only to the checkout confirm order service 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/checkout/confirm/order/service/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/checkout/confirm/order/service/decorators/excludes
-		 * @see client/html/checkout/confirm/order/service/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/confirm/order/service/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /** client/html/checkout/confirm/order/service/standard/subparts
+     * List of HTML sub-clients rendered within the checkout confirm order service 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 2015.11
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/checkout/confirm/order/service/standard/subparts';
+    private $subPartNames = array();
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->serviceBody = $html;
+
+        /** client/html/checkout/confirm/order/service/standard/template-body
+         * Relative path to the HTML body template of the checkout confirm order service 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"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/service/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/confirm/order/service/standard/template-body';
+        $default = 'common/summary/service-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->serviceHeader = $html;
+
+        /** client/html/checkout/confirm/order/service/standard/template-header
+         * Relative path to the HTML header template of the checkout confirm order service 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"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/service/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/confirm/order/service/standard/template-header';
+        $default = 'common/summary/service-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/checkout/confirm/order/service/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout confirm order service 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/checkout/confirm/order/service/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/checkout/confirm/order/service/decorators/global
+         * @see client/html/checkout/confirm/order/service/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/service/decorators/global
+         * Adds a list of globally available decorators only to the checkout confirm order service 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/checkout/confirm/order/service/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/checkout/confirm/order/service/decorators/excludes
+         * @see client/html/checkout/confirm/order/service/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/service/decorators/local
+         * Adds a list of local decorators only to the checkout confirm order service 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/checkout/confirm/order/service/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/checkout/confirm/order/service/decorators/excludes
+         * @see client/html/checkout/confirm/order/service/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/confirm/order/service/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 }
\ No newline at end of file

Spacing +13 added lines, -13 removed lines

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

Doc Comments +1 added lines, -1 removed lines

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

client/html/src/Client/Html/Checkout/Confirm/Order/Coupon/Standard.php

Indentation +227 added lines, -227 removed lines

@@ -18,232 +18,232 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Summary\Coupon\Base
+    extends \Aimeos\Client\Html\Common\Summary\Coupon\Base
 {
-	/** client/html/checkout/confirm/order/coupon/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout confirm order coupon 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 2015.11
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/checkout/confirm/order/coupon/standard/subparts';
-	private $subPartNames = array();
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	*/
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->couponBody = $html;
-
-		/** client/html/checkout/confirm/order/coupon/standard/template-body
-		 * Relative path to the HTML body template of the checkout confirm order coupon 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"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/coupon/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/coupon/standard/template-body';
-		$default = 'common/summary/coupon-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->couponHeader = $html;
-
-		/** client/html/checkout/confirm/order/coupon/standard/template-header
-		 * Relative path to the HTML header template of the checkout confirm order coupon 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"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/coupon/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/coupon/standard/template-header';
-		$default = 'common/summary/coupon-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/checkout/confirm/order/coupon/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout confirm order coupon 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/checkout/confirm/order/coupon/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/checkout/confirm/order/coupon/decorators/global
-		 * @see client/html/checkout/confirm/order/coupon/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/coupon/decorators/global
-		 * Adds a list of globally available decorators only to the checkout confirm order coupon 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/checkout/confirm/order/coupon/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/checkout/confirm/order/coupon/decorators/excludes
-		 * @see client/html/checkout/confirm/order/coupon/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/coupon/decorators/local
-		 * Adds a list of local decorators only to the checkout confirm order coupon 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/checkout/confirm/order/coupon/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/checkout/confirm/order/coupon/decorators/excludes
-		 * @see client/html/checkout/confirm/order/coupon/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/confirm/order/coupon/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /** client/html/checkout/confirm/order/coupon/standard/subparts
+     * List of HTML sub-clients rendered within the checkout confirm order coupon 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 2015.11
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/checkout/confirm/order/coupon/standard/subparts';
+    private $subPartNames = array();
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->couponBody = $html;
+
+        /** client/html/checkout/confirm/order/coupon/standard/template-body
+         * Relative path to the HTML body template of the checkout confirm order coupon 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"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/coupon/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/confirm/order/coupon/standard/template-body';
+        $default = 'common/summary/coupon-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->couponHeader = $html;
+
+        /** client/html/checkout/confirm/order/coupon/standard/template-header
+         * Relative path to the HTML header template of the checkout confirm order coupon 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"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/coupon/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/confirm/order/coupon/standard/template-header';
+        $default = 'common/summary/coupon-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/checkout/confirm/order/coupon/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout confirm order coupon 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/checkout/confirm/order/coupon/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/checkout/confirm/order/coupon/decorators/global
+         * @see client/html/checkout/confirm/order/coupon/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/coupon/decorators/global
+         * Adds a list of globally available decorators only to the checkout confirm order coupon 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/checkout/confirm/order/coupon/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/checkout/confirm/order/coupon/decorators/excludes
+         * @see client/html/checkout/confirm/order/coupon/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/coupon/decorators/local
+         * Adds a list of local decorators only to the checkout confirm order coupon 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/checkout/confirm/order/coupon/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/checkout/confirm/order/coupon/decorators/excludes
+         * @see client/html/checkout/confirm/order/coupon/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/confirm/order/coupon/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 }
\ No newline at end of file

Spacing +13 added lines, -13 removed lines

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

Doc Comments +1 added lines, -1 removed lines

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

client/html/src/Client/Html/Checkout/Confirm/Order/Detail/Standard.php

Indentation +232 added lines, -232 removed lines

@@ -18,260 +18,260 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Summary\Detail\Base
+    extends \Aimeos\Client\Html\Common\Summary\Detail\Base
 {
-	/** client/html/checkout/confirm/order/detail/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout confirm order detail section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2015.11
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/checkout/confirm/order/detail/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
+    /** client/html/checkout/confirm/order/detail/standard/subparts
+     * List of HTML sub-clients rendered within the checkout confirm order detail section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2015.11
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/checkout/confirm/order/detail/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->detailBody = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->detailBody = $html;
 
-		/** client/html/checkout/confirm/order/detail/standard/template-body
-		 * Relative path to the HTML body template of the checkout confirm order detail client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/detail/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/detail/standard/template-body';
-		$default = 'common/summary/detail-body-default.php';
+        /** client/html/checkout/confirm/order/detail/standard/template-body
+         * Relative path to the HTML body template of the checkout confirm order detail client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/detail/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/confirm/order/detail/standard/template-body';
+        $default = 'common/summary/detail-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->detailHeader = $html;
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->detailHeader = $html;
 
-		/** client/html/checkout/confirm/order/detail/standard/template-header
-		 * Relative path to the HTML header template of the checkout confirm order detail client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the HTML code that is inserted into the HTML page header
-		 * of the rendered page in the frontend. The configuration string is the
-		 * path to the template file relative to the templates directory (usually
-		 * in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/detail/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/detail/standard/template-header';
-		$default = 'common/summary/detail-header-default.php';
+        /** client/html/checkout/confirm/order/detail/standard/template-header
+         * Relative path to the HTML header template of the checkout confirm order detail client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the HTML code that is inserted into the HTML page header
+         * of the rendered page in the frontend. The configuration string is the
+         * path to the template file relative to the templates directory (usually
+         * in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/detail/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/confirm/order/detail/standard/template-header';
+        $default = 'common/summary/detail-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/checkout/confirm/order/detail/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout confirm order detail html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/checkout/confirm/order/detail/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/confirm/order/detail/decorators/global
-		 * @see client/html/checkout/confirm/order/detail/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/checkout/confirm/order/detail/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout confirm order detail html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/checkout/confirm/order/detail/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/confirm/order/detail/decorators/global
+         * @see client/html/checkout/confirm/order/detail/decorators/local
+         */
 
-		/** client/html/checkout/confirm/order/detail/decorators/global
-		 * Adds a list of globally available decorators only to the checkout confirm order detail html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/checkout/confirm/order/detail/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/confirm/order/detail/decorators/excludes
-		 * @see client/html/checkout/confirm/order/detail/decorators/local
-		 */
+        /** client/html/checkout/confirm/order/detail/decorators/global
+         * Adds a list of globally available decorators only to the checkout confirm order detail html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/checkout/confirm/order/detail/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/confirm/order/detail/decorators/excludes
+         * @see client/html/checkout/confirm/order/detail/decorators/local
+         */
 
-		/** client/html/checkout/confirm/order/detail/decorators/local
-		 * Adds a list of local decorators only to the checkout confirm order detail html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
-		 *
-		 *  client/html/checkout/confirm/order/detail/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/checkout/confirm/order/detail/decorators/excludes
-		 * @see client/html/checkout/confirm/order/detail/decorators/global
-		 */
+        /** client/html/checkout/confirm/order/detail/decorators/local
+         * Adds a list of local decorators only to the checkout confirm order detail html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
+         *
+         *  client/html/checkout/confirm/order/detail/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/checkout/confirm/order/detail/decorators/excludes
+         * @see client/html/checkout/confirm/order/detail/decorators/global
+         */
 
-		return $this->createSubClient( 'checkout/confirm/order/detail/' . $type, $name );
-	}
+        return $this->createSubClient( 'checkout/confirm/order/detail/' . $type, $name );
+    }
 
 
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 
 
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$view = parent::setViewParams( $view );
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $view = parent::setViewParams( $view );
 
-			if( $view->confirmOrderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus() ) {
-				$view->summaryShowDownloadAttributes = true;
-			}
+            if( $view->confirmOrderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus() ) {
+                $view->summaryShowDownloadAttributes = true;
+            }
 
-			$view->summaryTaxRates = $this->getTaxRates( $view->summaryBasket );
+            $view->summaryTaxRates = $this->getTaxRates( $view->summaryBasket );
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +18 added lines, -18 removed lines

@@ -66,13 +66,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	*/
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->detailBody = $html;
 
@@ -100,7 +100,7 @@ 
 		$tplconf = 'client/html/checkout/confirm/order/detail/standard/template-body';
 		$default = 'common/summary/detail-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -112,13 +112,13 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
+		$view = $this->setViewParams($this->getView(), $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->detailHeader = $html;
 
@@ -147,7 +147,7 @@ 
 		$tplconf = 'client/html/checkout/confirm/order/detail/standard/template-header';
 		$default = 'common/summary/detail-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -158,7 +158,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/checkout/confirm/order/detail/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout confirm order detail html client
@@ -234,7 +234,7 @@ 
 		 * @see client/html/checkout/confirm/order/detail/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/confirm/order/detail/' . $type, $name );
+		return $this->createSubClient('checkout/confirm/order/detail/'.$type, $name);
 	}
 
 
@@ -245,7 +245,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -257,17 +257,17 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
-			$view = parent::setViewParams( $view );
+			$view = parent::setViewParams($view);
 
-			if( $view->confirmOrderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus() ) {
+			if ($view->confirmOrderItem->getPaymentStatus() >= $this->getDownloadPaymentStatus()) {
 				$view->summaryShowDownloadAttributes = true;
 			}
 
-			$view->summaryTaxRates = $this->getTaxRates( $view->summaryBasket );
+			$view->summaryTaxRates = $this->getTaxRates($view->summaryBasket);
 
 			$this->cache = $view;
 		}

Doc Comments +1 added lines, -1 removed lines

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

client/html/src/Client/Html/Checkout/Confirm/Order/Standard.php

Indentation +301 added lines, -301 removed lines

@@ -18,306 +18,306 @@
  * @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/checkout/confirm/order/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout confirm order 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 2015.02
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/checkout/confirm/order/standard/subparts';
-
-	/** client/html/checkout/confirm/order/address/name
-	 * Name of the address part used by the checkout confirm order client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Address\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 2015.02
-	 * @category Developer
-	 */
-
-	/** client/html/checkout/confirm/order/service/name
-	 * Name of the service part used by the checkout confirm order client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Service\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 2015.02
-	 * @category Developer
-	 */
-
-	/** client/html/checkout/confirm/order/coupon/name
-	 * Name of the coupon part used by the checkout confirm order client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Coupon\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.05
-	 * @category Developer
-	 */
-
-	/** client/html/checkout/confirm/order/detail/name
-	 * Name of the detail part used by the checkout confirm order client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Detail\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 2015.02
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'address', 'service', 'coupon', 'detail' );
-
-	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->getView();
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->orderBody = $html;
-
-		/** client/html/checkout/confirm/order/standard/template-body
-		 * Relative path to the HTML body template of the checkout confirm order 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 2015.02
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/standard/template-body';
-		$default = 'checkout/confirm/order-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->getView();
-		$view = $this->setViewParams( $view, $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->orderHeader = $html;
-
-		/** client/html/checkout/confirm/order/standard/template-header
-		 * Relative path to the HTML header template of the checkout confirm order 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 2015.02
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/standard/template-header';
-		$default = 'checkout/confirm/order-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/checkout/confirm/order/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout confirm order 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/checkout/confirm/order/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/checkout/confirm/order/decorators/global
-		 * @see client/html/checkout/confirm/order/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/decorators/global
-		 * Adds a list of globally available decorators only to the checkout confirm order 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/checkout/confirm/order/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/checkout/confirm/order/decorators/excludes
-		 * @see client/html/checkout/confirm/order/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/decorators/local
-		 * Adds a list of local decorators only to the checkout confirm order 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/checkout/confirm/order/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/checkout/confirm/order/decorators/excludes
-		 * @see client/html/checkout/confirm/order/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/confirm/order/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
-
-
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			if( isset( $view->confirmOrderItem ) )
-			{
-				$context = $this->getContext();
-				$manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base' );
-
-				$view->summaryBasket = $manager->load( $view->confirmOrderItem->getBaseId() );
-			}
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/checkout/confirm/order/standard/subparts
+     * List of HTML sub-clients rendered within the checkout confirm order 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 2015.02
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/checkout/confirm/order/standard/subparts';
+
+    /** client/html/checkout/confirm/order/address/name
+     * Name of the address part used by the checkout confirm order client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Address\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 2015.02
+     * @category Developer
+     */
+
+    /** client/html/checkout/confirm/order/service/name
+     * Name of the service part used by the checkout confirm order client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Service\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 2015.02
+     * @category Developer
+     */
+
+    /** client/html/checkout/confirm/order/coupon/name
+     * Name of the coupon part used by the checkout confirm order client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Coupon\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.05
+     * @category Developer
+     */
+
+    /** client/html/checkout/confirm/order/detail/name
+     * Name of the detail part used by the checkout confirm order client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Checkout\Confirm\Details\Detail\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 2015.02
+     * @category Developer
+     */
+    private $subPartNames = array( 'address', 'service', 'coupon', 'detail' );
+
+    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->getView();
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->orderBody = $html;
+
+        /** client/html/checkout/confirm/order/standard/template-body
+         * Relative path to the HTML body template of the checkout confirm order 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 2015.02
+         * @category Developer
+         * @see client/html/checkout/confirm/order/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/confirm/order/standard/template-body';
+        $default = 'checkout/confirm/order-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->getView();
+        $view = $this->setViewParams( $view, $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->orderHeader = $html;
+
+        /** client/html/checkout/confirm/order/standard/template-header
+         * Relative path to the HTML header template of the checkout confirm order 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 2015.02
+         * @category Developer
+         * @see client/html/checkout/confirm/order/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/confirm/order/standard/template-header';
+        $default = 'checkout/confirm/order-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/checkout/confirm/order/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout confirm order 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/checkout/confirm/order/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/checkout/confirm/order/decorators/global
+         * @see client/html/checkout/confirm/order/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/decorators/global
+         * Adds a list of globally available decorators only to the checkout confirm order 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/checkout/confirm/order/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/checkout/confirm/order/decorators/excludes
+         * @see client/html/checkout/confirm/order/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/decorators/local
+         * Adds a list of local decorators only to the checkout confirm order 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/checkout/confirm/order/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/checkout/confirm/order/decorators/excludes
+         * @see client/html/checkout/confirm/order/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/confirm/order/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
+
+
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            if( isset( $view->confirmOrderItem ) )
+            {
+                $context = $this->getContext();
+                $manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base' );
+
+                $view->summaryBasket = $manager->load( $view->confirmOrderItem->getBaseId() );
+            }
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

Spacing +19 added lines, -19 removed lines

@@ -99,7 +99,7 @@ 
 	 * @since 2015.02
 	 * @category Developer
 	 */
-	private $subPartNames = array( 'address', 'service', 'coupon', 'detail' );
+	private $subPartNames = array('address', 'service', 'coupon', 'detail');
 
 	private $cache;
 
@@ -112,14 +112,14 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string HTML code
 	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+	public function getBody($uid = '', array &$tags = array(), &$expire = null)
 	{
 		$view = $this->getView();
-		$view = $this->setViewParams( $view, $tags, $expire );
+		$view = $this->setViewParams($view, $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getBody($uid, $tags, $expire);
 		}
 		$view->orderBody = $html;
 
@@ -146,7 +146,7 @@ 
 		$tplconf = 'client/html/checkout/confirm/order/standard/template-body';
 		$default = 'checkout/confirm/order-body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -158,14 +158,14 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return string|null String including HTML tags for the header on error
 	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+	public function getHeader($uid = '', array &$tags = array(), &$expire = null)
 	{
 		$view = $this->getView();
-		$view = $this->setViewParams( $view, $tags, $expire );
+		$view = $this->setViewParams($view, $tags, $expire);
 
 		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+		foreach ($this->getSubClients() as $subclient) {
+			$html .= $subclient->setView($view)->getHeader($uid, $tags, $expire);
 		}
 		$view->orderHeader = $html;
 
@@ -193,7 +193,7 @@ 
 		$tplconf = 'client/html/checkout/confirm/order/standard/template-header';
 		$default = 'checkout/confirm/order-header-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
+		return $view->render($view->config($tplconf, $default));
 	}
 
 
@@ -204,7 +204,7 @@ 
 	 * @param string|null $name Name of the sub-client (Default if null)
 	 * @return \Aimeos\Client\Html\Iface Sub-client object
 	 */
-	public function getSubClient( $type, $name = null )
+	public function getSubClient($type, $name = null)
 	{
 		/** client/html/checkout/confirm/order/decorators/excludes
 		 * Excludes decorators added by the "common" option from the checkout confirm order html client
@@ -280,7 +280,7 @@ 
 		 * @see client/html/checkout/confirm/order/decorators/global
 		 */
 
-		return $this->createSubClient( 'checkout/confirm/order/' . $type, $name );
+		return $this->createSubClient('checkout/confirm/order/'.$type, $name);
 	}
 
 
@@ -291,7 +291,7 @@ 
 	 */
 	protected function getSubClientNames()
 	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+		return $this->getContext()->getConfig()->get($this->subPartPath, $this->subPartNames);
 	}
 
 
@@ -303,16 +303,16 @@ 
 	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
 	 * @return \Aimeos\MW\View\Iface Modified view object
 	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+	protected function setViewParams(\Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null)
 	{
-		if( !isset( $this->cache ) )
+		if (!isset($this->cache))
 		{
-			if( isset( $view->confirmOrderItem ) )
+			if (isset($view->confirmOrderItem))
 			{
 				$context = $this->getContext();
-				$manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base' );
+				$manager = \Aimeos\MShop\Factory::createManager($context, 'order/base');
 
-				$view->summaryBasket = $manager->load( $view->confirmOrderItem->getBaseId() );
+				$view->summaryBasket = $manager->load($view->confirmOrderItem->getBaseId());
 			}
 
 			$this->cache = $view;

Doc Comments +1 added lines, -1 removed lines

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

client/html/src/Client/Html/Checkout/Confirm/Order/Address/Standard.php

Indentation +227 added lines, -227 removed lines

@@ -18,232 +18,232 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Summary\Address\Base
+    extends \Aimeos\Client\Html\Common\Summary\Address\Base
 {
-	/** client/html/checkout/confirm/order/address/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout confirm order address 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 2015.11
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/checkout/confirm/order/address/standard/subparts';
-	private $subPartNames = array();
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	*/
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->addressBody = $html;
-
-		/** client/html/checkout/confirm/order/address/standard/template-body
-		 * Relative path to the HTML body template of the checkout confirm order address 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"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/address/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/address/standard/template-body';
-		$default = 'common/summary/address-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->addressHeader = $html;
-
-		/** client/html/checkout/confirm/order/address/standard/template-header
-		 * Relative path to the HTML header template of the checkout confirm order address 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"
-		 * (second one) should be replaced by the name of the new class in lower
-		 * case.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page head
-		 * @since 2015.11
-		 * @category Developer
-		 * @see client/html/checkout/confirm/order/address/standard/template-body
-		 */
-		$tplconf = 'client/html/checkout/confirm/order/address/standard/template-header';
-		$default = 'common/summary/address-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/checkout/confirm/order/address/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout confirm order address 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/checkout/confirm/order/address/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/checkout/confirm/order/address/decorators/global
-		 * @see client/html/checkout/confirm/order/address/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/address/decorators/global
-		 * Adds a list of globally available decorators only to the checkout confirm order address 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/checkout/confirm/order/address/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/checkout/confirm/order/address/decorators/excludes
-		 * @see client/html/checkout/confirm/order/address/decorators/local
-		 */
-
-		/** client/html/checkout/confirm/order/address/decorators/local
-		 * Adds a list of local decorators only to the checkout confirm order address 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/checkout/confirm/order/address/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/checkout/confirm/order/address/decorators/excludes
-		 * @see client/html/checkout/confirm/order/address/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/confirm/order/address/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /** client/html/checkout/confirm/order/address/standard/subparts
+     * List of HTML sub-clients rendered within the checkout confirm order address 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 2015.11
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/checkout/confirm/order/address/standard/subparts';
+    private $subPartNames = array();
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->addressBody = $html;
+
+        /** client/html/checkout/confirm/order/address/standard/template-body
+         * Relative path to the HTML body template of the checkout confirm order address 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"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/address/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/confirm/order/address/standard/template-body';
+        $default = 'common/summary/address-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->addressHeader = $html;
+
+        /** client/html/checkout/confirm/order/address/standard/template-header
+         * Relative path to the HTML header template of the checkout confirm order address 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"
+         * (second one) should be replaced by the name of the new class in lower
+         * case.
+         *
+         * @param string Relative path to the template creating code for the HTML page head
+         * @since 2015.11
+         * @category Developer
+         * @see client/html/checkout/confirm/order/address/standard/template-body
+         */
+        $tplconf = 'client/html/checkout/confirm/order/address/standard/template-header';
+        $default = 'common/summary/address-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/checkout/confirm/order/address/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout confirm order address 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/checkout/confirm/order/address/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/checkout/confirm/order/address/decorators/global
+         * @see client/html/checkout/confirm/order/address/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/address/decorators/global
+         * Adds a list of globally available decorators only to the checkout confirm order address 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/checkout/confirm/order/address/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/checkout/confirm/order/address/decorators/excludes
+         * @see client/html/checkout/confirm/order/address/decorators/local
+         */
+
+        /** client/html/checkout/confirm/order/address/decorators/local
+         * Adds a list of local decorators only to the checkout confirm order address 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/checkout/confirm/order/address/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/checkout/confirm/order/address/decorators/excludes
+         * @see client/html/checkout/confirm/order/address/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/confirm/order/address/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 }
\ No newline at end of file

Spacing +13 added lines, -13 removed lines

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

Doc Comments +1 added lines, -1 removed lines

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