aimeos / ai-controller-frontend

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

Doc Comments -1 removed lines

@@ -150,7 +150,6 @@
 	 * Sets the delivery/payment service item based on the service ID.
 	 *
 	 * @param string $type Service type code like 'payment' or 'delivery'
-	 * @param string $id|null Unique ID of the service item or null to remove it
 	 * @param array $attributes Associative list of key/value pairs containing the attributes selected or
 	 * 	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

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

Doc Comments -1 removed lines

@@ -363,7 +363,6 @@
 	 * Sets the delivery/payment service item based on the service ID.
 	 *
 	 * @param string $type Service type code like 'payment' or 'delivery'
-	 * @param string $id|null Unique ID of the service item or null to remove it
 	 * @param array $attributes Associative list of key/value pairs containing the attributes selected or
 	 * 	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

Spacing +122 added lines, -122 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\Factory::createManager( $context, 'order/base' );
+		$this->domainManager = \Aimeos\MShop\Factory::createManager($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->type );
+			$this->baskets[$this->type] = $this->domainManager->getSession($this->type);
+			$this->checkLocale($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;
@@ -108,11 +108,11 @@ 
 	public function store()
 	{
 		$basket = $this->get();
-		$basket->setCustomerId( $this->getContext()->getUserId() );
+		$basket->setCustomerId($this->getContext()->getUserId());
 		$basket->finish();
 
 		$this->domainManager->begin();
-		$this->domainManager->store( $basket );
+		$this->domainManager->store($basket);
 		$this->domainManager->commit();
 
 		return $basket;
@@ -127,9 +127,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\Manager\Base\Base::PARTS_ALL, $default = true )
+	public function load($id, $parts = \Aimeos\MShop\Order\Manager\Base\Base::PARTS_ALL, $default = true)
 	{
-		return $this->domainManager->load( $id, $parts, false, $default );
+		return $this->domainManager->load($id, $parts, false, $default);
 	}
 
 
@@ -149,36 +149,36 @@ 
 	 * @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, array $options = array(), array $variantAttributeIds = array(),
+	public function addProduct($prodid, $quantity = 1, array $options = array(), array $variantAttributeIds = array(),
 		array $configAttributeIds = array(), array $hiddenAttributeIds = array(), array $customAttributeValues = array(),
-		$stocktype = 'default' )
+		$stocktype = 'default')
 	{
 		$context = $this->getContext();
-		$productManager = \Aimeos\MShop\Factory::createManager( $context, 'product' );
-		$productItem = $productManager->getItem( $prodid, array( 'media', 'supplier', 'price', 'product', 'text' ) );
+		$productManager = \Aimeos\MShop\Factory::createManager($context, 'product');
+		$productItem = $productManager->getItem($prodid, array('media', 'supplier', 'price', 'product', 'text'));
 
-		$orderBaseProductItem = \Aimeos\MShop\Factory::createManager( $context, 'order/base/product' )->createItem();
-		$orderBaseProductItem->copyFrom( $productItem );
-		$orderBaseProductItem->setQuantity( $quantity );
-		$orderBaseProductItem->setStockType( $stocktype );
+		$orderBaseProductItem = \Aimeos\MShop\Factory::createManager($context, 'order/base/product')->createItem();
+		$orderBaseProductItem->copyFrom($productItem);
+		$orderBaseProductItem->setQuantity($quantity);
+		$orderBaseProductItem->setStockType($stocktype);
 
 		$attr = array();
-		$prices = $productItem->getRefItems( 'price', 'default', 'default' );
+		$prices = $productItem->getRefItems('price', 'default', 'default');
 
-		$priceManager = \Aimeos\MShop\Factory::createManager( $context, 'price' );
-		$price = $priceManager->getLowestPrice( $prices, $quantity );
+		$priceManager = \Aimeos\MShop\Factory::createManager($context, 'price');
+		$price = $priceManager->getLowestPrice($prices, $quantity);
 
-		$attr = array_merge( $attr, $this->createOrderProductAttributes( $price, $prodid, $quantity, $configAttributeIds, 'config' ) );
-		$attr = array_merge( $attr, $this->createOrderProductAttributes( $price, $prodid, $quantity, $hiddenAttributeIds, 'hidden' ) );
-		$attr = array_merge( $attr, $this->createOrderProductAttributes( $price, $prodid, $quantity, array_keys( $customAttributeValues ), 'custom', $customAttributeValues ) );
+		$attr = array_merge($attr, $this->createOrderProductAttributes($price, $prodid, $quantity, $configAttributeIds, 'config'));
+		$attr = array_merge($attr, $this->createOrderProductAttributes($price, $prodid, $quantity, $hiddenAttributeIds, 'hidden'));
+		$attr = array_merge($attr, $this->createOrderProductAttributes($price, $prodid, $quantity, array_keys($customAttributeValues), 'custom', $customAttributeValues));
 
 		// remove product rebate of original price in favor to rebates granted for the order
-		$price->setRebate( '0.00' );
+		$price->setRebate('0.00');
 
-		$orderBaseProductItem->setPrice( $price );
-		$orderBaseProductItem->setAttributes( $attr );
+		$orderBaseProductItem->setPrice($price);
+		$orderBaseProductItem->setAttributes($attr);
 
-		$this->get()->addProduct( $orderBaseProductItem );
+		$this->get()->addProduct($orderBaseProductItem);
 		$this->save();
 	}
 
