aimeos / ai-controller-frontend

controller/frontend/src/Controller/Frontend/Basket/Standard.php

Spacing +130 added lines, -130 removed lines

@@ -33,11 +33,11 @@ 
 	 * @param \Aimeos\MShop\Context\Item\Iface $context Object storing the required instances for manaing databases
 	 *  connections, logger, session, etc.
 	 */
-	public function __construct( \Aimeos\MShop\Context\Item\Iface $context )
+	public function __construct(\Aimeos\MShop\Context\Item\Iface $context)
 	{
-		parent::__construct( $context );
+		parent::__construct($context);
 
-		$this->domainManager = \Aimeos\MShop::create( $context, 'order/base' );
+		$this->domainManager = \Aimeos\MShop::create($context, 'order/base');
 	}
 
 
@@ -49,7 +49,7 @@ 
 	public function clear()
 	{
 		$this->baskets[$this->type] = $this->domainManager->createItem();
-		$this->domainManager->setSession( $this->baskets[$this->type], $this->type );
+		$this->domainManager->setSession($this->baskets[$this->type], $this->type);
 
 		return $this;
 	}
@@ -62,10 +62,10 @@ 
 	 */
 	public function get()
 	{
-		if( !isset( $this->baskets[$this->type] ) )
+		if (!isset($this->baskets[$this->type]))
 		{
-			$this->baskets[$this->type] = $this->domainManager->getSession( $this->type );
-			$this->checkLocale( $this->baskets[$this->type]->getLocale(), $this->type );
+			$this->baskets[$this->type] = $this->domainManager->getSession($this->type);
+			$this->checkLocale($this->baskets[$this->type]->getLocale(), $this->type);
 		}
 
 		return $this->baskets[$this->type];
@@ -79,8 +79,8 @@ 
 	 */
 	public function save()
 	{
-		if( isset( $this->baskets[$this->type] ) && $this->baskets[$this->type]->isModified() ) {
-			$this->domainManager->setSession( $this->baskets[$this->type], $this->type );
+		if (isset($this->baskets[$this->type]) && $this->baskets[$this->type]->isModified()) {
+			$this->domainManager->setSession($this->baskets[$this->type], $this->type);
 		}
 
 		return $this;
@@ -93,7 +93,7 @@ 
 	 * @param string $type Basket type
 	 * @return \Aimeos\Controller\Frontend\Basket\Iface Basket frontend object
 	 */
-	public function setType( $type )
+	public function setType($type)
 	{
 		$this->type = $type;
 		return $this;
@@ -127,7 +127,7 @@ 
 		 * @category Developer
 		 * @see controller/frontend/basket/limit-seconds
 		 */
-		$count = $config->get( 'controller/frontend/basket/limit-count', 5 );
+		$count = $config->get('controller/frontend/basket/limit-count', 5);
 
 		/** controller/frontend/basket/limit-seconds
 		 * Order limitation time frame in seconds
@@ -145,34 +145,34 @@ 
 		 * @category Developer
 		 * @see controller/frontend/basket/limit-count
 		 */
-		$seconds = $config->get( 'controller/frontend/basket/limit-seconds', 300 );
+		$seconds = $config->get('controller/frontend/basket/limit-seconds', 300);
 
 		$search = $this->domainManager->createSearch();
 		$expr = [
-			$search->compare( '==', 'order.base.editor', $context->getEditor() ),
-			$search->compare( '>=', 'order.base.ctime', date( 'Y-m-d H:i:s', time() - $seconds ) ),
+			$search->compare('==', 'order.base.editor', $context->getEditor()),
+			$search->compare('>=', 'order.base.ctime', date('Y-m-d H:i:s', time() - $seconds)),
 		];
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSlice( 0, 0 );
+		$search->setConditions($search->combine('&&', $expr));
+		$search->setSlice(0, 0);
 
-		$this->domainManager->searchItems( $search, [], $total );
+		$this->domainManager->searchItems($search, [], $total);
 
-		if( $total > $count )
+		if ($total > $count)
 		{
-			$msg = $context->getI18n()->dt( 'controller/frontend', 'Temporary order limit reached' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = $context->getI18n()->dt('controller/frontend', 'Temporary order limit reached');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg);
 		}
 
 
 		$basket = $this->get()->finish();
-		$basket->setCustomerId( (string) $context->getUserId() );
+		$basket->setCustomerId((string) $context->getUserId());
 
 		$this->domainManager->begin();
-		$this->domainManager->store( $basket );
+		$this->domainManager->store($basket);
 		$this->domainManager->commit();
 
 		$this->save(); // for reusing unpaid orders, might have side effects (!)
-		$this->createSubscriptions( $basket );
+		$this->createSubscriptions($basket);
 
 		return $basket;
 	}
@@ -186,9 +186,9 @@ 
 	 * @param boolean $default True to add default criteria (user logged in), false if not
 	 * @return \Aimeos\MShop\Order\Item\Base\Iface Order base object including the given parts
 	 */
-	public function load( $id, $parts = \Aimeos\MShop\Order\Item\Base\Base::PARTS_ALL, $default = true )
+	public function load($id, $parts = \Aimeos\MShop\Order\Item\Base\Base::PARTS_ALL, $default = true)
 	{
-		return $this->domainManager->load( $id, $parts, false, $default );
+		return $this->domainManager->load($id, $parts, false, $default);
 	}
 
 
@@ -207,34 +207,34 @@ 
 	 * @param string $stocktype Unique code of the stock type to deliver the products from
 	 * @throws \Aimeos\Controller\Frontend\Basket\Exception If the product isn't available
 	 */
-	public function addProduct( $prodid, $quantity = 1, $stocktype = 'default', array $variantAttributeIds = [],
-		array $configAttributeIds = [], array $hiddenAttributeIds = [], array $customAttributeValues = [] )
+	public function addProduct($prodid, $quantity = 1, $stocktype = 'default', array $variantAttributeIds = [],
+		array $configAttributeIds = [], array $hiddenAttributeIds = [], array $customAttributeValues = [])
 	{
 		$attributeMap = [
-			'custom' => array_keys( $customAttributeValues ),
-			'config' => array_keys( $configAttributeIds ),
+			'custom' => array_keys($customAttributeValues),
+			'config' => array_keys($configAttributeIds),
 		];
-		$this->checkListRef( $prodid, 'attribute', $attributeMap );
+		$this->checkListRef($prodid, 'attribute', $attributeMap);
 
 
 		$context = $this->getContext();
-		$productManager = \Aimeos\MShop::create( $context, 'product' );
+		$productManager = \Aimeos\MShop::create($context, 'product');
 
-		$productItem = $productManager->getItem( $prodid, ['attribute', 'media', 'supplier', 'price', 'product', 'text'], true );
-		$prices = $productItem->getRefItems( 'price', 'default', 'default' );
-		$hidden = $productItem->getRefItems( 'attribute', null, 'hidden' );
+		$productItem = $productManager->getItem($prodid, ['attribute', 'media', 'supplier', 'price', 'product', 'text'], true);
+		$prices = $productItem->getRefItems('price', 'default', 'default');
+		$hidden = $productItem->getRefItems('attribute', null, 'hidden');
 
-		$orderBaseProductItem = \Aimeos\MShop::create( $context, 'order/base/product' )->createItem();
-		$orderBaseProductItem->copyFrom( $productItem )->setQuantity( $quantity )->setStockType( $stocktype );
+		$orderBaseProductItem = \Aimeos\MShop::create($context, 'order/base/product')->createItem();
+		$orderBaseProductItem->copyFrom($productItem)->setQuantity($quantity)->setStockType($stocktype);
 
-		$custAttr = $this->getOrderProductAttributes( 'custom', array_keys( $customAttributeValues ), $customAttributeValues );
-		$confAttr = $this->getOrderProductAttributes( 'config', array_keys( $configAttributeIds ), [], $configAttributeIds );
-		$attr = array_merge( $custAttr, $confAttr, $this->getOrderProductAttributes( 'hidden', array_keys( $hidden ) ) );
+		$custAttr = $this->getOrderProductAttributes('custom', array_keys($customAttributeValues), $customAttributeValues);
+		$confAttr = $this->getOrderProductAttributes('config', array_keys($configAttributeIds), [], $configAttributeIds);
+		$attr = array_merge($custAttr, $confAttr, $this->getOrderProductAttributes('hidden', array_keys($hidden)));
 
-		$orderBaseProductItem->setAttributeItems( $attr );
-		$orderBaseProductItem->setPrice( $this->calcPrice( $orderBaseProductItem, $prices, $quantity ) );
+		$orderBaseProductItem->setAttributeItems($attr);
+		$orderBaseProductItem->setPrice($this->calcPrice($orderBaseProductItem, $prices, $quantity));
 
-		$this->get()->addProduct( $orderBaseProductItem );
+		$this->get()->addProduct($orderBaseProductItem);
 		$this->save();
 	}
 
@@ -244,17 +244,17 @@ 
 	 *
 	 * @param integer $position Position number (key) of the order product item
 	 */
-	public function deleteProduct( $position )
+	public function deleteProduct($position)
 	{
-		$product = $this->get()->getProduct( $position );
+		$product = $this->get()->getProduct($position);
 
-		if( $product->getFlags() === \Aimeos\MShop\Order\Item\Base\Product\Base::FLAG_IMMUTABLE )
+		if ($product->getFlags() === \Aimeos\MShop\Order\Item\Base\Product\Base::FLAG_IMMUTABLE)
 		{
-			$msg = $this->getContext()->getI18n()->dt( 'controller/frontend', 'Basket item at position "%1$d" cannot be deleted manually' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( $msg, $position ) );
+			$msg = $this->getContext()->getI18n()->dt('controller/frontend', 'Basket item at position "%1$d" cannot be deleted manually');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf($msg, $position));
 		}
 
-		$this->get()->deleteProduct( $position );
+		$this->get()->deleteProduct($position);
 		$this->save();
 	}
 
@@ -266,32 +266,32 @@ 
 	 * @param integer $quantity New quantiy of the product item
 	 * @param string[] $configAttributeCodes Codes of the product config attributes that should be REMOVED
 	 */
-	public function editProduct( $position, $quantity, array $configAttributeCodes = [] )
+	public function editProduct($position, $quantity, array $configAttributeCodes = [])
 	{
-		$product = $this->get()->getProduct( $position );
+		$product = $this->get()->getProduct($position);
 
-		if( $product->getFlags() & \Aimeos\MShop\Order\Item\Base\Product\Base::FLAG_IMMUTABLE )
+		if ($product->getFlags() & \Aimeos\MShop\Order\Item\Base\Product\Base::FLAG_IMMUTABLE)
 		{
-			$msg = $this->getContext()->getI18n()->dt( 'controller/frontend', 'Basket item at position "%1$d" cannot be changed' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( $msg, $position ) );
+			$msg = $this->getContext()->getI18n()->dt('controller/frontend', 'Basket item at position "%1$d" cannot be changed');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf($msg, $position));
 		}
 
-		$product->setQuantity( $quantity );
+		$product->setQuantity($quantity);
 
 		$attributes = $product->getAttributeItems();
-		foreach( $attributes as $key => $attribute )
+		foreach ($attributes as $key => $attribute)
 		{
-			if( in_array( $attribute->getCode(), $configAttributeCodes ) ) {
-				unset( $attributes[$key] );
+			if (in_array($attribute->getCode(), $configAttributeCodes)) {
+				unset($attributes[$key]);
 			}
 		}
-		$product->setAttributeItems( $attributes );
+		$product->setAttributeItems($attributes);
 
-		$manager = \Aimeos\MShop::create( $this->getContext(), 'product' );
-		$productItem = $manager->findItem( $product->getProductCode(), array( 'price', 'text' ), true );
-		$product->setPrice( $this->calcPrice( $product, $productItem->getRefItems( 'price', 'default' ), $quantity ) );
+		$manager = \Aimeos\MShop::create($this->getContext(), 'product');
+		$productItem = $manager->findItem($product->getProductCode(), array('price', 'text'), true);
+		$product->setPrice($this->calcPrice($product, $productItem->getRefItems('price', 'default'), $quantity));
 
-		$this->get()->editProduct( $product, $position );
+		$this->get()->editProduct($product, $position);
 
 		$this->save();
 	}
@@ -303,7 +303,7 @@ 
 	 * @param string $code Coupon code entered by the user
 	 * @throws \Aimeos\Controller\Frontend\Basket\Exception if the coupon code is invalid or not allowed
 	 */
-	public function addCoupon( $code )
+	public function addCoupon($code)
 	{
 		$context = $this->getContext();
 
@@ -323,44 +323,44 @@ 
 		 * @category User
 		 * @category Developer
 		 */
-		$allowed = $context->getConfig()->get( 'controller/frontend/basket/standard/coupon/allowed', 1 );
+		$allowed = $context->getConfig()->get('controller/frontend/basket/standard/coupon/allowed', 1);
 
-		if( $allowed <= count( $this->get()->getCoupons() ) )
+		if ($allowed <= count($this->get()->getCoupons()))
 		{
-			$msg = $context->getI18n()->dt( 'controller/frontend', 'Number of coupon codes exceeds the limit' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = $context->getI18n()->dt('controller/frontend', 'Number of coupon codes exceeds the limit');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg);
 		}
 
 
-		$manager = \Aimeos\MShop::create( $context, 'coupon' );
-		$codeManager = \Aimeos\MShop::create( $context, 'coupon/code' );
+		$manager = \Aimeos\MShop::create($context, 'coupon');
+		$codeManager = \Aimeos\MShop::create($context, 'coupon/code');
 
-		$search = $manager->createSearch( true )->setSlice( 0, 1 );
+		$search = $manager->createSearch(true)->setSlice(0, 1);
 		$expr = [
-			$search->compare( '==', 'coupon.code.code', $code ),
-			$codeManager->createSearch( true )->getConditions(),
+			$search->compare('==', 'coupon.code.code', $code),
+			$codeManager->createSearch(true)->getConditions(),
 			$search->getConditions(),
 		];
-		$search->setConditions( $search->combine( '&&', $expr ) );
+		$search->setConditions($search->combine('&&', $expr));
 
-		$result = $manager->searchItems( $search );
+		$result = $manager->searchItems($search);
 
-		if( ( $item = reset( $result ) ) === false )
+		if (($item = reset($result)) === false)
 		{
-			$msg = sprintf( $context->getI18n()->dt( 'controller/frontend', 'Coupon code "%1$s" is invalid or not available any more' ), $code );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = sprintf($context->getI18n()->dt('controller/frontend', 'Coupon code "%1$s" is invalid or not available any more'), $code);
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg);
 		}
 
 
-		$provider = $manager->getProvider( $item, $code );
+		$provider = $manager->getProvider($item, $code);
 
-		if( $provider->isAvailable( $this->get() ) !== true )
+		if ($provider->isAvailable($this->get()) !== true)
 		{
-			$msg = sprintf( $context->getI18n()->dt( 'controller/frontend', 'Requirements for coupon code "%1$s" aren\'t met' ), $code );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = sprintf($context->getI18n()->dt('controller/frontend', 'Requirements for coupon code "%1$s" aren\'t met'), $code);
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg);
 		}
 
-		$provider->addCoupon( $this->get() );
+		$provider->addCoupon($this->get());
 		$this->save();
 	}
 
