aimeos / ai-client-html

client/html/src/Client/Html/Checkout/Update/Standard.php

Indentation +401 added lines, -401 removed lines

@@ -19,406 +19,406 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/checkout/update/standard/subparts
-	 * List of HTML sub-clients rendered within the checkout update section
-	 *
-	 * The output of the frontend is composed of the code generated by the HTML
-	 * clients. Each HTML client can consist of serveral (or none) sub-clients
-	 * that are responsible for rendering certain sub-parts of the output. The
-	 * sub-clients can contain HTML clients themselves and therefore a
-	 * hierarchical tree of HTML clients is composed. Each HTML client creates
-	 * the output that is placed inside the container of its parent.
-	 *
-	 * At first, always the HTML code generated by the parent is printed, then
-	 * the HTML code of its sub-clients. The order of the HTML sub-clients
-	 * determines the order of the output of these sub-clients inside the parent
-	 * container. If the configured list of clients is
-	 *
-	 *  array( "subclient1", "subclient2" )
-	 *
-	 * you can easily change the order of the output by reordering the subparts:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
-	 *
-	 * You can also remove one or more parts if they shouldn't be rendered:
-	 *
-	 *  client/html/<clients>/subparts = array( "subclient1" )
-	 *
-	 * As the clients only generates structural HTML, the layout defined via CSS
-	 * should support adding, removing or reordering content by a fluid like
-	 * design.
-	 *
-	 * @param array List of sub-client names
-	 * @since 2014.03
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/checkout/update/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 )
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
-
-		try
-		{
-			$view = $this->setViewParams( $view, $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->updateBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->updateErrorList = $view->get( 'updateErrorList', 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->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
-		}
-
-		/** client/html/checkout/update/standard/template-body
-		 * Relative path to the HTML body template of the checkout update client.
-		 *
-		 * The template file contains the HTML code and processing instructions
-		 * to generate the result shown in the body of the frontend. The
-		 * configuration string is the path to the template file relative
-		 * to the templates directory (usually in client/html/templates).
-		 *
-		 * You can overwrite the template file configuration in extensions and
-		 * provide alternative templates. These alternative templates should be
-		 * named like the default one but with the string "standard" replaced by
-		 * an unique name. You may use the name of your project for this. If
-		 * you've implemented an alternative client class as well, "standard"
-		 * should be replaced by the name of the new class.
-		 *
-		 * @param string Relative path to the template creating code for the HTML page body
-		 * @since 2014.03
-		 * @category Developer
-		 * @see client/html/checkout/update/standard/template-header
-		 */
-		$tplconf = 'client/html/checkout/update/standard/template-body';
-		$default = 'checkout/update/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 )
-	{
-		try
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->updateHeader = $html;
-
-			/** client/html/checkout/update/standard/template-header
-			 * Relative path to the HTML header template of the checkout update client.
-			 *
-			 * The template file contains the HTML code and processing instructions
-			 * to generate the HTML code that is inserted into the HTML page header
-			 * of the rendered page in the frontend. The configuration string is the
-			 * path to the template file relative to the templates directory (usually
-			 * in client/html/templates).
-			 *
-			 * You can overwrite the template file configuration in extensions and
-			 * provide alternative templates. These alternative templates should be
-			 * named like the default one but with the string "standard" replaced by
-			 * an unique name. You may use the name of your project for this. If
-			 * you've implemented an alternative client class as well, "standard"
-			 * should be replaced by the name of the new class.
-			 *
-			 * @param string Relative path to the template creating code for the HTML page head
-			 * @since 2014.03
-			 * @category Developer
-			 * @see client/html/checkout/update/standard/template-body
-			 */
-			$tplconf = 'client/html/checkout/update/standard/template-header';
-			$default = 'checkout/update/header-default.php';
-
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/checkout/update/decorators/excludes
-		 * Excludes decorators added by the "common" option from the checkout update html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/checkout/update/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/checkout/update/decorators/global
-		 * @see client/html/checkout/update/decorators/local
-		 */
-
-		/** client/html/checkout/update/decorators/global
-		 * Adds a list of globally available decorators only to the checkout update html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/checkout/update/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/checkout/update/decorators/excludes
-		 * @see client/html/checkout/update/decorators/local
-		 */
-
-		/** client/html/checkout/update/decorators/local
-		 * Adds a list of local decorators only to the checkout update html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
-		 *
-		 *  client/html/checkout/update/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.05
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/checkout/update/decorators/excludes
-		 * @see client/html/checkout/update/decorators/global
-		 */
-
-		return $this->createSubClient( 'checkout/update/' . $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();
-
-		try
-		{
-			$provider = $this->getServiceProvider( $view->param( 'code' ) );
-
-			$config = array( 'absoluteUri' => true, 'namespace' => false );
-			$params = array( 'code' => $view->param( 'code' ), 'orderid' => $view->param( 'orderid' ) );
-			$urls = array(
-				'payment.url-success' => $this->getUrlConfirm( $view, $params, $config ),
-				'payment.url-update' => $this->getUrlUpdate( $view, $params, $config ),
-			);
-			$urls['payment.url-self'] = $urls['payment.url-update'];
-			$provider->injectGlobalConfigBE( $urls );
-
-			$response = null;
-			$headers = array();
-
-			try
-			{
-				$body = $view->request()->getBody();
-
-				if( ( $orderItem = $provider->updateSync( $view->param(), $body, $response, $headers ) ) !== null ) {
-					\Aimeos\Controller\Frontend\Factory::createController( $context, 'order' )->update( $orderItem ); // stock, coupons
-				}
-
-				$view->updateMessage = $response;
-			}
-			catch( \Aimeos\MShop\Service\Exception $e )
-			{
-				$view->updateMessage = $e->getMessage();
-			}
-
-			if( !empty( $headers ) ) {
-				$view->updateHttpHeaders = $headers;
-			}
-
-			parent::process();
-		}
-		catch( \Exception $e )
-		{
-			/** client/html/checkout/standard/update/http-error
-			 * HTTP header sent for failed attempts to update the order status
-			 *
-			 * This HTTP header is returned to the remote system if the status
-			 * update failed due to an error in the application. This header is
-			 * not sent if e.g. a payment was refused by the payment gateway!
-			 * It should be one of the 5xx HTTP headers.
-			 *
-			 * @param array List of valid HTTP headers
-			 * @since 2015.07
-			 * @category Developer
-			 * @see client/html/checkout/standard/update/http-success
-			 */
-			$default = array( 'HTTP/1.1 500 Error updating order status' );
-			$headerList = $context->getConfig()->get( 'client/html/checkout/standard/update/http-error', $default );
-
-			$view->updateHttpHeaders = $headerList;
-			$view->updateMessage = $e->getMessage();
-
-			$body = $view->request()->getBody();
-			$params = print_r( $view->param(), true );
-			$msg = "Updating order status failed: %1\$s\n%2\$s\n%3\$s";
-			$context->getLogger()->log( sprintf( $msg, $e->getMessage(), $params, $body ) );
-		}
-	}
-
-
-	/**
-	 * Returns the service provider for the given code
-	 *
-	 * @param string $code Unique service code
-	 * @throws \Aimeos\Client\Html\Exception If no service item could be found
-	 * @return \Aimeos\MShop\Service\Provider\Iface Service provider object
-	 */
-	protected function getServiceProvider( $code )
-	{
-		$serviceManager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'service' );
-
-		$search = $serviceManager->createSearch();
-		$search->setConditions( $search->compare( '==', 'service.code', $code ) );
-
-		$result = $serviceManager->searchItems( $search );
-
-		if( ( $serviceItem = reset( $result ) ) === false )
-		{
-			$msg = sprintf( 'No service for code "%1$s" found', $code );
-			throw new \Aimeos\Client\Html\Exception( $msg );
-		}
-
-		return $serviceManager->getProvider( $serviceItem );
-	}
-
-
-	/**
-	 * 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 URL to the confirm page.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @param array $params Parameters that should be part of the URL
-	 * @param array $config Default URL configuration
-	 * @return string URL string
-	 */
-	protected function getUrlConfirm( \Aimeos\MW\View\Iface $view, array $params, array $config )
-	{
-		$target = $view->config( 'client/html/checkout/confirm/url/target' );
-		$cntl = $view->config( 'client/html/checkout/confirm/url/controller', 'checkout' );
-		$action = $view->config( 'client/html/checkout/confirm/url/action', 'confirm' );
-		$config = $view->config( 'client/html/checkout/confirm/url/config', $config );
-
-		return $view->url( $target, $cntl, $action, $params, array(), $config );
-	}
-
-
-	/**
-	 * Returns the URL to the update page.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View object
-	 * @param array $params Parameters that should be part of the URL
-	 * @param array $config Default URL configuration
-	 * @return string URL string
-	 */
-	protected function getUrlUpdate( \Aimeos\MW\View\Iface $view, array $params, array $config )
-	{
-		$target = $view->config( 'client/html/checkout/update/url/target' );
-		$cntl = $view->config( 'client/html/checkout/update/url/controller', 'checkout' );
-		$action = $view->config( 'client/html/checkout/update/url/action', 'update' );
-		$config = $view->config( 'client/html/checkout/update/url/config', $config );
-
-		return $view->url( $target, $cntl, $action, $params, array(), $config );
-	}
+    /** client/html/checkout/update/standard/subparts
+     * List of HTML sub-clients rendered within the checkout update section
+     *
+     * The output of the frontend is composed of the code generated by the HTML
+     * clients. Each HTML client can consist of serveral (or none) sub-clients
+     * that are responsible for rendering certain sub-parts of the output. The
+     * sub-clients can contain HTML clients themselves and therefore a
+     * hierarchical tree of HTML clients is composed. Each HTML client creates
+     * the output that is placed inside the container of its parent.
+     *
+     * At first, always the HTML code generated by the parent is printed, then
+     * the HTML code of its sub-clients. The order of the HTML sub-clients
+     * determines the order of the output of these sub-clients inside the parent
+     * container. If the configured list of clients is
+     *
+     *  array( "subclient1", "subclient2" )
+     *
+     * you can easily change the order of the output by reordering the subparts:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1", "subclient2" )
+     *
+     * You can also remove one or more parts if they shouldn't be rendered:
+     *
+     *  client/html/<clients>/subparts = array( "subclient1" )
+     *
+     * As the clients only generates structural HTML, the layout defined via CSS
+     * should support adding, removing or reordering content by a fluid like
+     * design.
+     *
+     * @param array List of sub-client names
+     * @since 2014.03
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/checkout/update/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 )
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
+
+        try
+        {
+            $view = $this->setViewParams( $view, $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->updateBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->updateErrorList = $view->get( 'updateErrorList', 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->updateErrorList = $view->get( 'updateErrorList', array() ) + $error;
+        }
+
+        /** client/html/checkout/update/standard/template-body
+         * Relative path to the HTML body template of the checkout update client.
+         *
+         * The template file contains the HTML code and processing instructions
+         * to generate the result shown in the body of the frontend. The
+         * configuration string is the path to the template file relative
+         * to the templates directory (usually in client/html/templates).
+         *
+         * You can overwrite the template file configuration in extensions and
+         * provide alternative templates. These alternative templates should be
+         * named like the default one but with the string "standard" replaced by
+         * an unique name. You may use the name of your project for this. If
+         * you've implemented an alternative client class as well, "standard"
+         * should be replaced by the name of the new class.
+         *
+         * @param string Relative path to the template creating code for the HTML page body
+         * @since 2014.03
+         * @category Developer
+         * @see client/html/checkout/update/standard/template-header
+         */
+        $tplconf = 'client/html/checkout/update/standard/template-body';
+        $default = 'checkout/update/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 )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->updateHeader = $html;
+
+            /** client/html/checkout/update/standard/template-header
+             * Relative path to the HTML header template of the checkout update client.
+             *
+             * The template file contains the HTML code and processing instructions
+             * to generate the HTML code that is inserted into the HTML page header
+             * of the rendered page in the frontend. The configuration string is the
+             * path to the template file relative to the templates directory (usually
+             * in client/html/templates).
+             *
+             * You can overwrite the template file configuration in extensions and
+             * provide alternative templates. These alternative templates should be
+             * named like the default one but with the string "standard" replaced by
+             * an unique name. You may use the name of your project for this. If
+             * you've implemented an alternative client class as well, "standard"
+             * should be replaced by the name of the new class.
+             *
+             * @param string Relative path to the template creating code for the HTML page head
+             * @since 2014.03
+             * @category Developer
+             * @see client/html/checkout/update/standard/template-body
+             */
+            $tplconf = 'client/html/checkout/update/standard/template-header';
+            $default = 'checkout/update/header-default.php';
+
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/checkout/update/decorators/excludes
+         * Excludes decorators added by the "common" option from the checkout update html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/checkout/update/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/checkout/update/decorators/global
+         * @see client/html/checkout/update/decorators/local
+         */
+
+        /** client/html/checkout/update/decorators/global
+         * Adds a list of globally available decorators only to the checkout update html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/checkout/update/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/checkout/update/decorators/excludes
+         * @see client/html/checkout/update/decorators/local
+         */
+
+        /** client/html/checkout/update/decorators/local
+         * Adds a list of local decorators only to the checkout update html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
+         *
+         *  client/html/checkout/update/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2014.05
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/checkout/update/decorators/excludes
+         * @see client/html/checkout/update/decorators/global
+         */
+
+        return $this->createSubClient( 'checkout/update/' . $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();
+
+        try
+        {
+            $provider = $this->getServiceProvider( $view->param( 'code' ) );
+
+            $config = array( 'absoluteUri' => true, 'namespace' => false );
+            $params = array( 'code' => $view->param( 'code' ), 'orderid' => $view->param( 'orderid' ) );
+            $urls = array(
+                'payment.url-success' => $this->getUrlConfirm( $view, $params, $config ),
+                'payment.url-update' => $this->getUrlUpdate( $view, $params, $config ),
+            );
+            $urls['payment.url-self'] = $urls['payment.url-update'];
+            $provider->injectGlobalConfigBE( $urls );
+
+            $response = null;
+            $headers = array();
+
+            try
+            {
+                $body = $view->request()->getBody();
+
+                if( ( $orderItem = $provider->updateSync( $view->param(), $body, $response, $headers ) ) !== null ) {
+                    \Aimeos\Controller\Frontend\Factory::createController( $context, 'order' )->update( $orderItem ); // stock, coupons
+                }
+
+                $view->updateMessage = $response;
+            }
+            catch( \Aimeos\MShop\Service\Exception $e )
+            {
+                $view->updateMessage = $e->getMessage();
+            }
+
+            if( !empty( $headers ) ) {
+                $view->updateHttpHeaders = $headers;
+            }
+
+            parent::process();
+        }
+        catch( \Exception $e )
+        {
+            /** client/html/checkout/standard/update/http-error
+             * HTTP header sent for failed attempts to update the order status
+             *
+             * This HTTP header is returned to the remote system if the status
+             * update failed due to an error in the application. This header is
+             * not sent if e.g. a payment was refused by the payment gateway!
+             * It should be one of the 5xx HTTP headers.
+             *
+             * @param array List of valid HTTP headers
+             * @since 2015.07
+             * @category Developer
+             * @see client/html/checkout/standard/update/http-success
+             */
+            $default = array( 'HTTP/1.1 500 Error updating order status' );
+            $headerList = $context->getConfig()->get( 'client/html/checkout/standard/update/http-error', $default );
+
+            $view->updateHttpHeaders = $headerList;
+            $view->updateMessage = $e->getMessage();
+
+            $body = $view->request()->getBody();
+            $params = print_r( $view->param(), true );
+            $msg = "Updating order status failed: %1\$s\n%2\$s\n%3\$s";
+            $context->getLogger()->log( sprintf( $msg, $e->getMessage(), $params, $body ) );
+        }
+    }
+
+
+    /**
+     * Returns the service provider for the given code
+     *
+     * @param string $code Unique service code
+     * @throws \Aimeos\Client\Html\Exception If no service item could be found
+     * @return \Aimeos\MShop\Service\Provider\Iface Service provider object
+     */
+    protected function getServiceProvider( $code )
+    {
+        $serviceManager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'service' );
+
+        $search = $serviceManager->createSearch();
+        $search->setConditions( $search->compare( '==', 'service.code', $code ) );
+
+        $result = $serviceManager->searchItems( $search );
+
+        if( ( $serviceItem = reset( $result ) ) === false )
+        {
+            $msg = sprintf( 'No service for code "%1$s" found', $code );
+            throw new \Aimeos\Client\Html\Exception( $msg );
+        }
+
+        return $serviceManager->getProvider( $serviceItem );
+    }
+
+
+    /**
+     * 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 URL to the confirm page.
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @param array $params Parameters that should be part of the URL
+     * @param array $config Default URL configuration
+     * @return string URL string
+     */
+    protected function getUrlConfirm( \Aimeos\MW\View\Iface $view, array $params, array $config )
+    {
+        $target = $view->config( 'client/html/checkout/confirm/url/target' );
+        $cntl = $view->config( 'client/html/checkout/confirm/url/controller', 'checkout' );
+        $action = $view->config( 'client/html/checkout/confirm/url/action', 'confirm' );
+        $config = $view->config( 'client/html/checkout/confirm/url/config', $config );
+
+        return $view->url( $target, $cntl, $action, $params, array(), $config );
+    }
+
+
+    /**
+     * Returns the URL to the update page.
+     *
+     * @param \Aimeos\MW\View\Iface $view View object
+     * @param array $params Parameters that should be part of the URL
+     * @param array $config Default URL configuration
+     * @return string URL string
+     */
+    protected function getUrlUpdate( \Aimeos\MW\View\Iface $view, array $params, array $config )
+    {
+        $target = $view->config( 'client/html/checkout/update/url/target' );
+        $cntl = $view->config( 'client/html/checkout/update/url/controller', 'checkout' );
+        $action = $view->config( 'client/html/checkout/update/url/action', 'update' );
+        $config = $view->config( 'client/html/checkout/update/url/config', $config );
+
+        return $view->url( $target, $cntl, $action, $params, array(), $config );
+    }
 }

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

