Aimeos\Controller\Frontend\Basket\Decorator\Select

Complexity

Total Complexity

14

Size/Duplication

Total Lines	137
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
B	getArticle()	0	51	8
B	addProduct()	0	57	6

<?php

/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2017-2018
 * @package Controller
 * @subpackage Frontend
 */


namespace Aimeos\Controller\Frontend\Basket\Decorator;


/**
 * Selection product handling
 *
 * @package Controller
 * @subpackage Frontend
 */
class Select
	extends \Aimeos\Controller\Frontend\Basket\Decorator\Base
	implements \Aimeos\Controller\Frontend\Basket\Iface, \Aimeos\Controller\Frontend\Common\Decorator\Iface
{
	/**
	 * Adds a product to the basket of the customer stored in the session
	 *
	 * @param \Aimeos\MShop\Product\Item\Iface $product Product to add including texts, media, prices, attributes, etc.
	 * @param integer $quantity Amount of products that should by added
	 * @param array $variant List of variant-building attribute IDs that identify an article in a selection product
	 * @param array $config List of configurable attribute IDs the customer has chosen from
	 * @param array $custom Associative list of attribute IDs as keys and arbitrary values that will be added to the ordered product
	 * @param string $stocktype Unique code of the stock type to deliver the products from
	 * @param string|null $supplier Unique supplier code the product is from
	 * @param string|null $siteid Unique site ID the product is from or null for siteid of the product item
	 * @return \Aimeos\Controller\Frontend\Basket\Iface Basket frontend object for fluent interface
	 * @throws \Aimeos\Controller\Frontend\Basket\Exception If the product isn't available
	 */
	public function addProduct( \Aimeos\MShop\Product\Item\Iface $product, $quantity = 1,
		array $variant = [], array $config = [], array $custom = [], $stocktype = 'default', $supplier = null, $siteid = null )
	{
		if( $product->getType() !== 'select' )
		{
			$this->getController()->addProduct( $product, $quantity, $variant, $config, $custom, $stocktype, $supplier, $siteid );
			return $this;
		}

		$attr = [];
		$prodId = $product->getId();
		$prices = $product->getRefItems( 'price', 'default', 'default' );
		$hidden = $product->getRefItems( 'attribute', null, 'hidden' );

		$orderBaseProductItem = \Aimeos\MShop::create( $this->getContext(), 'order/base/product' )->createItem();
		$orderBaseProductItem = $orderBaseProductItem->copyFrom( $product );

		$product = $this->getArticle( $product, $variant );
		$orderBaseProductItem->setProductCode( $product->getCode() );

		$attributeMap = ['custom' => array_keys( $custom ), 'config' => array_keys( $config )];
		$this->checkListRef( [$prodId, $product->getId()], 'attribute', $attributeMap );

		if( ( $subprices = $product->getRefItems( 'price', 'default', 'default' ) ) !== [] ) {
			$prices = $subprices;
		}

		if( ( $mediaItems = $product->getRefItems( 'media', 'default', 'default' ) ) !== [] ) {
			$orderBaseProductItem->setMediaUrl( current( $mediaItems )->getPreview() );
		}

		$hidden += $product->getRefItems( 'attribute', null, 'hidden' );

		$orderProductAttrManager = \Aimeos\MShop::create( $this->getContext(), 'order/base/product/attribute' );
		$attributes = $product->getRefItems( 'attribute', null, 'variant' );

		foreach( $this->getAttributes( array_keys( $attributes ), ['text'] ) as $attrItem ) {
			$attr[] = $orderProductAttrManager->createItem()->copyFrom( $attrItem )->setType( 'variant' );
		}

		$custAttr = $this->getOrderProductAttributes( 'custom', array_keys( $custom ), $custom );
		$confAttr = $this->getOrderProductAttributes( 'config', array_keys( $config ), [], $config );
		$hideAttr = $this->getOrderProductAttributes( 'hidden', array_keys( $hidden ) );

		$orderBaseProductItem = $orderBaseProductItem->setQuantity( $quantity )
			->setAttributeItems( array_merge( $attr, $custAttr, $confAttr, $hideAttr ) )
			->setPrice( $this->calcPrice( $orderBaseProductItem, $prices, $quantity ) )
			->setStockType( $stocktype )->setSupplierCode( $supplier );

		if( $siteid ) {
			$orderBaseProductItem->setSiteId( $siteid );
		}

		$this->getController()->get()->addProduct( $orderBaseProductItem );
		$this->getController()->save();

		return $this;
	}


	/**
	 * Returns the variant attributes and updates the price list if necessary.
	 *
	 * @param \Aimeos\MShop\Product\Item\Iface $productItem Product item which is replaced if necessary
	 * @param array $variantAttributeIds List of product variant attribute IDs
	 * @return \Aimeos\MShop\Product\Item\Iface Product variant article
	 * @throws \Aimeos\Controller\Frontend\Basket\Exception If no product variant is found
	 */
	protected function getArticle( \Aimeos\MShop\Product\Item\Iface $productItem, array $variant )
	{
		$items = [];
		$context = $this->getContext();

		/** controller/frontend/basket/require-variant
		 * A variant of a selection product must be chosen
		 *
		 * Selection products normally consist of several article variants and
		 * by default exactly one article variant of a selection product can be
		 * put into the basket.
		 *
		 * By setting this option to false, the selection product including the
		 * chosen attributes (if any attribute values were selected) can be put
		 * into the basket as well. This makes it possible to get all articles
		 * or a subset of articles (e.g. all of a color) at once.
		 *
		 * This option replace the "client/html/basket/require-variant" setting.
		 *
		 * @param boolean True if a variant must be chosen, false if also the selection product with attributes can be added
		 * @since 2018.01
		 * @category Developer
		 * @category User
		 */
		$requireVariant = $context->getConfig()->get( 'controller/frontend/basket/require-variant', true );

		foreach( $productItem->getRefItems( 'product', 'default', 'default' ) as $item )
		{
			foreach( $variant as $id )
			{
				if( $item->getListItem( 'attribute', 'variant', $id ) === null ) {
					continue 2;
				}
			}

			$items[] = $item;
		}

		if( count( $items ) > 1 )
		{
			$msg = $context->getI18n()->dt( 'controller/frontend', 'No unique article found for selected attributes and product ID "%1$s"' );
			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( $msg, $productItem->getId() ) );
		}

		if( empty( $items ) && $requireVariant != false ) // count == 0
		{
			$msg = $context->getI18n()->dt( 'controller/frontend', 'No article found for selected attributes and product ID "%1$s"' );
			throw new \Aimeos\Controller\Frontend\Basket\Exception( sprintf( $msg, $productItem->getId() ) );
		}

		return current( $items ) ?: $productItem;
	}
}