Base::getSessionLock() - Code Metrics - Inspection of "Removed store() in favor of save() in order base m..." - aimeos/aimeos-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 7a5ddf...5d4f58 )

by Aimeos
created 2022-11-18 02:21 UTC
Base::getSessionLock() A

↳ Parent: Base
Complexity

Conditions	2
Paths	2
Size

Total Lines	15
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	2
eloc	10
nc	2
nop	1
dl	0
loc	15
rs	9.9332
c	0
b	0
f	0
<?php

/**
 * @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
 * @copyright Metaways Infosystems GmbH, 2011
 * @copyright Aimeos (aimeos.org), 2015-2022
 * @package MShop
 * @subpackage Order
 */


namespace Aimeos\MShop\Order\Manager\Base;


/**
 * Basic methods and constants for order base items (shopping basket).
 *
 * @package MShop
 * @subpackage Order
 */
abstract class Base
	extends \Aimeos\MShop\Common\Manager\Base
{
	/**
	 * Unlock basket.
	 * Disable the lock for the serialized basket in the session so
	 * modifications of the basket content are allowed again. Note that the
	 * locks are advisory locks that can't be enforced if code doesn't care
	 * about the lock.
	 */
	const LOCK_DISABLE = 0;

	/**
	 * Lock basket.
	 * Enable the lock for the serialized basket in the session so
	 * modifications of the basket content are not allowed any more. Note that
	 * the locks are advisory locks that can't be enforced if code doesn't care
	 * about the lock.
	 */
	const LOCK_ENABLE = 1;


	/**
	 * Returns a new and empty order base item (shopping basket).
	 *
	 * @param \Aimeos\MShop\Price\Item\Iface $price Default price of the basket (usually 0.00)
	 * @param \Aimeos\MShop\Locale\Item\Iface $locale Locale item containing the site, language and currency
	 * @param array $values Associative list of key/value pairs containing, e.g. the order or user ID
	 * @param \Aimeos\MShop\Order\Item\Base\Product\Iface[] $products List of ordered product items
	 * @param \Aimeos\MShop\Order\Item\Base\Address\Iface[] $addresses List of order address items
	 * @param \Aimeos\MShop\Order\Item\Base\Service\Iface[] $services List of order serviceitems
	 * @param \Aimeos\MShop\Order\Item\Base\Product\Iface[] $coupons Associative list of coupon codes as keys and items as values
	 * @param \Aimeos\MShop\Customer\Item\Iface|null $custItem Customer item object if requested
	 * @return \Aimeos\MShop\Order\Item\Base\Iface Order base object
	 */
	abstract protected function createItemBase( \Aimeos\MShop\Price\Item\Iface $price, \Aimeos\MShop\Locale\Item\Iface $locale,
		array $values = [], array $products = [], array $addresses = [], array $services = [], array $coupons = [],
		?\Aimeos\MShop\Customer\Item\Iface $custItem = null ) : \Aimeos\MShop\Order\Item\Base\Iface;


	/**
	 * Returns the current basket of the customer.
	 *
	 * @param string $type Basket type if a customer can have more than one basket
	 * @return \Aimeos\MShop\Order\Item\Base\Iface Shopping basket
	 */
	public function getSession( string $type = 'default' ) : \Aimeos\MShop\Order\Item\Base\Iface
	{
		$context = $this->context();
		$token = $context->token();
		$locale = $context->locale();
		$currency = $locale->getCurrencyId();
		$language = $locale->getLanguageId();
		$sitecode = $locale->getSiteItem()->getCode();

		$key = $token . '-' . $sitecode . '-' . $language . '-' . $currency . '-' . $type;

		try
		{
			if( ( $order = \Aimeos\MShop::create( $context, 'order/basket' )->get( $key )->getItem() ) === null ) {
				return $this->object()->create();
			}

			\Aimeos\MShop::create( $context, 'plugin' )->register( $order, 'order' );
		}
		catch( \Exception $e )
		{
			return $this->object()->create();
		}

		return $order;
	}


	/**
	 * Returns the current lock status of the basket.
	 *
	 * @param string $type Basket type if a customer can have more than one basket
	 * @return int Lock status (@see \Aimeos\MShop\Order\Manager\Base\Base)
	 */
	public function getSessionLock( string $type = 'default' ) : int
	{
		$context = $this->context();
		$session = $context->session();
		$locale = $context->locale();
		$currency = $locale->getCurrencyId();
		$language = $locale->getLanguageId();
		$sitecode = $locale->getSiteItem()->getCode();
		$key = 'aimeos/basket/lock-' . $sitecode . '-' . $language . '-' . $currency . '-' . strval( $type );

		if( ( $value = $session->get( $key ) ) !== null ) {
			return (int) $value;
		}

		return \Aimeos\MShop\Order\Manager\Base\Base::LOCK_DISABLE;
	}


	/**
	 * Saves the current shopping basket of the customer.
	 *
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $order Shopping basket
	 * @param string $type Order type if a customer can have more than one order at once
	 * @return \Aimeos\MShop\Order\Manager\Base\Iface Manager object for chaining method calls
	 */
	public function setSession( \Aimeos\MShop\Order\Item\Base\Iface $order, string $type = 'default' ) : \Aimeos\MShop\Order\Manager\Base\Iface
	{
		$context = $this->context();
		$token = $context->token();
		$locale = $context->locale();
		$currency = $locale->getCurrencyId();
		$language = $locale->getLanguageId();
		$sitecode = $locale->getSiteItem()->getCode();

		$key = $token . '-' . $sitecode . '-' . $language . '-' . $currency . '-' . strval( $type );

		$session = $context->session();

		$list = $session->get( 'aimeos/basket/list', [] );
		$list[$key] = $key;

		$session->set( 'aimeos/basket/list', $list );

		$manager = \Aimeos\MShop::create( $context, 'order/basket' );
		$manager->save( $manager->create()->setId( $key )->setCustomerId( $context->user() )->setItem( clone $order ) );

		return $this;
	}


	/**
	 * Locks or unlocks the session by setting the lock value.
	 * The lock is a cooperative lock and you have to check the lock value before you proceed.
	 *
	 * @param int $lock Lock value (@see \Aimeos\MShop\Order\Manager\Base\Base)
	 * @param string $type Order type if a customer can have more than one order at once
	 * @return \Aimeos\MShop\Order\Manager\Base\Iface Manager object for chaining method calls
	 */
	public function setSessionLock( int $lock, string $type = 'default' ) : \Aimeos\MShop\Order\Manager\Base\Iface
	{
		$this->checkLock( $lock );

		$context = $this->context();
		$session = $context->session();
		$locale = $context->locale();
		$currency = $locale->getCurrencyId();
		$language = $locale->getLanguageId();
		$sitecode = $locale->getSiteItem()->getCode();
		$key = 'aimeos/basket/lock-' . $sitecode . '-' . $language . '-' . $currency . '-' . strval( $type );

		$session->set( $key, strval( $lock ) );

		return $this;
	}


	/**
	 * Checks if the lock value is a valid constant.
	 *
	 * @param int $value Lock constant
	 * @return \Aimeos\MShop\Order\Manager\Base\Iface Manager object for chaining method calls
	 * @throws \Aimeos\MShop\Order\Exception If given value is invalid
	 */
	protected function checkLock( int $value ) : \Aimeos\MShop\Order\Manager\Base\Iface
	{
		switch( $value )
		{
			case \Aimeos\MShop\Order\Manager\Base\Base::LOCK_DISABLE:
			case \Aimeos\MShop\Order\Manager\Base\Base::LOCK_ENABLE:
				return $this;
		}

		$msg = $this->context()->translate( 'mshop', 'Lock flag "%1$d" not within allowed range' );
		throw new \Aimeos\MShop\Order\Exception( sprintf( $msg, $value ) );
	}


	/**
	 * Returns the address item map for the given order base IDs
	 *
	 * @param string[] $baseIds List of order base IDs
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @return array Multi-dimensional associative list of order base IDs as keys and order address type/item pairs as values
	 */
	protected function getAddresses( array $baseIds, bool $fresh = false ) : array
	{
		$items = [];
		$manager = $this->object()->getSubManager( 'address' );

		$criteria = $manager->filter()->slice( 0, 0x7fffffff );
		$criteria->setConditions( $criteria->compare( '==', 'order.base.address.baseid', $baseIds ) );

		foreach( $manager->search( $criteria ) as $item )
		{
			if( $fresh === true )
			{
				$item->setBaseId( null );
				$item->setId( null );
			}

			$items[$item->getBaseId()][] = $item;
		}

		return $items;
	}


	/**
	 * Returns the coupon map for the given order base IDs
	 *
	 * @param string[] $baseIds List of order base IDs
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @param array $products Associative list of base IDs and order product ID/item pairs as values
	 * @return array Multi-dimensional associative list of order base IDs as keys and coupons with product items as values
	 */
	protected function getCoupons( array $baseIds, bool $fresh = false, array $products = [] ) : array
	{
		$map = $productMap = [];
		$manager = $this->object()->getSubManager( 'coupon' );

		foreach( $products as $baseId => $list )
		{
			if( !isset( $productMap[$baseId] ) ) {
				$productMap[$baseId] = [];
			}

			foreach( $list as $key => $product )
			{
				$productMap[$baseId][$product->getId()] = $product;

				if( $fresh === true )
				{
					$product->setPosition( null );
					$product->setBaseId( null );
					$product->setId( null );
				}
			}
		}

		$criteria = $manager->filter()->slice( 0, 0x7fffffff );
		$criteria->setConditions( $criteria->compare( '==', 'order.base.coupon.baseid', $baseIds ) );

		foreach( $manager->search( $criteria ) as $item )
		{
			if( !isset( $map[$item->getBaseId()][$item->getCode()] ) ) {
				$map[$item->getBaseId()][$item->getCode()] = [];
			}

			if( $item->getProductId() !== null && isset( $productMap[$item->getBaseId()][$item->getProductId()] ) ) {
				$map[$item->getBaseId()][$item->getCode()][] = $productMap[$item->getBaseId()][$item->getProductId()];
			}
		}

		return $map;
	}


	/**
	 * Retrieves the ordered products from the storage.
	 *
	 * @param string[] $baseIds List of order base IDs
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @return array Multi-dimensional associative list of order base IDs as keys and order product
	 *	IDs/items pairs in reversed order as values
	 */
	protected function getProducts( array $baseIds, bool $fresh = false ) : array
	{
		$map = $attributes = $subProducts = [];
		$manager = $this->object()->getSubManager( 'product' );
		$attrManager = $manager->getSubManager( 'attribute' );

		$criteria = $manager->filter()->slice( 0, 0x7fffffff );
		$criteria->setConditions( $criteria->compare( '==', 'order.base.product.baseid', $baseIds ) );
		$items = $manager->search( $criteria )->reverse();

		$search = $attrManager->filter()->slice( 0, 0x7fffffff );
		$search->setConditions( $search->compare( '==', 'order.base.product.attribute.parentid', $items->keys()->toArray() ) );

		foreach( $attrManager->search( $search ) as $id => $attribute )
		{
			if( $fresh === true )
			{
				$attributes[$attribute->getParentId()][] = $attribute;
				$attribute->setParentId( null );
				$attribute->setId( null );
			}
			else
			{
				$attributes[$attribute->getParentId()][$id] = $attribute;
			}
		}

		foreach( $items as $id => $item )
		{
			if( isset( $attributes[$id] ) ) {
				$item->setAttributeItems( $attributes[$id] );
			}

			if( $item->getOrderProductId() === null )
			{
				ksort( $subProducts ); // bring the array into the right order because it's reversed
				$item->setProducts( $subProducts );
				$map[$item->getBaseId()][$item->getPosition()] = $item;

				$subProducts = [];
			}
			else
			{	// in case it's a sub-product
				$subProducts[$item->getPosition()] = $item;
			}

			if( $fresh === true )
			{
				$item->setPosition( null );
				$item->setBaseId( null );
				$item->setId( null );
			}
		}

		foreach( $map as $key => $list ) {
			ksort( $map[$key] );
		}

		return $map;
	}


	/**
	 * Retrieves the order services from the storage.
	 *
	 * @param string[] $baseIds List of order base IDs
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @return array Multi-dimensional associative list of order base IDs as keys and service type/items pairs as values
	 */
	protected function getServices( array $baseIds, bool $fresh = false ) : array
	{
		$map = [];
		$manager = $this->object()->getSubManager( 'service' );

		$criteria = $manager->filter()->slice( 0, 0x7fffffff );
		$criteria->setConditions( $criteria->compare( '==', 'order.base.service.baseid', $baseIds ) );

		foreach( $manager->search( $criteria ) as $item )
		{
			if( $fresh === true )
			{
				foreach( $item->getAttributeItems() as $attribute )
				{
						$attribute->setId( null );
						$attribute->setParentId( null );
				}

				$item->setBaseId( null );
				$item->setId( null );
			}

			$map[$item->getBaseId()][] = $item;
		}

		return $map;
	}


	/**
	 * Load the basket item for the given ID.
	 *
	 * @param string $id Unique order base ID
	 * @param \Aimeos\MShop\Price\Item\Iface $price Price object with total order value
	 * @param \Aimeos\MShop\Locale\Item\Iface $localeItem Locale object of the order
	 * @param array $row Array of values with all relevant order information
	 * @param array $ref Basket parts that should be loaded too
	 * @return \Aimeos\MShop\Order\Item\Base\Iface The loaded order item for the given ID
	 */
	protected function loadItems( string $id, \Aimeos\MShop\Price\Item\Iface $price,
		\Aimeos\MShop\Locale\Item\Iface $localeItem, array $row, array $ref )
	{
		$products = $coupons = $addresses = $services = [];

		if( in_array( 'order/base/product', $ref ) || in_array( 'order/base/coupon', $ref ) ) {
			$products = $this->loadProducts( $id, false );
		}

		if( in_array( 'order/base/coupon', $ref ) ) {
			$coupons = $this->loadCoupons( $id, false, $products );
		}

		if( in_array( 'order/base/address', $ref ) ) {
			$addresses = $this->loadAddresses( $id, false );
		}

		if( in_array( 'order/base/service', $ref ) ) {
			$services = $this->loadServices( $id, false );
		}

		$basket = $this->createItemBase( $price, $localeItem, $row, $products, $addresses, $services, $coupons );

		\Aimeos\MShop::create( $this->context(), 'plugin' )->register( $basket, 'order' );

		return $basket;
	}


	/**
	 * Create a new basket item as a clone from an existing order ID.
	 *
	 * @param string $id Unique order base ID
	 * @param \Aimeos\MShop\Price\Item\Iface $price Price object with total order value
	 * @param \Aimeos\MShop\Locale\Item\Iface $localeItem Locale object of the order
	 * @param array $row Array of values with all relevant order information
	 * @param array $ref Basket parts that should be loaded
	 * @return \Aimeos\MShop\Order\Item\Base\Standard The loaded order item for the given ID
	 */
	protected function loadFresh( string $id, \Aimeos\MShop\Price\Item\Iface $price,
		\Aimeos\MShop\Locale\Item\Iface $localeItem, array $row, array $ref )
	{
		$products = $coupons = $addresses = $services = [];

		if( in_array( 'order/base/product', $ref ) ) {
			$products = $this->loadProducts( $id, true );
		}

		if( in_array( 'order/base/coupon', $ref ) ) {
			// load coupons with product array containing product ids for coupon/product matching
			// not very efficient, a better solution might be considered for 2020.01 release
			// see https://github.com/aimeos/aimeos-core/pull/175 for discussion
			$coupons = $this->loadCoupons( $id, true, $this->loadProducts( $id, false ) );
		}

		if( in_array( 'order/base/address', $ref ) ) {
			$addresses = $this->loadAddresses( $id, true );
		}

		if( in_array( 'order/base/service', $ref ) ) {
			$services = $this->loadServices( $id, true );
		}

		$basket = $this->createItemBase( $price, $localeItem, $row );
		$basket->setId( null );

		\Aimeos\MShop::create( $this->context(), 'plugin' )->register( $basket, 'order' );

		foreach( $services as $item ) {
			$basket->addService( $item, $item->getType() );
		}

		foreach( $addresses as $item ) {
			$basket->addAddress( $item, $item->getType() );
		}

		foreach( $products as $item )
		{
			if( !( $item->getFlags() & \Aimeos\MShop\Order\Item\Base\Product\Base::FLAG_IMMUTABLE ) ) {
				$basket->addProduct( $item );
			}
		}

		foreach( $coupons as $code => $items ) {
			$basket->addCoupon( $code );
		}

		return $basket;
	}


	/**
	 * Retrieves the addresses of the order from the storage.
	 *
	 * @param string $id Order base ID
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @return \Aimeos\MShop\Order\Item\Base\Address\Iface[] List of order address items
	 */
	protected function loadAddresses( string $id, bool $fresh ) : array
	{
		$map = $this->getAddresses( [$id], $fresh );

		if( ( $items = reset( $map ) ) !== false ) {
			return $items;
		}

		return [];
	}


	/**
	 * Retrieves the coupons of the order from the storage.
	 *
	 * @param string $id Order base ID
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @param array $products Multi-dimensional associative list of order base IDs as keys and order product
	 *	IDs/items pairs in reversed order as values
	 * @return \Aimeos\MShop\Order\Item\Base\Product\Iface[] Associative list of coupon codes as keys and items as values
	 */
	protected function loadCoupons( string $id, bool $fresh, array $products ) : array
	{
		$map = $this->getCoupons( [$id], $fresh, [$id => $products] );

		if( ( $items = reset( $map ) ) !== false ) {
			return $items;
		}

		return [];
	}


	/**
	 * Retrieves the ordered products from the storage.
	 *
	 * @param string $id Order base ID
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @return \Aimeos\MShop\Order\Item\Base\Product\Iface[] List of product items
	 */
	protected function loadProducts( string $id, bool $fresh ) : array
	{
		$items = current( $this->getProducts( [$id], $fresh ) );
		return $items ?: [];
	}


	/**
	 * Retrieves the services of the order from the storage.
	 *
	 * @param string $id Order base ID
	 * @param bool $fresh Create new items by copying the existing ones and remove their IDs
	 * @return \Aimeos\MShop\Order\Item\Base\Service\Iface[] List of order service items
	 */
	protected function loadServices( string $id, bool $fresh ) : array
	{
		$map = $this->getServices( [$id], $fresh );

		if( ( $items = reset( $map ) ) !== false ) {
			return $items;
		}

		return [];
	}


	/**
	 * Saves the addresses of the order to the storage.
	 *
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket containing address items
	 * @return \Aimeos\MShop\Order\Manager\Base\Iface Manager object for chaining method calls
	 */
	protected function saveAddresses( \Aimeos\MShop\Order\Item\Base\Iface $basket ) : \Aimeos\MShop\Order\Manager\Base\Iface
	{
		$addresses = $basket->getAddresses()->flat( 1 );

		foreach( $addresses as $address )
		{
			if( $address->getBaseId() != $basket->getId() ) {
				$address->setId( null ); // create new item if copied
			}

			$address->setBaseId( $basket->getId() );
		}

		$this->object()->getSubManager( 'address' )->save( $addresses );

		return $this;
	}


	/**
	 * Saves the coupons of the order to the storage.
	 *
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket containing coupon items
	 * @return \Aimeos\MShop\Order\Manager\Base\Iface Manager object for chaining method calls
	 */
	protected function saveCoupons( \Aimeos\MShop\Order\Item\Base\Iface $basket ) : \Aimeos\MShop\Order\Manager\Base\Iface
	{
		$baseId = $basket->getId();
		$manager = $this->object()->getSubManager( 'coupon' );
		$filter = $manager->filter()->add( 'order.base.coupon.baseid', '==', $basket->getId() )->slice( 0, 0x7fffffff );
		$items = $manager->search( $filter )->groupBy( 'order.base.coupon.code' );

		foreach( $basket->getCoupons() as $code => $products )
		{
			if( empty( $products ) )
			{
				$item = !empty( $items[$code] ) ? current( $items[$code] ) : $manager->create()->setBaseId( $baseId );
				$item = !empty( $items[$code] ) ? current( /** @scrutinizer ignore-type */ $items[$code] ) : $manager->create()->setBaseId( $baseId );
				$manager->save( $item->setCode( $code ) );
				continue;
			}

			foreach( $products as $product )
			{
				foreach( $items[$code] ?? [] as $prodItem )
				{
					if( $product->getId() === $prodItem->getId() ) {
						continue 2;
					}
				}

				$manager->save( $manager->create()->setBaseId( $baseId )->setCode( $code )->setProductId( $product->getId() ) );
			}
		}

		return $this;
	}


	/**
	 * Saves the ordered products to the storage.
	 *
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket containing ordered products or bundles
	 * @return \Aimeos\MShop\Order\Manager\Base\Iface Manager object for chaining method calls
	 */
	protected function saveProducts( \Aimeos\MShop\Order\Item\Base\Iface $basket ) : \Aimeos\MShop\Order\Manager\Base\Iface
	{
		$products = $basket->getProducts();
		$pos = $products->merge( $products->getProducts()->flat( 1 ) )->max( 'order.base.product.position' );

		foreach( $products as $product )
		{
			if( $product->getBaseId() != $basket->getId() ) {
				$product->setId( null ); // create new item if copied
			}

			if( !$product->getPosition() ) {
				$product->setPosition( ++$pos );
			}

			$product->setBaseId( $basket->getId() );

			foreach( $product->getProducts() as $subProduct )
			{
				if( $subProduct->getBaseId() != $basket->getId() ) {
					$subProduct->setId( null ); // create new item if copied
				}

				if( !$subProduct->getPosition() ) {
					$subProduct->setPosition( ++$pos );
				}

				$subProduct->setBaseId( $basket->getId() );
			}
		}

		$this->object()->getSubManager( 'product' )->save( $products );

		return $this;
	}


	/**
	 * Saves the services of the order to the storage.
	 *
	 * @param \Aimeos\MShop\Order\Item\Base\Iface $basket Basket containing service items
	 * @return \Aimeos\MShop\Order\Manager\Base\Iface Manager object for chaining method calls
	 */
	protected function saveServices( \Aimeos\MShop\Order\Item\Base\Iface $basket ) : \Aimeos\MShop\Order\Manager\Base\Iface
	{
		$services = $basket->getServices()->flat( 1 );

		foreach( $services as $service )
		{
			if( $service->getBaseId() != $basket->getId() ) {
				$service->setId( null ); // create new item if copied
			}

			$service->setBaseId( $basket->getId() );
		}

		$this->object()->getSubManager( 'service' )->save( $services );

		return $this;
	}
}

aimeos / aimeos-core

Push — master ( 7a5ddf...5d4f58 )

Base::getSessionLock() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
