aimeos / ai-client-html

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

Indentation +35 added lines, -35 removed lines

@@ -19,48 +19,48 @@
  */
 class Factory
 {
-	/**
-	 * Creates a new client object.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
-	 * @param array List of file system paths where the templates are stored
-	 * @param string $type Type of the client, e.g 'account/favorite' for \Aimeos\Client\Html\Account\Favorite\Standard
-	 * @param string|null $name Client name (default: "Standard")
-	 * @return \Aimeos\Client\Html\Iface HTML client 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, $type, $name = null )
-	{
-		if( empty( $type ) ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Client HTML type is empty' ) );
-		}
+    /**
+     * Creates a new client object.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Shop context instance with necessary objects
+     * @param array List of file system paths where the templates are stored
+     * @param string $type Type of the client, e.g 'account/favorite' for \Aimeos\Client\Html\Account\Favorite\Standard
+     * @param string|null $name Client name (default: "Standard")
+     * @return \Aimeos\Client\Html\Iface HTML client 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, $type, $name = null )
+    {
+        if( empty( $type ) ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Client HTML type is empty' ) );
+        }
 
-		$parts = explode( '/', $type );
+        $parts = explode( '/', $type );
 
-		if( count( $parts ) !== 2 ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Client type "%1$s" must consist of two parts separated by "/"', $type ) );
-		}
+        if( count( $parts ) !== 2 ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Client type "%1$s" must consist of two parts separated by "/"', $type ) );
+        }
 
-		foreach( $parts as $part )
-		{
-			if( ctype_alnum( $part ) === false ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s" in "%2$s"', $part, $type ) );
-			}
-		}
+        foreach( $parts as $part )
+        {
+            if( ctype_alnum( $part ) === false ) {
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid characters in client name "%1$s" in "%2$s"', $part, $type ) );
+            }
+        }
 
-		$factory = '\\Aimeos\\Client\\Html\\' . ucwords( $parts[0] ) . '\\' . ucwords( $parts[1] ) . '\\Factory';
+        $factory = '\\Aimeos\\Client\\Html\\' . ucwords( $parts[0] ) . '\\' . ucwords( $parts[1] ) . '\\Factory';
 
-		if( class_exists( $factory ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $factory ) );
-		}
+        if( class_exists( $factory ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $factory ) );
+        }
 
-		$client = @call_user_func_array( array( $factory, 'createClient' ), array( $context, $templatePaths, $name ) );
+        $client = @call_user_func_array( array( $factory, 'createClient' ), array( $context, $templatePaths, $name ) );
 
-		if( $client === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid factory "%1$s"', $factory ) );
-		}
+        if( $client === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid factory "%1$s"', $factory ) );
+        }
 
-		return $client;
-	}
+        return $client;
+    }
 
 }
\ No newline at end of file

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

Indentation +54 added lines, -54 removed lines

@@ -19,66 +19,66 @@
  * @subpackage Html
  */
 abstract class Base
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
 {
-	/**
-	 * Removes all cached basket parts from the cache.
-	 */
-	protected function clearCached()
-	{
-		$session = $this->getContext()->getSession();
+    /**
+     * Removes all cached basket parts from the cache.
+     */
+    protected function clearCached()
+    {
+        $session = $this->getContext()->getSession();
 
-		foreach( $session->get( 'aimeos/basket/cache', array() ) as $key => $value ) {
-			$session->set( $key, null );
-		}
-	}
+        foreach( $session->get( 'aimeos/basket/cache', array() ) as $key => $value ) {
+            $session->set( $key, null );
+        }
+    }
 
 
-	/**
-	 * Returns the basket cache entry from the cache if available.
-	 *
-	 * @param string $key Path to the requested cache entry
-	 * @param mixed $default Value returned if requested key isn't found
-	 * @return mixed Value associated to the requested key. If no value for the
-	 *	key is found in the cache, the given default value is returned
-	 */
-	protected function getBasketCached( $key, $default = null )
-	{
-		return $this->getContext()->getSession()->get( $key, $default );
-	}
+    /**
+     * Returns the basket cache entry from the cache if available.
+     *
+     * @param string $key Path to the requested cache entry
+     * @param mixed $default Value returned if requested key isn't found
+     * @return mixed Value associated to the requested key. If no value for the
+     *	key is found in the cache, the given default value is returned
+     */
+    protected function getBasketCached( $key, $default = null )
+    {
+        return $this->getContext()->getSession()->get( $key, $default );
+    }
 
 
-	/**
-	 * Adds or overwrite a cache entry for the given key and value.
-	 *
-	 * @param string $key Path the cache entry should be stored in
-	 * @param mixed $value Value stored in the cache for the path
-	 */
-	protected function setBasketCached( $key, $value )
-	{
-		$context = $this->getContext();
+    /**
+     * Adds or overwrite a cache entry for the given key and value.
+     *
+     * @param string $key Path the cache entry should be stored in
+     * @param mixed $value Value stored in the cache for the path
+     */
+    protected function setBasketCached( $key, $value )
+    {
+        $context = $this->getContext();
 
-		/** client/html/basket/cache/enable
-		 * Enables or disables caching of the basket content
-		 *
-		 * For performance reasons, the content of the small baskets is cached
-		 * in the session of the customer. The cache is updated each time the
-		 * basket content changes either by adding, deleting or editing products.
-		 *
-		 * To ease development, the caching can be disabled but you shouldn't
-		 * disable it in your production environment!
-		 *
-		 * @param boolean True to enable, false to disable basket content caching
-		 * @category Developer
-		 * @since 2014.11
-		 */
-		if( $context->getConfig()->get( 'client/html/basket/cache/enable', true ) != false )
-		{
-			$session = $context->getSession();
+        /** client/html/basket/cache/enable
+         * Enables or disables caching of the basket content
+         *
+         * For performance reasons, the content of the small baskets is cached
+         * in the session of the customer. The cache is updated each time the
+         * basket content changes either by adding, deleting or editing products.
+         *
+         * To ease development, the caching can be disabled but you shouldn't
+         * disable it in your production environment!
+         *
+         * @param boolean True to enable, false to disable basket content caching
+         * @category Developer
+         * @since 2014.11
+         */
+        if( $context->getConfig()->get( 'client/html/basket/cache/enable', true ) != false )
+        {
+            $session = $context->getSession();
 
-			$cached = $session->get( 'aimeos/basket/cache', array() ) + array( $key => true );
-			$session->set( 'aimeos/basket/cache', $cached );
-			$session->set( $key, $value );
-		}
-	}
+            $cached = $session->get( 'aimeos/basket/cache', array() ) + array( $key => true );
+            $session->set( 'aimeos/basket/cache', $cached );
+            $session->set( $key, $value );
+        }
+    }
 }

client/html/src/Client/Html/Basket/Standard/Coupon/Standard.php

Indentation +287 added lines, -287 removed lines

@@ -19,292 +19,292 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Basket\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Basket\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/basket/standard/coupon/standard/subparts
-	 * List of HTML sub-clients rendered within the basket standard 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 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/basket/standard/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/basket/standard/coupon/standard/template-body
-		 * Relative path to the HTML body template of the basket standard 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"
-		 * 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/basket/standard/coupon/standard/template-header
-		 */
-		$tplconf = 'client/html/basket/standard/coupon/standard/template-body';
-		$default = 'basket/standard/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/basket/standard/coupon/standard/template-header
-		 * Relative path to the HTML header template of the basket standard 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"
-		 * 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/basket/standard/coupon/standard/template-body
-		 */
-		$tplconf = 'client/html/basket/standard/coupon/standard/template-header';
-		$default = 'basket/standard/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/basket/standard/coupon/decorators/excludes
-		 * Excludes decorators added by the "common" option from the basket standard 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/basket/standard/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/basket/standard/coupon/decorators/global
-		 * @see client/html/basket/standard/coupon/decorators/local
-		 */
-
-		/** client/html/basket/standard/coupon/decorators/global
-		 * Adds a list of globally available decorators only to the basket standard 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/basket/standard/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/basket/standard/coupon/decorators/excludes
-		 * @see client/html/basket/standard/coupon/decorators/local
-		 */
-
-		/** client/html/basket/standard/coupon/decorators/local
-		 * Adds a list of local decorators only to the basket standard 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\Basket\Decorator\*") around the html client.
-		 *
-		 *  client/html/basket/standard/coupon/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Basket\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/basket/standard/coupon/decorators/excludes
-		 * @see client/html/basket/standard/coupon/decorators/global
-		 */
-		return $this->createSubClient( 'basket/standard/coupon/' . $type, $name );
-	}
-
-
-	/**
-	 * Processes the input, e.g. store given values.
-	 * A view must be available and this method doesn't generate any output
-	 * besides setting view variables.
-	 */
-	public function process()
-	{
-		$view = $this->getView();
-		$context = $this->getContext();
-
-		switch( $view->param( 'b_action' ) )
-		{
-			case 'coupon-delete':
-
-				if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
-				{
-					$this->clearCached();
-					$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-					$cntl->deleteCoupon( $coupon );
-				}
-
-				break;
-
-			default:
-
-				if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
-				{
-					$this->clearCached();
-					$cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
-
-					/** client/html/basket/standard/coupon/allowed
-					 * Number of coupon codes a customer is allowed to enter
-					 *
-					 * This configuration option enables shop owners to limit the number of coupon
-					 * codes that can be added by a customer to his current basket. By default, only
-					 * one coupon code is allowed per order.
-					 *
-					 * Coupon codes are valid until a payed order is placed by the customer. The
-					 * "count" of the codes is decreased afterwards. If codes are not personalized
-					 * the codes can be reused in the next order until their "count" reaches zero.
-					 *
-					 * @param integer Positive number of coupon codes including zero
-					 * @since 2014.05
-					 * @category User
-					 * @category Developer
-					 */
-					$allowed = $context->getConfig()->get( 'client/html/basket/standard/coupon/allowed', 1 );
-
-					if( $allowed <= count( $cntl->get()->getCoupons() ) ) {
-						throw new \Aimeos\Client\Html\Exception( sprintf( 'Number of coupon codes exceeds the limit' ) );
-					}
-
-					$cntl->addCoupon( $coupon );
-				}
-
-				break;
-		}
-
-		parent::process();
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /** client/html/basket/standard/coupon/standard/subparts
+     * List of HTML sub-clients rendered within the basket standard 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 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/basket/standard/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/basket/standard/coupon/standard/template-body
+         * Relative path to the HTML body template of the basket standard 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"
+         * 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/basket/standard/coupon/standard/template-header
+         */
+        $tplconf = 'client/html/basket/standard/coupon/standard/template-body';
+        $default = 'basket/standard/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/basket/standard/coupon/standard/template-header
+         * Relative path to the HTML header template of the basket standard 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"
+         * 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/basket/standard/coupon/standard/template-body
+         */
+        $tplconf = 'client/html/basket/standard/coupon/standard/template-header';
+        $default = 'basket/standard/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/basket/standard/coupon/decorators/excludes
+         * Excludes decorators added by the "common" option from the basket standard 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/basket/standard/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/basket/standard/coupon/decorators/global
+         * @see client/html/basket/standard/coupon/decorators/local
+         */
+
+        /** client/html/basket/standard/coupon/decorators/global
+         * Adds a list of globally available decorators only to the basket standard 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/basket/standard/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/basket/standard/coupon/decorators/excludes
+         * @see client/html/basket/standard/coupon/decorators/local
+         */
+
+        /** client/html/basket/standard/coupon/decorators/local
+         * Adds a list of local decorators only to the basket standard 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\Basket\Decorator\*") around the html client.
+         *
+         *  client/html/basket/standard/coupon/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Basket\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/basket/standard/coupon/decorators/excludes
+         * @see client/html/basket/standard/coupon/decorators/global
+         */
+        return $this->createSubClient( 'basket/standard/coupon/' . $type, $name );
+    }
+
+
+    /**
+     * Processes the input, e.g. store given values.
+     * A view must be available and this method doesn't generate any output
+     * besides setting view variables.
+     */
+    public function process()
+    {
+        $view = $this->getView();
+        $context = $this->getContext();
+
+        switch( $view->param( 'b_action' ) )
+        {
+            case 'coupon-delete':
+
+                if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
+                {
+                    $this->clearCached();
+                    $cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+                    $cntl->deleteCoupon( $coupon );
+                }
+
+                break;
+
+            default:
+
+                if( ( $coupon = $view->param( 'b_coupon' ) ) != '' )
+                {
+                    $this->clearCached();
+                    $cntl = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' );
+
+                    /** client/html/basket/standard/coupon/allowed
+                     * Number of coupon codes a customer is allowed to enter
+                     *
+                     * This configuration option enables shop owners to limit the number of coupon
+                     * codes that can be added by a customer to his current basket. By default, only
+                     * one coupon code is allowed per order.
+                     *
+                     * Coupon codes are valid until a payed order is placed by the customer. The
+                     * "count" of the codes is decreased afterwards. If codes are not personalized
+                     * the codes can be reused in the next order until their "count" reaches zero.
+                     *
+                     * @param integer Positive number of coupon codes including zero
+                     * @since 2014.05
+                     * @category User
+                     * @category Developer
+                     */
+                    $allowed = $context->getConfig()->get( 'client/html/basket/standard/coupon/allowed', 1 );
+
+                    if( $allowed <= count( $cntl->get()->getCoupons() ) ) {
+                        throw new \Aimeos\Client\Html\Exception( sprintf( 'Number of coupon codes exceeds the limit' ) );
+                    }
+
+                    $cntl->addCoupon( $coupon );
+                }
+
+                break;
+        }
+
+        parent::process();
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 }
\ No newline at end of file

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