@@ -371,24 +371,24 @@ 
 	 * @param string $code Coupon code entered by the user
 	 * @throws \Aimeos\Controller\Frontend\Basket\Exception if the coupon code is invalid
 	 */
-	public function deleteCoupon( $code )
+	public function deleteCoupon($code)
 	{
 		$context = $this->getContext();
-		$manager = \Aimeos\MShop::create( $context, 'coupon' );
+		$manager = \Aimeos\MShop::create($context, 'coupon');
 
 		$search = $manager->createSearch();
-		$search->setConditions( $search->compare( '==', 'coupon.code.code', $code ) );
-		$search->setSlice( 0, 1 );
+		$search->setConditions($search->compare('==', 'coupon.code.code', $code));
+		$search->setSlice(0, 1);
 
-		$result = $manager->searchItems( $search );
+		$result = $manager->searchItems($search);
 
-		if( ( $item = reset( $result ) ) === false )
+		if (($item = reset($result)) === false)
 		{
-			$msg = $context->getI18n()->dt( 'controller/frontend', 'Coupon code "%1$s" is invalid' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( $msg, $code ) );
+			$msg = $context->getI18n()->dt('controller/frontend', 'Coupon code "%1$s" is invalid');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf($msg, $code));
 		}
 
-		$manager->getProvider( $item, $code )->deleteCoupon( $this->get() );
+		$manager->getProvider($item, $code)->deleteCoupon($this->get());
 		$this->save();
 	}
 