@@ -188,17 +188,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 = sprintf( 'Basket item at position "%1$d" cannot be deleted manually', $position );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = sprintf('Basket item at position "%1$d" cannot be deleted manually', $position);
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg);
 		}
 
-		$this->get()->deleteProduct( $position );
+		$this->get()->deleteProduct($position);
 		$this->save();
 	}
 
@@ -212,34 +212,34 @@ 
 	 * 	The 'stock'=>false option allows adding products without being in stock.
 	 * @param string[] $configAttributeCodes Codes of the product config attributes that should be REMOVED
 	 */
-	public function editProduct( $position, $quantity, array $options = array(),
-		array $configAttributeCodes = array() )
+	public function editProduct($position, $quantity, array $options = array(),
+		array $configAttributeCodes = array())
 	{
-		$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 = sprintf( 'Basket item at position "%1$d" cannot be changed', $position );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = sprintf('Basket item at position "%1$d" cannot be changed', $position);
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg);
 		}
 
-		$product->setQuantity( $quantity );
+		$product->setQuantity($quantity);
 
 		$attributes = $product->getAttributes();
-		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->setAttributes( $attributes );
+		$product->setAttributes($attributes);
 
-		$productItem = $this->getDomainItem( 'product', 'product.code', $product->getProductCode(), array( 'price', 'text' ) );
-		$prices = $productItem->getRefItems( 'price', 'default' );
-		$product->setPrice( $this->calcPrice( $product, $prices, $quantity ) );
+		$productItem = $this->getDomainItem('product', 'product.code', $product->getProductCode(), array('price', 'text'));
+		$prices = $productItem->getRefItems('price', 'default');
+		$product->setPrice($this->calcPrice($product, $prices, $quantity));
 
-		$this->get()->deleteProduct( $position );
-		$this->get()->addProduct( $product, $position );
+		$this->get()->deleteProduct($position);
+		$this->get()->addProduct($product, $position);
 
 		$this->save();
 	}
@@ -251,49 +251,49 @@ 
 	 * @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)
 	{
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'coupon' );
-		$codeManager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'coupon/code' );
+		$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), 'coupon');
+		$codeManager = \Aimeos\MShop\Factory::createManager($this->getContext(), 'coupon/code');
 
 
-		$search = $codeManager->createSearch( true );
+		$search = $codeManager->createSearch(true);
 		$expr = array(
-			$search->compare( '==', 'coupon.code.code', $code ),
+			$search->compare('==', 'coupon.code.code', $code),
 			$search->getConditions(),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSlice( 0, 1 );
+		$search->setConditions($search->combine('&&', $expr));
+		$search->setSlice(0, 1);
 
-		$result = $codeManager->searchItems( $search );
+		$result = $codeManager->searchItems($search);
 
-		if( ( $codeItem = reset( $result ) ) === false ) {
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( 'Coupon code "%1$s" is invalid or not available any more', $code ) );
+		if (($codeItem = reset($result)) === false) {
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf('Coupon code "%1$s" is invalid or not available any more', $code));
 		}
 
 
-		$search = $manager->createSearch( true );
+		$search = $manager->createSearch(true);
 		$expr = array(
-			$search->compare( '==', 'coupon.id', $codeItem->getParentId() ),
+			$search->compare('==', 'coupon.id', $codeItem->getParentId()),
 			$search->getConditions(),
 		);
-		$search->setConditions( $search->combine( '&&', $expr ) );
-		$search->setSlice( 0, 1 );
+		$search->setConditions($search->combine('&&', $expr));
+		$search->setSlice(0, 1);
 
-		$result = $manager->searchItems( $search );
+		$result = $manager->searchItems($search);
 
-		if( ( $item = reset( $result ) ) === false ) {
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( 'Coupon for code "%1$s" is not available any more', $code ) );
+		if (($item = reset($result)) === false) {
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf('Coupon for code "%1$s" is not available any more', $code));
 		}
 
 