Indentation +240 added lines, -240 removed lines

@@ -19,268 +19,268 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Summary\Detail\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Summary\Detail\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/basket/standard/detail/standard/subparts
-	 * List of HTML sub-clients rendered within the basket standard 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/basket/standard/detail/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
+    /** client/html/basket/standard/detail/standard/subparts
+     * List of HTML sub-clients rendered within the basket standard 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/basket/standard/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/basket/standard/detail/standard/template-body
-		 * Relative path to the HTML body template of the basket standard 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/basket/standard/detail/standard/template-header
-		 */
-		$tplconf = 'client/html/basket/standard/detail/standard/template-body';
-		$default = 'common/summary/detail-body-default.php';
+        /** client/html/basket/standard/detail/standard/template-body
+         * Relative path to the HTML body template of the basket standard 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/basket/standard/detail/standard/template-header
+         */
+        $tplconf = 'client/html/basket/standard/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/basket/standard/detail/standard/template-header
-		 * Relative path to the HTML header template of the basket standard 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/basket/standard/detail/standard/template-body
-		 */
-		$tplconf = 'client/html/basket/standard/detail/standard/template-header';
-		$default = 'common/summary/detail-header-default.php';
+        /** client/html/basket/standard/detail/standard/template-header
+         * Relative path to the HTML header template of the basket standard 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/basket/standard/detail/standard/template-body
+         */
+        $tplconf = 'client/html/basket/standard/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/basket/standard/detail/decorators/excludes
-		 * Excludes decorators added by the "common" option from the basket standard 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/basket/standard/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/basket/standard/detail/decorators/global
-		 * @see client/html/basket/standard/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/basket/standard/detail/decorators/excludes
+         * Excludes decorators added by the "common" option from the basket standard 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/basket/standard/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/basket/standard/detail/decorators/global
+         * @see client/html/basket/standard/detail/decorators/local
+         */
 