@@ -401,28 +401,28 @@ 
 	 * @throws \Aimeos\Controller\Frontend\Basket\Exception If the billing or delivery address is not of any required type of
 	 * 	if one of the keys is invalid when using an array with key/value pairs
 	 */
-	public function setAddress( $type, $value )
+	public function setAddress($type, $value)
 	{
 		$context = $this->getContext();
-		$address = \Aimeos\MShop::create( $context, 'order/base/address' )->createItem();
-		$address->setType( $type );
+		$address = \Aimeos\MShop::create($context, 'order/base/address')->createItem();
+		$address->setType($type);
 
-		if( $value instanceof \Aimeos\MShop\Common\Item\Address\Iface )
+		if ($value instanceof \Aimeos\MShop\Common\Item\Address\Iface)
 		{
-			$this->get()->setAddress( $address->copyFrom( $value ), $type );
+			$this->get()->setAddress($address->copyFrom($value), $type);
 		}
-		else if( is_array( $value ) )
+		else if (is_array($value))
 		{
-			$this->get()->setAddress( $this->setAddressFromArray( $address, $value ), $type );
+			$this->get()->setAddress($this->setAddressFromArray($address, $value), $type);
 		}
-		else if( $value === null )
+		else if ($value === null)
 		{
-			$this->get()->deleteAddress( $type );
+			$this->get()->deleteAddress($type);
 		}
 		else
 		{
-			$msg = $context->getI18n()->dt( 'controller/frontend', 'Invalid value for address type "%1$s"' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( $msg, $type ) );
+			$msg = $context->getI18n()->dt('controller/frontend', 'Invalid value for address type "%1$s"');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf($msg, $type));
 		}
 
 		$this->save();