-		$provider = $manager->getProvider( $item, $code );
+		$provider = $manager->getProvider($item, $code);
 
-		if( $provider->isAvailable( $this->get() ) !== true ) {
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( 'Requirements for coupon code "%1$s" aren\'t met', $code ) );
+		if ($provider->isAvailable($this->get()) !== true) {
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf('Requirements for coupon code "%1$s" aren\'t met', $code));
 		}
 
-		$provider->addCoupon( $this->get() );
+		$provider->addCoupon($this->get());
 		$this->save();
 	}
 
@@ -304,21 +304,21 @@ 
 	 * @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)
 	{
-		$manager = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'coupon' );
+		$manager = \Aimeos\MShop\Factory::createManager($this->getContext(), '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 ) {
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( 'Coupon code "%1$s" is invalid', $code ) );
+		if (($item = reset($result)) === false) {
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf('Coupon code "%1$s" is invalid', $code));
 		}
 
-		$manager->getProvider( $item, $code )->deleteCoupon( $this->get() );
+		$manager->getProvider($item, $code)->deleteCoupon($this->get());
 		$this->save();
 	}
 
@@ -331,28 +331,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)
 	{
-		$address = \Aimeos\MShop\Factory::createManager( $this->getContext(), 'order/base/address' )->createItem();
-		$address->setType( $type );
+		$address = \Aimeos\MShop\Factory::createManager($this->getContext(), '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)
 		{
-			$address->copyFrom( $value );
-			$this->get()->setAddress( $address, $type );
+			$address->copyFrom($value);
+			$this->get()->setAddress($address, $type);
 		}
-		else if( is_array( $value ) )
+		else if (is_array($value))
 		{
-			$this->setAddressFromArray( $address, $value );
-			$this->get()->setAddress( $address, $type );
+			$this->setAddressFromArray($address, $value);
+			$this->get()->setAddress($address, $type);
 		}
-		else if( $value === null )
+		else if ($value === null)
 		{
-			$this->get()->deleteAddress( $type );
+			$this->get()->deleteAddress($type);
 		}
 		else
 		{
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( 'Invalid value for address type "%1$s"', $type ) );
+			throw new \Aimeos\Controller\Frontend\Basket\Exception(sprintf('Invalid value for address type "%1$s"', $type));
 		}
 
 		$this->save();
@@ -368,48 +368,48 @@ 
 	 * 	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 setService( $type, $id, array $attributes = array() )
+	public function setService($type, $id, array $attributes = array())
 	{
-		if( $id === null )
+		if ($id === null)
 		{
-			$this->get()->deleteService( $type );
+			$this->get()->deleteService($type);
 			$this->save();
 			return;
 		}
 
 		$context = $this->getContext();
 
-		$serviceManager = \Aimeos\MShop\Factory::createManager( $context, 'service' );
-		$serviceItem = $this->getDomainItem( 'service', 'service.id', $id, array( 'media', 'price', 'text' ) );
+		$serviceManager = \Aimeos\MShop\Factory::createManager($context, 'service');
+		$serviceItem = $this->getDomainItem('service', 'service.id', $id, array('media', 'price', 'text'));
 
-		$provider = $serviceManager->getProvider( $serviceItem );
-		$result = $provider->checkConfigFE( $attributes );
-		$unknown = array_diff_key( $attributes, $result );
+		$provider = $serviceManager->getProvider($serviceItem);
+		$result = $provider->checkConfigFE($attributes);
+		$unknown = array_diff_key($attributes, $result);
 
-		if( count( $unknown ) > 0 )
+		if (count($unknown) > 0)
 		{
-			$msg = sprintf( 'Unknown attributes "%1$s"', implode( '","', array_keys( $unknown ) ) );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg );
+			$msg = sprintf('Unknown attributes "%1$s"', 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\Factory::createManager( $context, 'order/base/service' );
+		$orderBaseServiceManager = \Aimeos\MShop\Factory::createManager($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()->setService( $orderServiceItem, $type );
+		$this->get()->setService($orderServiceItem, $type);
 		$this->save();
 	}
 
@@ -422,18 +422,18 @@ 
 	 * 	an 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
 		}
 
-		$errors = $address->fromArray( $map );
+		$errors = $address->fromArray($map);
 
-		if( count( $errors ) > 0 )
+		if (count($errors) > 0)
 		{
-			$msg = sprintf( 'Invalid address properties, please check your input' );
-			throw new \Aimeos\Controller\Frontend\Basket\Exception( $msg, 0, null, $errors );
+			$msg = sprintf('Invalid address properties, please check your input');
+			throw new \Aimeos\Controller\Frontend\Basket\Exception($msg, 0, null, $errors);
 		}
 	}
 }