client/html/src/Client/Html/Account/Favorite/Standard.php

Indentation +460 added lines, -460 removed lines

@@ -19,465 +19,465 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/account/favorite/standard/subparts
-	 * List of HTML sub-clients rendered within the account favorite 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/account/favorite/standard/subparts';
-	private $subPartNames = array();
-	private $cache;
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	 */
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$context = $this->getContext();
-		$view = $this->getView();
-
-		try
-		{
-			$view = $this->setViewParams( $view, $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-			}
-			$view->favoriteBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->favoriteErrorList = $view->get( 'favoriteErrorList', 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->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
-		}
-
-		/** client/html/account/favorite/standard/template-body
-		 * Relative path to the HTML body template of the account favorite 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/account/favorite/standard/template-header
-		 */
-		$tplconf = 'client/html/account/favorite/standard/template-body';
-		$default = 'account/favorite/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 )
-	{
-		try
-		{
-			$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-			$html = '';
-			foreach( $this->getSubClients() as $subclient ) {
-				$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-			}
-			$view->favoriteHeader = $html;
-
-			/** client/html/account/favorite/standard/template-header
-			 * Relative path to the HTML header template of the account favorite 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/account/favorite/standard/template-body
-			 */
-			$tplconf = 'client/html/account/favorite/standard/template-header';
-			$default = 'account/favorite/header-default.php';
-
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/account/favorite/decorators/excludes
-		 * Excludes decorators added by the "common" option from the account favorite 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/account/favorite/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/account/favorite/decorators/global
-		 * @see client/html/account/favorite/decorators/local
-		 */
-
-		/** client/html/account/favorite/decorators/global
-		 * Adds a list of globally available decorators only to the account favorite 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/account/favorite/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/account/favorite/decorators/excludes
-		 * @see client/html/account/favorite/decorators/local
-		 */
-
-		/** client/html/account/favorite/decorators/local
-		 * Adds a list of local decorators only to the account favorite 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\Account\Decorator\*") around the html client.
-		 *
-		 *  client/html/account/favorite/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Account\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/account/favorite/decorators/excludes
-		 * @see client/html/account/favorite/decorators/global
-		 */
-		return $this->createSubClient( 'account/favorite/' . $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();
-		$ids = $view->param( 'fav_id', array() );
-
-
-		if( $context->getUserId() != null && !empty( $ids ) )
-		{
-			$typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'favorite' );
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
-
-			$search = $manager->createSearch();
-			$expr = array(
-				$search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
-				$search->compare( '==', 'customer.lists.refid', $ids ),
-				$search->compare( '==', 'customer.lists.domain', 'product' ),
-				$search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
-			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-
-			$items = array();
-			foreach( $manager->searchItems( $search ) as $item ) {
-				$items[$item->getRefId()] = $item;
-			}
-
-
-			switch( $view->param( 'fav_action' ) )
-			{
-				case 'add':
-
-					$item = $manager->createItem();
-					$item->setParentId( $context->getUserId() );
-					$item->setTypeId( $typeItem->getId() );
-					$item->setDomain( 'product' );
-					$item->setStatus( 1 );
-
-					foreach( (array) $view->param( 'fav_id', array() ) as $id )
-					{
-						if( !isset( $items[$id] ) )
-						{
-							$item->setId( null );
-							$item->setRefId( $id );
-
-							$manager->saveItem( $item );
-							$manager->moveItem( $item->getId() );
-						}
-					}
-
-					break;
-
-				case 'delete':
-
-					$listIds = array();
-
-					foreach( (array) $view->param( 'fav_id', array() ) as $id )
-					{
-						if( isset( $items[$id] ) ) {
-							$listIds[] = $items[$id]->getId();
-						}
-					}
-
-					$manager->deleteItems( $listIds );
-					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 );
-	}
-
-
-	/**
-	 * Returns the sanitized page from the parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return integer Page number starting from 1
-	 */
-	protected function getProductListPage( \Aimeos\MW\View\Iface $view )
-	{
-		$page = (int) $view->param( 'fav_page', 1 );
-		return ( $page < 1 ? 1 : $page );
-	}
-
-
-	/**
-	 * Returns the sanitized page size from the parameters for the product list.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
-	 * @return integer Page size
-	 */
-	protected function getProductListSize( \Aimeos\MW\View\Iface $view )
-	{
-		/** client/html/account/favorite/size
-		 * The number of products shown in a list page for favorite products
-		 *
-		 * Limits the number of products that is shown in the list pages to the
-		 * given value. If more products are available, the products are split
-		 * into bunches which will be shown on their own list page. The user is
-		 * able to move to the next page (or previous one if it's not the first)
-		 * to display the next (or previous) products.
-		 *
-		 * The value must be an integer number from 1 to 100. Negative values as
-		 * well as values above 100 are not allowed. The value can be overwritten
-		 * per request if the "l_size" parameter is part of the URL.
-		 *
-		 * @param integer Number of products
-		 * @since 2014.09
-		 * @category User
-		 * @category Developer
-		 * @see client/html/catalog/lists/size
-		 */
-		$defaultSize = $this->getContext()->getConfig()->get( 'client/html/account/favorite/size', 48 );
-
-		$size = (int) $view->param( 'fav-size', $defaultSize );
-		return ( $size < 1 || $size > 100 ? $defaultSize : $size );
-	}
-
-
-	/**
-	 * Sets the necessary parameter values in the view.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return \Aimeos\MW\View\Iface Modified view object
-	 */
-	protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
-	{
-		if( !isset( $this->cache ) )
-		{
-			$total = 0;
-			$productIds = array();
-			$context = $this->getContext();
-			$typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'favorite' );
-
-			$size = $this->getProductListSize( $view );
-			$current = $this->getProductListPage( $view );
-			$last = ( $total != 0 ? ceil( $total / $size ) : 1 );
-
-
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
-
-			$search = $manager->createSearch();
-			$expr = array(
-				$search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
-				$search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
-				$search->compare( '==', 'customer.lists.domain', 'product' ),
-			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSortations( array( $search->sort( '-', 'customer.lists.position' ) ) );
-			$search->setSlice( ( $current - 1 ) * $size, $size );
-
-			$view->favoriteListItems = $manager->searchItems( $search, array(), $total );
-
-
-			/** client/html/account/favorite/domains
-			 * A list of domain names whose items should be available in the account favorite view template
-			 *
-			 * The templates rendering product details usually add the images,
-			 * prices and texts 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
-			 * @see client/html/catalog/domains
-			 */
-			$default = array( 'text', 'price', 'media' );
-			$domains = $context->getConfig()->get( 'client/html/account/favorite/domains', $default );
-
-			foreach( $view->favoriteListItems as $listItem ) {
-				$productIds[] = $listItem->getRefId();
-			}
-
-			$controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
-
-			$view->favoriteProductItems = $controller->getProductItems( $productIds, $domains );
-			$view->favoritePageFirst = 1;
-			$view->favoritePagePrev = ( $current > 1 ? $current - 1 : 1 );
-			$view->favoritePageNext = ( $current < $last ? $current + 1 : $last );
-			$view->favoritePageLast = $last;
-			$view->favoritePageCurr = $current;
-
-			$this->cache = $view;
-		}
-
-		return $this->cache;
-	}
+    /** client/html/account/favorite/standard/subparts
+     * List of HTML sub-clients rendered within the account favorite 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/account/favorite/standard/subparts';
+    private $subPartNames = array();
+    private $cache;
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $context = $this->getContext();
+        $view = $this->getView();
+
+        try
+        {
+            $view = $this->setViewParams( $view, $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+            }
+            $view->favoriteBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->favoriteErrorList = $view->get( 'favoriteErrorList', 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->favoriteErrorList = $view->get( 'favoriteErrorList', array() ) + $error;
+        }
+
+        /** client/html/account/favorite/standard/template-body
+         * Relative path to the HTML body template of the account favorite 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/account/favorite/standard/template-header
+         */
+        $tplconf = 'client/html/account/favorite/standard/template-body';
+        $default = 'account/favorite/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 )
+    {
+        try
+        {
+            $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->favoriteHeader = $html;
+
+            /** client/html/account/favorite/standard/template-header
+             * Relative path to the HTML header template of the account favorite 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/account/favorite/standard/template-body
+             */
+            $tplconf = 'client/html/account/favorite/standard/template-header';
+            $default = 'account/favorite/header-default.php';
+
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/account/favorite/decorators/excludes
+         * Excludes decorators added by the "common" option from the account favorite 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/account/favorite/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/account/favorite/decorators/global
+         * @see client/html/account/favorite/decorators/local
+         */
+
+        /** client/html/account/favorite/decorators/global
+         * Adds a list of globally available decorators only to the account favorite 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/account/favorite/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/account/favorite/decorators/excludes
+         * @see client/html/account/favorite/decorators/local
+         */
+
+        /** client/html/account/favorite/decorators/local
+         * Adds a list of local decorators only to the account favorite 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\Account\Decorator\*") around the html client.
+         *
+         *  client/html/account/favorite/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Account\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/account/favorite/decorators/excludes
+         * @see client/html/account/favorite/decorators/global
+         */
+        return $this->createSubClient( 'account/favorite/' . $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();
+        $ids = $view->param( 'fav_id', array() );
+
+
+        if( $context->getUserId() != null && !empty( $ids ) )
+        {
+            $typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'favorite' );
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+
+            $search = $manager->createSearch();
+            $expr = array(
+                $search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
+                $search->compare( '==', 'customer.lists.refid', $ids ),
+                $search->compare( '==', 'customer.lists.domain', 'product' ),
+                $search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
+            );
+            $search->setConditions( $search->combine( '&&', $expr ) );
+
+            $items = array();
+            foreach( $manager->searchItems( $search ) as $item ) {
+                $items[$item->getRefId()] = $item;
+            }
+
+
+            switch( $view->param( 'fav_action' ) )
+            {
+                case 'add':
+
+                    $item = $manager->createItem();
+                    $item->setParentId( $context->getUserId() );
+                    $item->setTypeId( $typeItem->getId() );
+                    $item->setDomain( 'product' );
+                    $item->setStatus( 1 );
+
+                    foreach( (array) $view->param( 'fav_id', array() ) as $id )
+                    {
+                        if( !isset( $items[$id] ) )
+                        {
+                            $item->setId( null );
+                            $item->setRefId( $id );
+
+                            $manager->saveItem( $item );
+                            $manager->moveItem( $item->getId() );
+                        }
+                    }
+
+                    break;
+
+                case 'delete':
+
+                    $listIds = array();
+
+                    foreach( (array) $view->param( 'fav_id', array() ) as $id )
+                    {
+                        if( isset( $items[$id] ) ) {
+                            $listIds[] = $items[$id]->getId();
+                        }
+                    }
+
+                    $manager->deleteItems( $listIds );
+                    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 );
+    }
+
+
+    /**
+     * Returns the sanitized page from the parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return integer Page number starting from 1
+     */
+    protected function getProductListPage( \Aimeos\MW\View\Iface $view )
+    {
+        $page = (int) $view->param( 'fav_page', 1 );
+        return ( $page < 1 ? 1 : $page );
+    }
+
+
+    /**
+     * Returns the sanitized page size from the parameters for the product list.
+     *
+     * @param \Aimeos\MW\View\Iface $view View instance with helper for retrieving the required parameters
+     * @return integer Page size
+     */
+    protected function getProductListSize( \Aimeos\MW\View\Iface $view )
+    {
+        /** client/html/account/favorite/size
+         * The number of products shown in a list page for favorite products
+         *
+         * Limits the number of products that is shown in the list pages to the
+         * given value. If more products are available, the products are split
+         * into bunches which will be shown on their own list page. The user is
+         * able to move to the next page (or previous one if it's not the first)
+         * to display the next (or previous) products.
+         *
+         * The value must be an integer number from 1 to 100. Negative values as
+         * well as values above 100 are not allowed. The value can be overwritten
+         * per request if the "l_size" parameter is part of the URL.
+         *
+         * @param integer Number of products
+         * @since 2014.09
+         * @category User
+         * @category Developer
+         * @see client/html/catalog/lists/size
+         */
+        $defaultSize = $this->getContext()->getConfig()->get( 'client/html/account/favorite/size', 48 );
+
+        $size = (int) $view->param( 'fav-size', $defaultSize );
+        return ( $size < 1 || $size > 100 ? $defaultSize : $size );
+    }
+
+
+    /**
+     * Sets the necessary parameter values in the view.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return \Aimeos\MW\View\Iface Modified view object
+     */
+    protected function setViewParams( \Aimeos\MW\View\Iface $view, array &$tags = array(), &$expire = null )
+    {
+        if( !isset( $this->cache ) )
+        {
+            $total = 0;
+            $productIds = array();
+            $context = $this->getContext();
+            $typeItem = $this->getTypeItem( 'customer/lists/type', 'product', 'favorite' );
+
+            $size = $this->getProductListSize( $view );
+            $current = $this->getProductListPage( $view );
+            $last = ( $total != 0 ? ceil( $total / $size ) : 1 );
+
+
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+
+            $search = $manager->createSearch();
+            $expr = array(
+                $search->compare( '==', 'customer.lists.parentid', $context->getUserId() ),
+                $search->compare( '==', 'customer.lists.typeid', $typeItem->getId() ),
+                $search->compare( '==', 'customer.lists.domain', 'product' ),
+            );
+            $search->setConditions( $search->combine( '&&', $expr ) );
+            $search->setSortations( array( $search->sort( '-', 'customer.lists.position' ) ) );
+            $search->setSlice( ( $current - 1 ) * $size, $size );
+
+            $view->favoriteListItems = $manager->searchItems( $search, array(), $total );
+
+
+            /** client/html/account/favorite/domains
+             * A list of domain names whose items should be available in the account favorite view template
+             *
+             * The templates rendering product details usually add the images,
+             * prices and texts 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
+             * @see client/html/catalog/domains
+             */
+            $default = array( 'text', 'price', 'media' );
+            $domains = $context->getConfig()->get( 'client/html/account/favorite/domains', $default );
+
+            foreach( $view->favoriteListItems as $listItem ) {
+                $productIds[] = $listItem->getRefId();
+            }
+
+            $controller = \Aimeos\Controller\Frontend\Factory::createController( $context, 'catalog' );
+
+            $view->favoriteProductItems = $controller->getProductItems( $productIds, $domains );
+            $view->favoritePageFirst = 1;
+            $view->favoritePagePrev = ( $current > 1 ? $current - 1 : 1 );
+            $view->favoritePageNext = ( $current < $last ? $current + 1 : $last );
+            $view->favoritePageLast = $last;
+            $view->favoritePageCurr = $current;
+
+            $this->cache = $view;
+        }
+
+        return $this->cache;
+    }
 }
\ No newline at end of file

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

client/html/src/Client/Html/Account/History/Standard.php

Indentation +262 added lines, -262 removed lines

@@ -19,288 +19,288 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Iface
 {
-	/** client/html/account/history/standard/subparts
-	 * List of HTML sub-clients rendered within the account history 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/account/history/standard/subparts';
+    /** client/html/account/history/standard/subparts
+     * List of HTML sub-clients rendered within the account history 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/account/history/standard/subparts';
 
-	/** client/html/account/history/lists/name
-	 * Name of the list part used by the account history client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Lists\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2014.03
-	 * @category Developer
-	 */
+    /** client/html/account/history/lists/name
+     * Name of the list part used by the account history client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Lists\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2014.03
+     * @category Developer
+     */
 
-	/** client/html/account/history/order/name
-	 * Name of the order part used by the account history client implementation
-	 *
-	 * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Myname".
-	 * The name is case-sensitive and you should avoid camel case names like "MyName".
-	 *
-	 * @param string Last part of the client class name
-	 * @since 2015.02
-	 * @category Developer
-	 */
-	private $subPartNames = array( 'lists', 'order' );
+    /** client/html/account/history/order/name
+     * Name of the order part used by the account history client implementation
+     *
+     * Use "Myname" if your class is named "\Aimeos\Client\Html\Account\History\Order\Myname".
+     * The name is case-sensitive and you should avoid camel case names like "MyName".
+     *
+     * @param string Last part of the client class name
+     * @since 2015.02
+     * @category Developer
+     */
+    private $subPartNames = array( 'lists', 'order' );
 
 
-	/**
-	 * 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->historyBody = $html;
-		}
-		catch( \Aimeos\Client\Html\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\Controller\Frontend\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
-			$view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
-		}
-		catch( \Aimeos\MShop\Exception $e )
-		{
-			$error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
-			$view->historyErrorList = $view->get( 'historyErrorList', 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->historyBody = $html;
+        }
+        catch( \Aimeos\Client\Html\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'client', $e->getMessage() ) );
+            $view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\Controller\Frontend\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'controller/frontend', $e->getMessage() ) );
+            $view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
+        }
+        catch( \Aimeos\MShop\Exception $e )
+        {
+            $error = array( $this->getContext()->getI18n()->dt( 'mshop', $e->getMessage() ) );
+            $view->historyErrorList = $view->get( 'historyErrorList', 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->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
-		}
+            $error = array( $context->getI18n()->dt( 'client', 'A non-recoverable error occured' ) );
+            $view->historyErrorList = $view->get( 'historyErrorList', array() ) + $error;
+        }
 
-		/** client/html/account/history/standard/template-body
-		 * Relative path to the HTML body template of the account history 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/account/history/standard/template-header
-		 */
-		$tplconf = 'client/html/account/history/standard/template-body';
-		$default = 'account/history/body-default.php';
+        /** client/html/account/history/standard/template-body
+         * Relative path to the HTML body template of the account history 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/account/history/standard/template-header
+         */
+        $tplconf = 'client/html/account/history/standard/template-body';
+        $default = 'account/history/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->historyHeader = $html;
+            $html = '';
+            foreach( $this->getSubClients() as $subclient ) {
+                $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+            }
+            $view->historyHeader = $html;
 
-			/** client/html/account/history/standard/template-header
-			 * Relative path to the HTML header template of the account history 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/account/history/standard/template-body
-			 */
-			$tplconf = 'client/html/account/history/standard/template-header';
-			$default = 'account/history/header-default.php';
+            /** client/html/account/history/standard/template-header
+             * Relative path to the HTML header template of the account history 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/account/history/standard/template-body
+             */
+            $tplconf = 'client/html/account/history/standard/template-header';
+            $default = 'account/history/header-default.php';
 
-			return $view->render( $view->config( $tplconf, $default ) );
-		}
-		catch( \Exception $e )
-		{
-			$this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
-		}
-	}
+            return $view->render( $view->config( $tplconf, $default ) );
+        }
+        catch( \Exception $e )
+        {
+            $this->getContext()->getLogger()->log( $e->getMessage() . PHP_EOL . $e->getTraceAsString() );
+        }
+    }
 
 
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/account/history/decorators/excludes
-		 * Excludes decorators added by the "common" option from the account history 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/account/history/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/account/history/decorators/global
-		 * @see client/html/account/history/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/account/history/decorators/excludes
+         * Excludes decorators added by the "common" option from the account history 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/account/history/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/account/history/decorators/global
+         * @see client/html/account/history/decorators/local
+         */
 
-		/** client/html/account/history/decorators/global
-		 * Adds a list of globally available decorators only to the account history 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/account/history/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/account/history/decorators/excludes
-		 * @see client/html/account/history/decorators/local
-		 */
+        /** client/html/account/history/decorators/global
+         * Adds a list of globally available decorators only to the account history 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/account/history/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/account/history/decorators/excludes
+         * @see client/html/account/history/decorators/local
+         */
 
-		/** client/html/account/history/decorators/local
-		 * Adds a list of local decorators only to the account history 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\Account\Decorator\*") around the html client.
-		 *
-		 *  client/html/account/history/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Account\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/account/history/decorators/excludes
-		 * @see client/html/account/history/decorators/global
-		 */
+        /** client/html/account/history/decorators/local
+         * Adds a list of local decorators only to the account history 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\Account\Decorator\*") around the html client.
+         *
+         *  client/html/account/history/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Account\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/account/history/decorators/excludes
+         * @see client/html/account/history/decorators/global
+         */
 
-		return $this->createSubClient( 'account/history/' . $type, $name );
-	}
+        return $this->createSubClient( 'account/history/' . $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 );
+    }
 }