@@ -438,42 +438,42 @@ 
 	 * 	entered by the customer when choosing one of the delivery or payment options
 	 * @throws \Aimeos\Controller\Frontend\Basket\Exception If there is no price to the service item attached
 	 */
-	public function addService( $type, $id, array $attributes = [] )
+	public function addService($type, $id, array $attributes = [])
 	{
 		$context = $this->getContext();
 
-		$serviceManager = \Aimeos\MShop::create( $context, 'service' );
-		$serviceItem = $serviceManager->getItem( $id, array( 'media', 'price', 'text' ) );
+		$serviceManager = \Aimeos\MShop::create($context, 'service');
+		$serviceItem = $serviceManager->getItem($id, array('media', 'price', 'text'));
 
-		$provider = $serviceManager->getProvider( $serviceItem, $serviceItem->getType() );
-		$result = $provider->checkConfigFE( $attributes );
-		$unknown = array_diff_key( $attributes, $result );
+		$provider = $serviceManager->getProvider($serviceItem, $serviceItem->getType());
+		$result = $provider->checkConfigFE($attributes);
+		$unknown = array_diff_key($attributes, $result);
 
-		if( count( $unknown ) > 0 )
+		if (count($unknown) > 0)
 		{
-			$msg = $context->getI18n()->dt( 'controller/frontend', 'Unknown attributes "%1$s"' );
-			$msg = sprintf( $msg, implode( '","', array_keys( $unknown ) ) );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = $context->getI18n()->dt('controller/frontend', 'Unknown attributes "%1$s"');
+			$msg = sprintf($msg, implode('","', array_keys($unknown)));
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg);
 		}
 