-		/** client/html/basket/standard/detail/decorators/global
-		 * Adds a list of globally available decorators only to the basket standard 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/basket/standard/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/basket/standard/detail/decorators/excludes
-		 * @see client/html/basket/standard/detail/decorators/local
-		 */
+        /** client/html/basket/standard/detail/decorators/global
+         * Adds a list of globally available decorators only to the basket standard 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/basket/standard/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/basket/standard/detail/decorators/excludes
+         * @see client/html/basket/standard/detail/decorators/local
+         */
 
-		/** client/html/basket/standard/detail/decorators/local
-		 * Adds a list of local decorators only to the basket standard 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\Basket\Decorator\*") around the html client.
-		 *
-		 *  client/html/basket/standard/detail/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Basket\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/basket/standard/detail/decorators/excludes
-		 * @see client/html/basket/standard/detail/decorators/global
-		 */
-		return $this->createSubClient( 'basket/standard/detail/' . $type, $name );
-	}
+        /** client/html/basket/standard/detail/decorators/local
+         * Adds a list of local decorators only to the basket standard 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\Basket\Decorator\*") around the html client.
+         *
+         *  client/html/basket/standard/detail/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Basket\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/basket/standard/detail/decorators/excludes
+         * @see client/html/basket/standard/detail/decorators/global
+         */
+        return $this->createSubClient( 'basket/standard/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 )
-	{
-		$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 )
+    {
+        $view = parent::setViewParams( $view );
 
-		if( !isset( $this->cache ) )
-		{
-			$basket = $view->standardBasket;
+        if( !isset( $this->cache ) )
+        {
+            $basket = $view->standardBasket;
 
-			$target = $view->config( 'client/html/checkout/standard/url/target' );
-			$cntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
-			$action = $view->config( 'client/html/checkout/standard/url/action', 'index' );
-			$config = $view->config( 'client/html/checkout/standard/url/config', array() );
+            $target = $view->config( 'client/html/checkout/standard/url/target' );
+            $cntl = $view->config( 'client/html/checkout/standard/url/controller', 'checkout' );
+            $action = $view->config( 'client/html/checkout/standard/url/action', 'index' );
+            $config = $view->config( 'client/html/checkout/standard/url/config', array() );
 
-			$view->summaryParams = $view->get( 'standardParams', array() );
-			$view->summaryUrlServicePayment = $view->url( $target, $cntl, $action, array( 'c_step' => 'payment' ), array(), $config );
-			$view->summaryUrlServiceDelivery = $view->url( $target, $cntl, $action, array( 'c_step' => 'delivery' ), array(), $config );
-			$view->summaryTaxRates = $this->getTaxRates( $basket );
-			$view->summaryEnableModify = true;
-			$view->summaryBasket = $basket;
+            $view->summaryParams = $view->get( 'standardParams', array() );
+            $view->summaryUrlServicePayment = $view->url( $target, $cntl, $action, array( 'c_step' => 'payment' ), array(), $config );
+            $view->summaryUrlServiceDelivery = $view->url( $target, $cntl, $action, array( 'c_step' => 'delivery' ), array(), $config );
+            $view->summaryTaxRates = $this->getTaxRates( $basket );
+            $view->summaryEnableModify = true;
+            $view->summaryBasket = $basket;
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file

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

client/html/src/Client/Html/Basket/Related/Bought/Standard.php

Indentation +375 added lines, -375 removed lines

@@ -18,380 +18,380 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Basket\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Basket\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/basket/related/bought/standard/subparts
-	 * List of HTML sub-clients rendered within the basket related bought 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/basket/related/bought/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 );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->boughtBody = $html;
-
-		/** client/html/basket/related/bought/standard/template-body
-		 * Relative path to the HTML body template of the basket related bought 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/basket/related/bought/standard/template-header
-		 */
-		$tplconf = 'client/html/basket/related/bought/standard/template-body';
-		$default = 'basket/related/bought-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->boughtHeader = $html;
-
-		/** client/html/basket/related/bought/standard/template-header
-		 * Relative path to the HTML header template of the basket related bought 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/basket/related/bought/standard/template-body
-		 */
-		$tplconf = 'client/html/basket/related/bought/standard/template-header';
-		$default = 'basket/related/bought-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/basket/related/bought/decorators/excludes
-		 * Excludes decorators added by the "common" option from the basket related bought 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/basket/related/bought/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/basket/related/bought/decorators/global
-		 * @see client/html/basket/related/bought/decorators/local
-		 */
-
-		/** client/html/basket/related/bought/decorators/global
-		 * Adds a list of globally available decorators only to the basket related bought 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/basket/related/bought/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/basket/related/bought/decorators/excludes
-		 * @see client/html/basket/related/bought/decorators/local
-		 */
-
-		/** client/html/basket/related/bought/decorators/local
-		 * Adds a list of local decorators only to the basket related bought 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\Basket\Decorator\*") around the html client.
-		 *
-		 *  client/html/basket/related/bought/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Basket\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/basket/related/bought/decorators/excludes
-		 * @see client/html/basket/related/bought/decorators/global
-		 */
-
-		return $this->createSubClient( 'basket/related/bought/' . $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->relatedBasket ) )
-			{
-				$refIds = $items = array();
-				$context = $this->getContext();
-
-				$prodIds = $this->getProductIdsFromBasket( $view->relatedBasket );
-
-				foreach( $this->getListItems( $prodIds ) as $listItem )
-				{
-					$refId = $listItem->getRefId();
-
-					if( !isset( $prodIds[$refId] ) ) {
-						$refIds[$refId] = $refId;
-					}
-				}
-
-				$products = $this->getProductItems( $refIds );
-
-				foreach( $refIds as $id )
-				{
-					if( isset( $products[$id] ) ) {
-						$items[$id] = $products[$id];
-					}
-				}
-
-				/** client/html/basket/related/bought/standard/limit
-				 * Number of items in the list of bought together products
-				 *
-				 * This option limits the number of suggested products in the
-				 * list of bought together products. The suggested items are
-				 * calculated using the products that are in the current basket
-				 * of the customer.
-				 *
-				 * Note: You need to start the job controller for calculating
-				 * the bought together products regularly to get up to date
-				 * product suggestions.
-				 *
-				 * @param integer Number of products
-				 * @since 2014.09
-				 */
-				$size = $context->getConfig()->get( 'client/html/basket/related/bought/standard/limit', 6 );
-
-
-				$view->boughtItems = array_slice( $items, 0, $size, true );
-			}
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
-
-
-	/**
-	 * Returns the list items of type "bought-together" associated to the given product IDs.
-	 *
-	 * @param string[] $prodIds List of product IDs
-	 * @return \Aimeos\MShop\Product\Item\Lists\Iface[] List of product list items
-	 */
-	protected function getListItems( array $prodIds )
-	{
-		$typeItem = $this->getTypeItem( 'product/lists/type', 'product', 'bought-together' );
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/lists' );
-
-		$search = $manager->createSearch( true );
-		$expr = array(
-				$search->compare( '==', 'product.lists.parentid', $prodIds ),
-				$search->compare( '==', 'product.lists.typeid', $typeItem->getId() ),
-				$search->compare( '==', 'product.lists.domain', 'product' ),
-				$search->getConditions(),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSortations( array( $search->sort( '+', 'product.lists.position' ) ) );
-
-		return $manager->searchItems( $search );
-	}
-
-
-	/**
-	 * Returns the IDs of the products in the current basket.
-	 *
-	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
-	 * @return string[] List of product IDs
-	 */
-	protected function getProductIdsFromBasket( \Aimeos\MShop\Order\Item\Base\Iface $basket )
-	{
-		$list = array();
-
-		foreach( $basket->getProducts() as $orderProduct )
-		{
-			$list[ $orderProduct->getProductId() ] = true;
-
-			foreach( $orderProduct->getProducts() as $subProduct ) {
-				$list[ $subProduct->getProductId() ] = true;
-			}
-		}
-
-		return array_keys( $list );
-	}
-
-
-	/**
-	 * Returns the product items for the given IDs.
-	 *
-	 * @param string[] $ids List of product IDs
-	 * @return \Aimeos\MShop\Product\Item\Iface[] List of product items
-	 */
-	protected function getProductItems( array $ids )
-	{
-		$context = $this->getContext();
-		$config = $context->getConfig();
-
-		/** client/html/basket/related/bought/standard/domains
-		 * The list of domain names whose items should be available in the template for the products
-		 *
-		 * The templates rendering product details usually add the images,
-		 * prices and texts, etc. associated to the product
-		 * item. If you want to display additional or less content, you can
-		 * configure your own list of domains (attribute, media, price, product,
-		 * text, etc. are domains) whose items are fetched from the storage.
-		 * Please keep in mind that the more domains you add to the configuration,
-		 * the more time is required for fetching the content!
-		 *
-		 * @param array List of domain names
-		 * @since 2014.09
-		 * @category Developer
-		 */
-		$domains = array( 'text', 'price', 'media' );
-		$domains = $config->get( 'client/html/basket/related/bought/standard/domains', $domains );
-
-		$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-		return $controller->getProductItems( $ids, $domains );
-	}
+    /** client/html/basket/related/bought/standard/subparts
+     * List of HTML sub-clients rendered within the basket related bought 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/basket/related/bought/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 );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->boughtBody = $html;
+
+        /** client/html/basket/related/bought/standard/template-body
+         * Relative path to the HTML body template of the basket related bought 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/basket/related/bought/standard/template-header
+         */
+        $tplconf = 'client/html/basket/related/bought/standard/template-body';
+        $default = 'basket/related/bought-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->boughtHeader = $html;
+
+        /** client/html/basket/related/bought/standard/template-header
+         * Relative path to the HTML header template of the basket related bought 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/basket/related/bought/standard/template-body
+         */
+        $tplconf = 'client/html/basket/related/bought/standard/template-header';
+        $default = 'basket/related/bought-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/basket/related/bought/decorators/excludes
+         * Excludes decorators added by the "common" option from the basket related bought 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/basket/related/bought/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/basket/related/bought/decorators/global
+         * @see client/html/basket/related/bought/decorators/local
+         */
+
+        /** client/html/basket/related/bought/decorators/global
+         * Adds a list of globally available decorators only to the basket related bought 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/basket/related/bought/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/basket/related/bought/decorators/excludes
+         * @see client/html/basket/related/bought/decorators/local
+         */
+
+        /** client/html/basket/related/bought/decorators/local
+         * Adds a list of local decorators only to the basket related bought 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\Basket\Decorator\*") around the html client.
+         *
+         *  client/html/basket/related/bought/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Basket\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/basket/related/bought/decorators/excludes
+         * @see client/html/basket/related/bought/decorators/global
+         */
+
+        return $this->createSubClient( 'basket/related/bought/' . $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->relatedBasket ) )
+            {
+                $refIds = $items = array();
+                $context = $this->getContext();
+
+                $prodIds = $this->getProductIdsFromBasket( $view->relatedBasket );
+
+                foreach( $this->getListItems( $prodIds ) as $listItem )
+                {
+                    $refId = $listItem->getRefId();
+
+                    if( !isset( $prodIds[$refId] ) ) {
+                        $refIds[$refId] = $refId;
+                    }
+                }
+
+                $products = $this->getProductItems( $refIds );
+
+                foreach( $refIds as $id )
+                {
+                    if( isset( $products[$id] ) ) {
+                        $items[$id] = $products[$id];
+                    }
+                }
+
+                /** client/html/basket/related/bought/standard/limit
+                 * Number of items in the list of bought together products
+                 *
+                 * This option limits the number of suggested products in the
+                 * list of bought together products. The suggested items are
+                 * calculated using the products that are in the current basket
+                 * of the customer.
+                 *
+                 * Note: You need to start the job controller for calculating
+                 * the bought together products regularly to get up to date
+                 * product suggestions.
+                 *
+                 * @param integer Number of products
+                 * @since 2014.09
+                 */
+                $size = $context->getConfig()->get( 'client/html/basket/related/bought/standard/limit', 6 );
+
+
+                $view->boughtItems = array_slice( $items, 0, $size, true );
+            }
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
+
+
+    /**
+     * Returns the list items of type "bought-together" associated to the given product IDs.
+     *
+     * @param string[] $prodIds List of product IDs
+     * @return \Aimeos\MShop\Product\Item\Lists\Iface[] List of product list items
+     */
+    protected function getListItems( array $prodIds )
+    {
+        $typeItem = $this->getTypeItem( 'product/lists/type', 'product', 'bought-together' );
+        $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'product/lists' );
+
+        $search = $manager->createSearch( true );
+        $expr = array(
+                $search->compare( '==', 'product.lists.parentid', $prodIds ),
+                $search->compare( '==', 'product.lists.typeid', $typeItem->getId() ),
+                $search->compare( '==', 'product.lists.domain', 'product' ),
+                $search->getConditions(),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+        $search->setSortations( array( $search->sort( '+', 'product.lists.position' ) ) );
+
+        return $manager->searchItems( $search );
+    }
+
+
+    /**
+     * Returns the IDs of the products in the current basket.
+     *
+     * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket object
+     * @return string[] List of product IDs
+     */
+    protected function getProductIdsFromBasket( \Aimeos\MShop\Order\Item\Base\Iface $basket )
+    {
+        $list = array();
+
+        foreach( $basket->getProducts() as $orderProduct )
+        {
+            $list[ $orderProduct->getProductId() ] = true;
+
+            foreach( $orderProduct->getProducts() as $subProduct ) {
+                $list[ $subProduct->getProductId() ] = true;
+            }
+        }
+
+        return array_keys( $list );
+    }
+
+
+    /**
+     * Returns the product items for the given IDs.
+     *
+     * @param string[] $ids List of product IDs
+     * @return \Aimeos\MShop\Product\Item\Iface[] List of product items
+     */
+    protected function getProductItems( array $ids )
+    {
+        $context = $this->getContext();
+        $config = $context->getConfig();
+
+        /** client/html/basket/related/bought/standard/domains
+         * The list of domain names whose items should be available in the template for the products
+         *
+         * The templates rendering product details usually add the images,
+         * prices and texts, etc. associated to the product
+         * item. If you want to display additional or less content, you can
+         * configure your own list of domains (attribute, media, price, product,
+         * text, etc. are domains) whose items are fetched from the storage.
+         * Please keep in mind that the more domains you add to the configuration,
+         * the more time is required for fetching the content!
+         *
+         * @param array List of domain names
+         * @since 2014.09
+         * @category Developer
+         */
+        $domains = array( 'text', 'price', 'media' );
+        $domains = $config->get( 'client/html/basket/related/bought/standard/domains', $domains );
+
+        $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+        return $controller->getProductItems( $ids, $domains );
+    }
 }
\ No newline at end of file

client/html/src/Client/Html/Basket/Related/Factory.php

Indentation +59 added lines, -59 removed lines

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

client/html/src/Client/Html/Basket/Related/Standard.php

Indentation +272 added lines, -272 removed lines

@@ -18,302 +18,302 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Basket\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Basket\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/basket/related/standard/subparts
-	 * List of HTML sub-clients rendered within the basket related 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/basket/related/standard/subparts';
+    /** client/html/basket/related/standard/subparts
+     * List of HTML sub-clients rendered within the basket related 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/basket/related/standard/subparts';
 
-	/** client/html/basket/related/bought/name
-	 * Name of the bought together part used by the basket related client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Related\Bought\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.09
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'bought' );
-	private $cache;
+    /** client/html/basket/related/bought/name
+     * Name of the bought together part used by the basket related client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Basket\Related\Bought\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.09
+     * @category Developer
+     */
+    private $subPartNames = array( 'bought' );
+    private $cache;
 
 
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
 
-		try
-		{
-			$view = $this->setViewParams( $view, $tags, $expire );
+        try
+        {
+            $view = $this->setViewParams( $view, $tags, $expire );
 
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->relatedBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->relatedErrorList = $view->get( 'relatedErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->relatedErrorList = $view->get( 'relatedErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->relatedErrorList = $view->get( 'relatedErrorList', array() ) + $error;
-		}
-		catch( \Exception $e )
-		{
-			$context->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->relatedBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->relatedErrorList = $view->get( 'relatedErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->relatedErrorList = $view->get( 'relatedErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->relatedErrorList = $view->get( 'relatedErrorList', 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->relatedErrorList = $view->get( 'relatedErrorList', array() ) + $error;
-		}
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->relatedErrorList = $view->get( 'relatedErrorList', array() ) + $error;
+        }
 
-		/** client/html/basket/related/standard/template-body
-		 * Relative path to the HTML body template of the basket related 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/basket/related/standard/template-header
-		 */
-		$tplconf = 'client/html/basket/related/standard/template-body';
-		$default = 'basket/related/body-default.php';
+        /** client/html/basket/related/standard/template-body
+         * Relative path to the HTML body template of the basket related 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/basket/related/standard/template-header
+         */
+        $tplconf = 'client/html/basket/related/standard/template-body';
+        $default = 'basket/related/body-default.php';
 
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
 
 
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		try
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
 
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->relatedHeader = $html;
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-			return '';
-		}
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->relatedHeader = $html;
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+            return '';
+        }
 
-		/** client/html/basket/related/standard/template-header
-		 * Relative path to the HTML header template of the basket related 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/basket/related/standard/template-body
-		 */
-		$tplconf = 'client/html/basket/related/standard/template-header';
-		$default = 'basket/related/header-default.php';
+        /** client/html/basket/related/standard/template-header
+         * Relative path to the HTML header template of the basket related 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/basket/related/standard/template-body
+         */
+        $tplconf = 'client/html/basket/related/standard/template-header';
+        $default = 'basket/related/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/basket/related/decorators/excludes
-		 * Excludes decorators added by the "common" option from the basket related 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/basket/related/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/basket/related/decorators/global
-		 * @see client/html/basket/related/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/basket/related/decorators/excludes
+         * Excludes decorators added by the "common" option from the basket related 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/basket/related/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/basket/related/decorators/global
+         * @see client/html/basket/related/decorators/local
+         */
 
-		/** client/html/basket/related/decorators/global
-		 * Adds a list of globally available decorators only to the basket related 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/basket/related/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/basket/related/decorators/excludes
-		 * @see client/html/basket/related/decorators/local
-		 */
+        /** client/html/basket/related/decorators/global
+         * Adds a list of globally available decorators only to the basket related 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/basket/related/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/basket/related/decorators/excludes
+         * @see client/html/basket/related/decorators/local
+         */
 
-		/** client/html/basket/related/decorators/local
-		 * Adds a list of local decorators only to the basket related 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\Basket\Decorator\*") around the html client.
-		 *
-		 *  client/html/basket/related/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Basket\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/basket/related/decorators/excludes
-		 * @see client/html/basket/related/decorators/global
-		 */
+        /** client/html/basket/related/decorators/local
+         * Adds a list of local decorators only to the basket related 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\Basket\Decorator\*") around the html client.
+         *
+         *  client/html/basket/related/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Basket\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/basket/related/decorators/excludes
+         * @see client/html/basket/related/decorators/global
+         */
 
-		return $this->createSubClient( 'basket/related/' . $type, $name );
-	}
+        return $this->createSubClient( 'basket/related/' . $type, $name );
+    }
 
 
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 
 
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$context = $this->getContext();
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $context = $this->getContext();
 
-			$view->relatedBasket = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' )->get();
+            $view->relatedBasket = \Aimeos\Controller\Frontend\Factory::createController( $context, 'basket' )->get();
 
-			$this->cache = $view;
-		}
+            $this->cache = $view;
+        }
 
-		return $this->cache;
-	}
+        return $this->cache;
+    }
 }
\ No newline at end of file

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