\ No newline at end of file

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

client/html/src/Client/Html/Account/Download/Standard.php

Indentation +360 added lines, -360 removed lines

@@ -18,365 +18,365 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Client\Factory\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Client\Factory\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/account/download/standard/subparts
-	 * List of HTML sub-clients rendered within the account download 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 2016.02
-	 * @category Developer
-	 */
-	private $subPartPath = 'client/html/account/download/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 )
-	{
-		return '';
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		return '';
-	}
-
-
-	/**
-	 * 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/account/download/decorators/excludes
-		 * Excludes decorators added by the "common" option from the account download 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/account/download/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 2016.02
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/account/download/decorators/global
-		 * @see client/html/account/download/decorators/local
-		 */
-
-		/** client/html/account/download/decorators/global
-		 * Adds a list of globally available decorators only to the account download 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/account/download/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 2016.02
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/account/download/decorators/excludes
-		 * @see client/html/account/download/decorators/local
-		 */
-
-		/** client/html/account/download/decorators/local
-		 * Adds a list of local decorators only to the account download 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\Account\Decorator\*") around the html client.
-		 *
-		 *  client/html/account/download/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2016.02
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/account/download/decorators/excludes
-		 * @see client/html/account/download/decorators/global
-		 */
-		return $this->createSubClient( 'account/download/' . $type, $name );
-	}
-
-
-	/**
-	 * Processes the input, e.g. store given values.
-	 * A view must be available and this method doesn't generate any output
-	 * besides setting view variables.
-	 */
-	public function process()
-	{
-		$context = $this->getContext();
-
-		try
-		{
-			$view = $this->getView();
-			$id = $view->param( 'dl_id' );
-			$customerId = $context->getUserId();
-
-			if( $this->checkAccess( $customerId, $id ) === false )
-			{
-				$view->response()->withStatus( 401 );
-				return;
-			}
-
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/product/attribute' );
-			$item = $manager->getItem( $id );
-
-			if( $this->checkDownload( $context->getUserId(), $id ) === true ) {
-				$this->addDownload( $item );
-			} else {
-				$view->response()->withStatus( 403 );
-			}
-
-			parent::process();
-		}
-		catch( \Exception $e )
-		{
-			$context->getLogger()->log( $e->getMessage() );
-		}
-	}
-
-
-	/**
-	 * 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 );
-	}
-
-
-	/**
-	 * Adds the necessary headers and the download content to the reponse object
-	 *
-	 * @param \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item Order product attribute item with file reference
-	 */
-	protected function addDownload( \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item )
-	{
-		$fs = $this->getContext()->getFilesystemManager()->get( 'fs-secure' );
-		$response = $this->getView()->response();
-		$value = (string) $item->getValue();
-
-		if( $fs->has( $value ) )
-		{
-			$name = $item->getName();
-
-			if( pathinfo( $name, PATHINFO_EXTENSION ) == null
-					&& ( $ext = pathinfo( $value, PATHINFO_EXTENSION ) ) != null
-			) {
-				$name .= '.' . $ext;
-			}
-
-			$response->withHeader( 'Content-Description', 'File Transfer' );
-			$response->withHeader( 'Content-Type', 'application/octet-stream' );
-			$response->withHeader( 'Content-Disposition', 'attachment; filename="' . $name . '"' );
-			$response->withHeader( 'Content-Length', (string) $fs->size( $value ) );
-			$response->withHeader( 'Cache-Control', 'must-revalidate' );
-			$response->withHeader( 'Pragma', 'private' );
-			$response->withHeader( 'Expires', '0' );
-
-			$response->withBody( $response->createStream( $fs->reads( $value ) ) );
-		}
-		elseif( filter_var( $value, FILTER_VALIDATE_URL ) !== false )
-		{
-			$response->withHeader( 'Location', $value );
-			$response->withStatus( 303 );
-		}
-		else
-		{
-			$response->withStatus( 404 );
-		}
-	}
-
-
-	/**
-	 * Checks if the customer is allowed to download the file
-	 *
-	 * @param string $customerId Unique customer ID
-	 * @param string $id Unique order base product attribute ID referencing the download file
-	 * @return boolean True if download is allowed, false if not
-	 */
-	protected function checkAccess( $customerId, $id )
-	{
-		if( $customerId !== null && $id !== null )
-		{
-			$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'order/base' );
-
-			$search = $manager->createSearch();
-			$expr = array(
-				$search->compare( '==', 'order.base.customerid', $customerId ),
-				$search->compare( '==', 'order.base.product.attribute.id', $id ),
-			);
-			$search->setConditions( $search->combine( '&&', $expr ) );
-			$search->setSlice( 0, 1 );
-
-			if( count( $manager->searchItems( $search ) ) > 0 ) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-
-	/**
-	 * Updates the download counter for the downloaded file
-	 *
-	 * @param string $customerId Unique customer ID
-	 * @param string $id Unique order base product attribute ID referencing the download file
-	 * @return boolean True if download is allowed, false if not
-	 */
-	protected function checkDownload( $customerId, $id )
-	{
-		$context = $this->getContext();
-
-		/** client/html/account/download/maxcount
-		 * Maximum number of file downloads allowed for an ordered product
-		 *
-		 * This configuration setting enables you to limit the number of downloads
-		 * of a product download file. The count is the maximum number for each
-		 * bought product and customer, i.e. setting the count to "3" allows
-		 * a customer to download the bought product file up to three times.
-		 *
-		 * The default value of null enforces no limit.
-		 *
-		 * @param integer Maximum number of downloads
-		 * @since 2016.02
-		 * @category Developer
-		 * @category User
-		 */
-		$maxcnt = $context->getConfig()->get( 'client/html/account/download/maxcount' );
-
-		$listItem = $this->getListItem( $customerId, $id );
-		$config = $listItem->getConfig();
-
-		if( !isset( $config['count'] ) ) {
-			$config['count'] = 0;
-		}
-
-		if( $maxcnt === null || ((int) $config['count']) < $maxcnt )
-		{
-			$config['count']++;
-			$listItem->setConfig( $config );
-
-			$manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
-			$manager->saveItem( $listItem, false );
-
-			return true;
-		}
-
-		return false;
-	}
-
-
-	/**
-	 * Returns the list item storing the download counter
-	 *
-	 * @param string $customerId Unique customer ID
-	 * @param string $refId Unique order base product attribute ID referencing the download file
-	 * @return \Aimeos\MSho\Common\Item\Lists\Iface List item object
-	 */
-	protected function getListItem( $customerId, $refId )
-	{
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'customer/lists' );
-
-		$search = $manager->createSearch();
-		$expr = array(
-			$search->compare( '==', 'customer.lists.parentid', $customerId ),
-			$search->compare( '==', 'customer.lists.refid', $refId ),
-			$search->compare( '==', 'customer.lists.domain', 'order' ),
-			$search->compare( '==', 'customer.lists.type.domain', 'order' ),
-			$search->compare( '==', 'customer.lists.type.code', 'download' ),
-		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-
-		$listItems = $manager->searchItems( $search );
-
-		if( ( $listItem = reset( $listItems ) ) === false )
-		{
-			$listItem = $manager->createItem();
-			$listItem->setTypeId( $this->getTypeItem( 'customer/lists/type', 'order', 'download' )->getId() );
-			$listItem->setParentId( $customerId );
-			$listItem->setDomain( 'order' );
-			$listItem->setRefId( $refId );
-		}
-
-		return $listItem;
-	}
+    /** client/html/account/download/standard/subparts
+     * List of HTML sub-clients rendered within the account download 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 2016.02
+     * @category Developer
+     */
+    private $subPartPath = 'client/html/account/download/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 )
+    {
+        return '';
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        return '';
+    }
+
+
+    /**
+     * 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/account/download/decorators/excludes
+         * Excludes decorators added by the "common" option from the account download 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/account/download/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 2016.02
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/account/download/decorators/global
+         * @see client/html/account/download/decorators/local
+         */
+
+        /** client/html/account/download/decorators/global
+         * Adds a list of globally available decorators only to the account download 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/account/download/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 2016.02
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/account/download/decorators/excludes
+         * @see client/html/account/download/decorators/local
+         */
+
+        /** client/html/account/download/decorators/local
+         * Adds a list of local decorators only to the account download 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\Account\Decorator\*") around the html client.
+         *
+         *  client/html/account/download/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Account\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2016.02
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/account/download/decorators/excludes
+         * @see client/html/account/download/decorators/global
+         */
+        return $this->createSubClient( 'account/download/' . $type, $name );
+    }
+
+
+    /**
+     * Processes the input, e.g. store given values.
+     * A view must be available and this method doesn't generate any output
+     * besides setting view variables.
+     */
+    public function process()
+    {
+        $context = $this->getContext();
+
+        try
+        {
+            $view = $this->getView();
+            $id = $view->param( 'dl_id' );
+            $customerId = $context->getUserId();
+
+            if( $this->checkAccess( $customerId, $id ) === false )
+            {
+                $view->response()->withStatus( 401 );
+                return;
+            }
+
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'order/base/product/attribute' );
+            $item = $manager->getItem( $id );
+
+            if( $this->checkDownload( $context->getUserId(), $id ) === true ) {
+                $this->addDownload( $item );
+            } else {
+                $view->response()->withStatus( 403 );
+            }
+
+            parent::process();
+        }
+        catch( \Exception $e )
+        {
+            $context->getLogger()->log( $e->getMessage() );
+        }
+    }
+
+
+    /**
+     * 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 );
+    }
+
+
+    /**
+     * Adds the necessary headers and the download content to the reponse object
+     *
+     * @param \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item Order product attribute item with file reference
+     */
+    protected function addDownload( \Aimeos\MShop\Order\Item\Base\Product\Attribute\Iface $item )
+    {
+        $fs = $this->getContext()->getFilesystemManager()->get( 'fs-secure' );
+        $response = $this->getView()->response();
+        $value = (string) $item->getValue();
+
+        if( $fs->has( $value ) )
+        {
+            $name = $item->getName();
+
+            if( pathinfo( $name, PATHINFO_EXTENSION ) == null
+                    && ( $ext = pathinfo( $value, PATHINFO_EXTENSION ) ) != null
+            ) {
+                $name .= '.' . $ext;
+            }
+
+            $response->withHeader( 'Content-Description', 'File Transfer' );
+            $response->withHeader( 'Content-Type', 'application/octet-stream' );
+            $response->withHeader( 'Content-Disposition', 'attachment; filename="' . $name . '"' );
+            $response->withHeader( 'Content-Length', (string) $fs->size( $value ) );
+            $response->withHeader( 'Cache-Control', 'must-revalidate' );
+            $response->withHeader( 'Pragma', 'private' );
+            $response->withHeader( 'Expires', '0' );
+
+            $response->withBody( $response->createStream( $fs->reads( $value ) ) );
+        }
+        elseif( filter_var( $value, FILTER_VALIDATE_URL ) !== false )
+        {
+            $response->withHeader( 'Location', $value );
+            $response->withStatus( 303 );
+        }
+        else
+        {
+            $response->withStatus( 404 );
+        }
+    }
+
+
+    /**
+     * Checks if the customer is allowed to download the file
+     *
+     * @param string $customerId Unique customer ID
+     * @param string $id Unique order base product attribute ID referencing the download file
+     * @return boolean True if download is allowed, false if not
+     */
+    protected function checkAccess( $customerId, $id )
+    {
+        if( $customerId !== null && $id !== null )
+        {
+            $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'order/base' );
+
+            $search = $manager->createSearch();
+            $expr = array(
+                $search->compare( '==', 'order.base.customerid', $customerId ),
+                $search->compare( '==', 'order.base.product.attribute.id', $id ),
+            );
+            $search->setConditions( $search->combine( '&&', $expr ) );
+            $search->setSlice( 0, 1 );
+
+            if( count( $manager->searchItems( $search ) ) > 0 ) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+
+    /**
+     * Updates the download counter for the downloaded file
+     *
+     * @param string $customerId Unique customer ID
+     * @param string $id Unique order base product attribute ID referencing the download file
+     * @return boolean True if download is allowed, false if not
+     */
+    protected function checkDownload( $customerId, $id )
+    {
+        $context = $this->getContext();
+
+        /** client/html/account/download/maxcount
+         * Maximum number of file downloads allowed for an ordered product
+         *
+         * This configuration setting enables you to limit the number of downloads
+         * of a product download file. The count is the maximum number for each
+         * bought product and customer, i.e. setting the count to "3" allows
+         * a customer to download the bought product file up to three times.
+         *
+         * The default value of null enforces no limit.
+         *
+         * @param integer Maximum number of downloads
+         * @since 2016.02
+         * @category Developer
+         * @category User
+         */
+        $maxcnt = $context->getConfig()->get( 'client/html/account/download/maxcount' );
+
+        $listItem = $this->getListItem( $customerId, $id );
+        $config = $listItem->getConfig();
+
+        if( !isset( $config['count'] ) ) {
+            $config['count'] = 0;
+        }
+
+        if( $maxcnt === null || ((int) $config['count']) < $maxcnt )
+        {
+            $config['count']++;
+            $listItem->setConfig( $config );
+
+            $manager = \Aimeos\MShop\Factory::createManager( $context, 'customer/lists' );
+            $manager->saveItem( $listItem, false );
+
+            return true;
+        }
+
+        return false;
+    }
+
+
+    /**
+     * Returns the list item storing the download counter
+     *
+     * @param string $customerId Unique customer ID
+     * @param string $refId Unique order base product attribute ID referencing the download file
+     * @return \Aimeos\MSho\Common\Item\Lists\Iface List item object
+     */
+    protected function getListItem( $customerId, $refId )
+    {
+        $manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'customer/lists' );
+
+        $search = $manager->createSearch();
+        $expr = array(
+            $search->compare( '==', 'customer.lists.parentid', $customerId ),
+            $search->compare( '==', 'customer.lists.refid', $refId ),
+            $search->compare( '==', 'customer.lists.domain', 'order' ),
+            $search->compare( '==', 'customer.lists.type.domain', 'order' ),
+            $search->compare( '==', 'customer.lists.type.code', 'download' ),
+        );
+        $search->setConditions( $search->combine( '&&', $expr ) );
+
+        $listItems = $manager->searchItems( $search );
+
+        if( ( $listItem = reset( $listItems ) ) === false )
+        {
+            $listItem = $manager->createItem();
+            $listItem->setTypeId( $this->getTypeItem( 'customer/lists/type', 'order', 'download' )->getId() );
+            $listItem->setParentId( $customerId );
+            $listItem->setDomain( 'order' );
+            $listItem->setRefId( $refId );
+        }
+
+        return $listItem;
+    }
 }