-		foreach( $result as $key => $value )
+		foreach ($result as $key => $value)
 		{
-			if( $value !== null ) {
-				throw new \Aimeos\Controller\Frontend\Basket\Exception( $value );
+			if ($value !== null) {
+				throw new \Aimeos\Controller\Frontend\Basket\Exception($value);
 			}
 		}
 
-		$orderBaseServiceManager = \Aimeos\MShop::create( $context, 'order/base/service' );
+		$orderBaseServiceManager = \Aimeos\MShop::create($context, 'order/base/service');
 		$orderServiceItem = $orderBaseServiceManager->createItem();
-		$orderServiceItem->copyFrom( $serviceItem );
+		$orderServiceItem->copyFrom($serviceItem);
 
 		// remove service rebate of original price
-		$price = $provider->calcPrice( $this->get() )->setRebate( '0.00' );
-		$orderServiceItem->setPrice( $price );
+		$price = $provider->calcPrice($this->get())->setRebate('0.00');
+		$orderServiceItem->setPrice($price);
 
-		$provider->setConfigFE( $orderServiceItem, $attributes );
+		$provider->setConfigFE($orderServiceItem, $attributes);
 
-		$this->get()->addService( $orderServiceItem, $type );
+		$this->get()->addService($orderServiceItem, $type);
 		$this->save();
 	}
 
