aimeos / ai-client-html

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

Indentation +73 added lines, -73 removed lines

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

Braces +2 added lines, -4 removed lines

@@ -53,8 +53,7 @@ 
 			} else {
 				$taxrates[$taxrate] = $price;
 			}
-		}
-		catch( \Exception $e ) { ; } // if delivery service isn't available
+		} catch( \Exception $e ) { ; } // if delivery service isn't available
 
 		try
 		{
@@ -66,8 +65,7 @@ 
 			} else {
 				$taxrates[$taxrate] = $price;
 			}
-		}
-		catch( \Exception $e ) { ; } // if payment service isn't available
+		} catch( \Exception $e ) { ; } // if payment service isn't available
 
 		return $taxrates;
 	}

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

Indentation +1 added lines, -1 removed lines

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

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

Indentation +10 added lines, -10 removed lines

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

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

Indentation +14 added lines, -14 removed lines

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

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

Indentation +11 added lines, -11 removed lines

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

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

Indentation +162 added lines, -162 removed lines

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

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

Indentation +9 added lines, -9 removed lines

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

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

Indentation +151 added lines, -151 removed lines

@@ -20,155 +20,155 @@
  */
 class Base
 {
-	private static $objects = array();
-
-
-	/**
-	 * Injects a client object.
-	 * The object is returned via createClient() if an instance of the class
-	 * with the name name is requested.
-	 *
-	 * @param string $classname Full name of the class for which the object should be returned
-	 * @param \Aimeos\Client\Html\Iface|null $client ExtJS client object
-	 */
-	public static function injectClient( $classname, \Aimeos\Client\Html\Iface $client = null )
-	{
-		self::$objects[$classname] = $client;
-	}
-
-
-	/**
-	 * Adds the decorators to the client object.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
-	 * @param \Aimeos\Client\Html\Iface $client Client object
-	 * @param array $templatePaths List of file system paths where the templates are stored
-	 * @param array $decorators List of decorator name that should be wrapped around the client
-	 * @param string $classprefix Decorator class prefix, e.g. "\Aimeos\Client\Html\Catalog\Decorator\"
-	 * @return \Aimeos\Client\Html\Iface Client object
-	 */
-	protected static function addDecorators( \Aimeos\MShop\Context\Item\Iface $context,
-		\Aimeos\Client\Html\Iface $client, array $templatePaths, array $decorators, $classprefix )
-	{
-		$iface = '\\Aimeos\\Client\\Html\\Common\\Decorator\\Iface';
-
-		foreach( $decorators as $name )
-		{
-			if( ctype_alnum( $name ) === false )
-			{
-				$classname = is_string( $name ) ? $classprefix . $name : '<not a string>';
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid class name "%1$s"', $classname ) );
-			}
-
-			$classname = $classprefix . $name;
-
-			if( class_exists( $classname ) === false ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not found', $classname ) );
-			}
-
-			$client = new $classname( $client, $context, $templatePaths );
-
-			if( !( $client instanceof $iface ) ) {
-				throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement "%2$s"', $classname, $iface ) );
-			}
-		}
-
-		return $client;
-	}
-
-
-	/**
-	 * Adds the decorators to the client object.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
-	 * @param \Aimeos\Client\Html\Iface $client Client object
-	 * @param array $templatePaths List of file system paths where the templates are stored
-	 * @param string $path Path of the client in lower case, e.g. "catalog/detail"
-	 * @return \Aimeos\Client\Html\Iface Client object
-	 */
-	protected static function addClientDecorators( \Aimeos\MShop\Context\Item\Iface $context,
-		\Aimeos\Client\Html\Iface $client, array $templatePaths, $path )
-	{
-		if( !is_string( $path ) || $path === '' ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid domain "%1$s"', $path ) );
-		}
-
-		$localClass = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
-		$config = $context->getConfig();
-
-		/** client/html/common/decorators/default
-		 * Configures the list of decorators applied to all html clients
-		 *
-		 * 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 configure a list of decorator names that should
-		 * be wrapped around the original instance of all created clients:
-		 *
-		 *  client/html/common/decorators/default = array( 'decorator1', 'decorator2' )
-		 *
-		 * This would wrap the decorators named "decorator1" and "decorator2" around
-		 * all client instances in that order. The decorator classes would be
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator1" and
-		 * "\Aimeos\Client\Html\Common\Decorator\Decorator2".
-		 *
-		 * @param array List of decorator names
-		 * @since 2014.03
-		 * @category Developer
-		 */
-		$decorators = $config->get( 'client/html/common/decorators/default', array() );
-		$excludes = $config->get( 'client/html/' . $path . '/decorators/excludes', array() );
-
-		foreach( $decorators as $key => $name )
-		{
-			if( in_array( $name, $excludes ) ) {
-				unset( $decorators[$key] );
-			}
-		}
-
-		$classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
-		$client = self::addDecorators( $context, $client, $templatePaths, $decorators, $classprefix );
-
-		$classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
-		$decorators = $config->get( 'client/html/' . $path . '/decorators/global', array() );
-		$client = self::addDecorators( $context, $client, $templatePaths, $decorators, $classprefix );
-
-		$classprefix = '\\Aimeos\\Client\\Html\\' . $localClass . '\\Decorator\\';
-		$decorators = $config->get( 'client/html/' . $path . '/decorators/local', array() );
-		$client = self::addDecorators( $context, $client, $templatePaths, $decorators, $classprefix );
-
-		return $client;
-	}
-
-
-	/**
-	 * Creates a client object.
-	 *
-	 * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
-	 * @param string $classname Name of the client class
-	 * @param string $interface Name of the client interface
-	 * @param array $templatePaths List of file system paths where the templates are stored
-	 * @return \Aimeos\Client\Html\\Iface Client object
-	 * @throws \Aimeos\Client\Html\Exception If client couldn't be found or doesn't implement the interface
-	 */
-	protected static function createClientBase( \Aimeos\MShop\Context\Item\Iface $context, $classname, $interface, $templatePaths )
-	{
-		if( isset( self::$objects[$classname] ) ) {
-			return self::$objects[$classname];
-		}
-
-		if( class_exists( $classname ) === false ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $classname ) );
-		}
-
-		$client = new $classname( $context, $templatePaths );
-
-		if( !( $client instanceof $interface ) ) {
-			throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement interface "%2$s"', $classname, $interface ) );
-		}
-
-		return $client;
-	}
+    private static $objects = array();
+
+
+    /**
+     * Injects a client object.
+     * The object is returned via createClient() if an instance of the class
+     * with the name name is requested.
+     *
+     * @param string $classname Full name of the class for which the object should be returned
+     * @param \Aimeos\Client\Html\Iface|null $client ExtJS client object
+     */
+    public static function injectClient( $classname, \Aimeos\Client\Html\Iface $client = null )
+    {
+        self::$objects[$classname] = $client;
+    }
+
+
+    /**
+     * Adds the decorators to the client object.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
+     * @param \Aimeos\Client\Html\Iface $client Client object
+     * @param array $templatePaths List of file system paths where the templates are stored
+     * @param array $decorators List of decorator name that should be wrapped around the client
+     * @param string $classprefix Decorator class prefix, e.g. "\Aimeos\Client\Html\Catalog\Decorator\"
+     * @return \Aimeos\Client\Html\Iface Client object
+     */
+    protected static function addDecorators( \Aimeos\MShop\Context\Item\Iface $context,
+        \Aimeos\Client\Html\Iface $client, array $templatePaths, array $decorators, $classprefix )
+    {
+        $iface = '\\Aimeos\\Client\\Html\\Common\\Decorator\\Iface';
+
+        foreach( $decorators as $name )
+        {
+            if( ctype_alnum( $name ) === false )
+            {
+                $classname = is_string( $name ) ? $classprefix . $name : '<not a string>';
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid class name "%1$s"', $classname ) );
+            }
+
+            $classname = $classprefix . $name;
+
+            if( class_exists( $classname ) === false ) {
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not found', $classname ) );
+            }
+
+            $client = new $classname( $client, $context, $templatePaths );
+
+            if( !( $client instanceof $iface ) ) {
+                throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement "%2$s"', $classname, $iface ) );
+            }
+        }
+
+        return $client;
+    }
+
+
+    /**
+     * Adds the decorators to the client object.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
+     * @param \Aimeos\Client\Html\Iface $client Client object
+     * @param array $templatePaths List of file system paths where the templates are stored
+     * @param string $path Path of the client in lower case, e.g. "catalog/detail"
+     * @return \Aimeos\Client\Html\Iface Client object
+     */
+    protected static function addClientDecorators( \Aimeos\MShop\Context\Item\Iface $context,
+        \Aimeos\Client\Html\Iface $client, array $templatePaths, $path )
+    {
+        if( !is_string( $path ) || $path === '' ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Invalid domain "%1$s"', $path ) );
+        }
+
+        $localClass = str_replace( ' ', '\\', ucwords( str_replace( '/', ' ', $path ) ) );
+        $config = $context->getConfig();
+
+        /** client/html/common/decorators/default
+         * Configures the list of decorators applied to all html clients
+         *
+         * 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 configure a list of decorator names that should
+         * be wrapped around the original instance of all created clients:
+         *
+         *  client/html/common/decorators/default = array( 'decorator1', 'decorator2' )
+         *
+         * This would wrap the decorators named "decorator1" and "decorator2" around
+         * all client instances in that order. The decorator classes would be
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator1" and
+         * "\Aimeos\Client\Html\Common\Decorator\Decorator2".
+         *
+         * @param array List of decorator names
+         * @since 2014.03
+         * @category Developer
+         */
+        $decorators = $config->get( 'client/html/common/decorators/default', array() );
+        $excludes = $config->get( 'client/html/' . $path . '/decorators/excludes', array() );
+
+        foreach( $decorators as $key => $name )
+        {
+            if( in_array( $name, $excludes ) ) {
+                unset( $decorators[$key] );
+            }
+        }
+
+        $classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
+        $client = self::addDecorators( $context, $client, $templatePaths, $decorators, $classprefix );
+
+        $classprefix = '\\Aimeos\\Client\\Html\\Common\\Decorator\\';
+        $decorators = $config->get( 'client/html/' . $path . '/decorators/global', array() );
+        $client = self::addDecorators( $context, $client, $templatePaths, $decorators, $classprefix );
+
+        $classprefix = '\\Aimeos\\Client\\Html\\' . $localClass . '\\Decorator\\';
+        $decorators = $config->get( 'client/html/' . $path . '/decorators/local', array() );
+        $client = self::addDecorators( $context, $client, $templatePaths, $decorators, $classprefix );
+
+        return $client;
+    }
+
+
+    /**
+     * Creates a client object.
+     *
+     * @param \Aimeos\MShop\Context\Item\Iface $context Context instance with necessary objects
+     * @param string $classname Name of the client class
+     * @param string $interface Name of the client interface
+     * @param array $templatePaths List of file system paths where the templates are stored
+     * @return \Aimeos\Client\Html\\Iface Client object
+     * @throws \Aimeos\Client\Html\Exception If client couldn't be found or doesn't implement the interface
+     */
+    protected static function createClientBase( \Aimeos\MShop\Context\Item\Iface $context, $classname, $interface, $templatePaths )
+    {
+        if( isset( self::$objects[$classname] ) ) {
+            return self::$objects[$classname];
+        }
+
+        if( class_exists( $classname ) === false ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" not available', $classname ) );
+        }
+
+        $client = new $classname( $context, $templatePaths );
+
+        if( !( $client instanceof $interface ) ) {
+            throw new \Aimeos\Client\Html\Exception( sprintf( 'Class "%1$s" does not implement interface "%2$s"', $classname, $interface ) );
+        }
+
+        return $client;
+    }
 }

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