\ No newline at end of file

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

client/html/src/Client/Html/Email/Delivery/Html/Summary/Service/Standard.php

Indentation +228 added lines, -228 removed lines

@@ -19,233 +19,233 @@
  * @subpackage Html
  */
 class Standard
-	extends \Aimeos\Client\Html\Common\Summary\Service\Base
-	implements \Aimeos\Client\Html\Common\Client\Factory\Iface
+    extends \Aimeos\Client\Html\Common\Summary\Service\Base
+    implements \Aimeos\Client\Html\Common\Client\Factory\Iface
 {
-	/** client/html/email/delivery/html/summary/service/standard/subparts
-	 * List of HTML sub-clients rendered within the summary service section of the delivery HTML e-mail
-	 *
-	 * 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/email/delivery/html/summary/service/standard/subparts';
-	private $subPartNames = array();
-
-
-	/**
-	 * Returns the HTML code for insertion into the body.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string HTML code
-	*/
-	public function getBody( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
-		}
-		$view->serviceBody = $html;
-
-		/** client/html/email/delivery/html/summary/service/standard/template-body
-		 * Relative path to the HTML body template of the summary service section of the delivery HTML e-mail 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/email/delivery/html/summary/service/standard/template-header
-		 */
-		$tplconf = 'client/html/email/delivery/html/summary/service/standard/template-body';
-		$default = 'common/summary/service-body-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the HTML string for insertion into the header.
-	 *
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @param array &$tags Result array for the list of tags that are associated to the output
-	 * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
-	 * @return string|null String including HTML tags for the header on error
-	 */
-	public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
-	{
-		$view = $this->setViewParams( $this->getView(), $tags, $expire );
-
-		$html = '';
-		foreach( $this->getSubClients() as $subclient ) {
-			$html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
-		}
-		$view->serviceHeader = $html;
-
-		/** client/html/email/delivery/html/summary/service/standard/template-header
-		 * Relative path to the HTML header template of the summary service section of the delivery HTML e-mail 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/email/delivery/html/summary/service/standard/template-body
-		 */
-		$tplconf = 'client/html/email/delivery/html/summary/service/standard/template-header';
-		$default = 'common/summary/service-header-default.php';
-
-		return $view->render( $view->config( $tplconf, $default ) );
-	}
-
-
-	/**
-	 * Returns the sub-client given by its name.
-	 *
-	 * @param string $type Name of the client type
-	 * @param string|null $name Name of the sub-client (Default if null)
-	 * @return \Aimeos\Client\Html\Iface Sub-client object
-	 */
-	public function getSubClient( $type, $name = null )
-	{
-		/** client/html/email/delivery/html/summary/service/decorators/excludes
-		 * Excludes decorators added by the "common" option from the email delivery html summary service html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to remove a decorator added via
-		 * "client/html/common/decorators/default" before they are wrapped
-		 * around the html client.
-		 *
-		 *  client/html/email/delivery/html/summary/service/decorators/excludes = array( 'decorator1' )
-		 *
-		 * This would remove the decorator named "decorator1" from the list of
-		 * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
-		 * "client/html/common/decorators/default" to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/email/delivery/html/summary/service/decorators/global
-		 * @see client/html/email/delivery/html/summary/service/decorators/local
-		 */
-
-		/** client/html/email/delivery/html/summary/service/decorators/global
-		 * Adds a list of globally available decorators only to the email delivery html summary service html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap global decorators
-		 * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
-		 *
-		 *  client/html/email/delivery/html/summary/service/decorators/global = array( 'decorator1' )
-		 *
-		 * This would add the decorator named "decorator1" defined by
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/email/delivery/html/summary/service/decorators/excludes
-		 * @see client/html/email/delivery/html/summary/service/decorators/local
-		 */
-
-		/** client/html/email/delivery/html/summary/service/decorators/local
-		 * Adds a list of local decorators only to the email delivery html summary service html client
-		 *
-		 * Decorators extend the functionality of a class by adding new aspects
-		 * (e.g. log what is currently done), executing the methods of the underlying
-		 * class only in certain conditions (e.g. only for logged in users) or
-		 * modify what is returned to the caller.
-		 *
-		 * This option allows you to wrap local decorators
-		 * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
-		 *
-		 *  client/html/email/delivery/html/summary/service/decorators/local = array( 'decorator2' )
-		 *
-		 * This would add the decorator named "decorator2" defined by
-		 * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
-		 *
-		 * @param array List of decorator names
-		 * @since 2015.08
-		 * @category Developer
-		 * @see client/html/common/decorators/default
-		 * @see client/html/email/delivery/html/summary/service/decorators/excludes
-		 * @see client/html/email/delivery/html/summary/service/decorators/global
-		 */
-
-		return $this->createSubClient( 'email/delivery/html/summary/service/' . $type, $name );
-	}
-
-
-	/**
-	 * Returns the list of sub-client names configured for the client.
-	 *
-	 * @return array List of HTML client names
-	 */
-	protected function getSubClientNames()
-	{
-		return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
-	}
+    /** client/html/email/delivery/html/summary/service/standard/subparts
+     * List of HTML sub-clients rendered within the summary service section of the delivery HTML e-mail
+     *
+     * 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/email/delivery/html/summary/service/standard/subparts';
+    private $subPartNames = array();
+
+
+    /**
+     * Returns the HTML code for insertion into the body.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string HTML code
+     */
+    public function getBody( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getBody( $uid, $tags, $expire );
+        }
+        $view->serviceBody = $html;
+
+        /** client/html/email/delivery/html/summary/service/standard/template-body
+         * Relative path to the HTML body template of the summary service section of the delivery HTML e-mail 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/email/delivery/html/summary/service/standard/template-header
+         */
+        $tplconf = 'client/html/email/delivery/html/summary/service/standard/template-body';
+        $default = 'common/summary/service-body-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the HTML string for insertion into the header.
+     *
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @param array &$tags Result array for the list of tags that are associated to the output
+     * @param string|null &$expire Result variable for the expiration date of the output (null for no expiry)
+     * @return string|null String including HTML tags for the header on error
+     */
+    public function getHeader( $uid = '', array &$tags = array(), &$expire = null )
+    {
+        $view = $this->setViewParams( $this->getView(), $tags, $expire );
+
+        $html = '';
+        foreach( $this->getSubClients() as $subclient ) {
+            $html .= $subclient->setView( $view )->getHeader( $uid, $tags, $expire );
+        }
+        $view->serviceHeader = $html;
+
+        /** client/html/email/delivery/html/summary/service/standard/template-header
+         * Relative path to the HTML header template of the summary service section of the delivery HTML e-mail 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/email/delivery/html/summary/service/standard/template-body
+         */
+        $tplconf = 'client/html/email/delivery/html/summary/service/standard/template-header';
+        $default = 'common/summary/service-header-default.php';
+
+        return $view->render( $view->config( $tplconf, $default ) );
+    }
+
+
+    /**
+     * Returns the sub-client given by its name.
+     *
+     * @param string $type Name of the client type
+     * @param string|null $name Name of the sub-client (Default if null)
+     * @return \Aimeos\Client\Html\Iface Sub-client object
+     */
+    public function getSubClient( $type, $name = null )
+    {
+        /** client/html/email/delivery/html/summary/service/decorators/excludes
+         * Excludes decorators added by the "common" option from the email delivery html summary service html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to remove a decorator added via
+         * "client/html/common/decorators/default" before they are wrapped
+         * around the html client.
+         *
+         *  client/html/email/delivery/html/summary/service/decorators/excludes = array( 'decorator1' )
+         *
+         * This would remove the decorator named "decorator1" from the list of
+         * common decorators ("\Aimeos\Client\Html\Common\Decorator\*") added via
+         * "client/html/common/decorators/default" to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/email/delivery/html/summary/service/decorators/global
+         * @see client/html/email/delivery/html/summary/service/decorators/local
+         */
+
+        /** client/html/email/delivery/html/summary/service/decorators/global
+         * Adds a list of globally available decorators only to the email delivery html summary service html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap global decorators
+         * ("\Aimeos\Client\Html\Common\Decorator\*") around the html client.
+         *
+         *  client/html/email/delivery/html/summary/service/decorators/global = array( 'decorator1' )
+         *
+         * This would add the decorator named "decorator1" defined by
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/email/delivery/html/summary/service/decorators/excludes
+         * @see client/html/email/delivery/html/summary/service/decorators/local
+         */
+
+        /** client/html/email/delivery/html/summary/service/decorators/local
+         * Adds a list of local decorators only to the email delivery html summary service html client
+         *
+         * Decorators extend the functionality of a class by adding new aspects
+         * (e.g. log what is currently done), executing the methods of the underlying
+         * class only in certain conditions (e.g. only for logged in users) or
+         * modify what is returned to the caller.
+         *
+         * This option allows you to wrap local decorators
+         * ("\Aimeos\Client\Html\Checkout\Decorator\*") around the html client.
+         *
+         *  client/html/email/delivery/html/summary/service/decorators/local = array( 'decorator2' )
+         *
+         * This would add the decorator named "decorator2" defined by
+         * "\Aimeos\Client\Html\Checkout\Decorator\Decorator2" only to the html client.
+         *
+         * @param array List of decorator names
+         * @since 2015.08
+         * @category Developer
+         * @see client/html/common/decorators/default
+         * @see client/html/email/delivery/html/summary/service/decorators/excludes
+         * @see client/html/email/delivery/html/summary/service/decorators/global
+         */
+
+        return $this->createSubClient( 'email/delivery/html/summary/service/' . $type, $name );
+    }
+
+
+    /**
+     * Returns the list of sub-client names configured for the client.
+     *
+     * @return array List of HTML client names
+     */
+    protected function getSubClientNames()
+    {
+        return $this->getContext()->getConfig()->get( $this->subPartPath, $this->subPartNames );
+    }
 }