@@ -483,9 +483,9 @@ 
 	 *
 	 * @param string $type Service type code like 'payment' or 'delivery'
 	 */
-	public function deleteService( $type )
+	public function deleteService($type)
 	{
-		$this->get()->deleteService( $type );
+		$this->get()->deleteService($type);
 		$this->save();
 	}
 
@@ -499,18 +499,18 @@ 
 	 * @return \Aimeos\MShop\Order\Item\Base\Address\Iface Updated address item
 	 * @throws \Aimeos\Controller\Frontend\Basket\Exception
 	 */
-	protected function setAddressFromArray( \Aimeos\MShop\Order\Item\Base\Address\Iface $address, array $map )
+	protected function setAddressFromArray(\Aimeos\MShop\Order\Item\Base\Address\Iface $address, array $map)
 	{
-		foreach( $map as $key => $value ) {
-			$map[$key] = strip_tags( $value ); // prevent XSS
+		foreach ($map as $key => $value) {
+			$map[$key] = strip_tags($value); // prevent XSS
 		}
 
-		$address = $address->fromArray( $map );
+		$address = $address->fromArray($map);
 
-		if( count( $map ) > 0 )
+		if (count($map) > 0)
 		{
-			$msg = $this->getContext()->getI18n()->dt( 'controller/frontend', 'Invalid address properties, please check your input' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg, 0, null, $map );
+			$msg = $this->getContext()->getI18n()->dt('controller/frontend', 'Invalid address properties, please check your input');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg, 0, null, $map);
 		}
 
 		return $address;