Indentation +63 added lines, -63 removed lines

@@ -20,74 +20,74 @@
  */
 interface Iface
 {
-	/**
-	 * 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 );
+    /**
+     * 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 );
 
-	/**
-	 * 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 );
+    /**
+     * 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 );
 
-	/**
-	 * 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 );
+    /**
+     * 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 );
 
-	/**
-	 * Returns the view object that will generate the HTML output.
-	 *
-	 * @return \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 */
-	public function getView();
+    /**
+     * Returns the view object that will generate the HTML output.
+     *
+     * @return \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     */
+    public function getView();
 
-	/**
-	 * Sets the view object that will generate the HTML output.
-	 *
-	 * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
-	 * @return \Aimeos\Client\Html\Iface Reference to this object for fluent calls
-	 */
-	public function setView( \Aimeos\MW\View\Iface $view );
+    /**
+     * Sets the view object that will generate the HTML output.
+     *
+     * @param \Aimeos\MW\View\Iface $view The view object which generates the HTML output
+     * @return \Aimeos\Client\Html\Iface Reference to this object for fluent calls
+     */
+    public function setView( \Aimeos\MW\View\Iface $view );
 
-	/**
-	 * Modifies the cached body content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified body content
-	 */
-	public function modifyBody( $content, $uid );
+    /**
+     * Modifies the cached body content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified body content
+     */
+    public function modifyBody( $content, $uid );
 
-	/**
-	 * Modifies the cached header content to replace content based on sessions or cookies.
-	 *
-	 * @param string $content Cached content
-	 * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
-	 * @return string Modified header content
-	 */
-	public function modifyHeader( $content, $uid );
+    /**
+     * Modifies the cached header content to replace content based on sessions or cookies.
+     *
+     * @param string $content Cached content
+     * @param string $uid Unique identifier for the output if the content is placed more than once on the same page
+     * @return string Modified header content
+     */
+    public function modifyHeader( $content, $uid );
 
-	/**
-	 * 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.
-	 *
-	 * @return boolean False if processing is stopped, otherwise all processing was completed successfully
-	 */
-	public function process();
+    /**
+     * 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.
+     *
+     * @return boolean False if processing is stopped, otherwise all processing was completed successfully
+     */
+    public function process();
 }