Standard::__construct() - Code Metrics - Inspection of "Use same site mode in all index submanagers" - aimeos/aimeos-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 7f3a33...b24c92 )

by Aimeos
created 2017-10-30 12:03 UTC
Standard::__construct() B

↳ Parent: Standard
Complexity

Conditions	3
Paths	4
Size

Total Lines	24
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	15
nc	4
nop	1
dl	0
loc	24
rs	8.9713
c	0
b	0
f	0
<?php
/**
 * @license LGPLv3, http://opensource.org/licenses/LGPL-3.0
 * @copyright Metaways Infosystems GmbH, 2012
 * @copyright Aimeos (aimeos.org), 2015-2017
 * @package MShop
 * @subpackage Index
 */


namespace Aimeos\MShop\Index\Manager\Price;


/**
 * Submanager for product prices.
 *
 * @package MShop
 * @subpackage Index
 */
class Standard
	extends \Aimeos\MShop\Index\Manager\DBBase

	implements \Aimeos\MShop\Index\Manager\Price\Iface
{
	private $searchConfig = array(
		'index.price.id' => array(
			'code' => 'index.price.id',
			'internalcode' => 'mindpr."priceid"',
			'internaldeps'=>array( 'LEFT JOIN "mshop_index_price" AS mindpr ON mindpr."prodid" = mpro."id"' ),
			'label' => 'Product index price ID',
			'type' => 'integer',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_INT,
			'public' => false,
		),
		'index.price.quantity' => array(
			'code' => 'index.price.quantity',
			'internalcode' => 'mindpr."quantity"',
			'label' => 'Product price quantity',
			'type' => 'integer',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_INT,
			'public' => false,
		),
		'index.price.value' => array(
			'code' => 'index.price.value()',
			'internalcode' => ':site AND mindpr."listtype" = $1 AND mindpr."currencyid" = $2 AND mindpr."type" = $3 AND mindpr."value"',
			'label' => 'Product price value, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'decimal',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
		'sort:index.price.value' => array(
			'code' => 'sort:index.price.value()',
			'internalcode' => 'mindpr."value"',
			'label' => 'Sort product price value, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'string',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
		'index.price.costs' => array(
			'code' => 'index.price.costs()',
			'internalcode' => ':site AND mindpr."listtype" = $1 AND mindpr."currencyid" = $2 AND mindpr."type" = $3 AND mindpr."costs"',
			'label' => 'Product (shipping) costs, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'decimal',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
		'sort:index.price.costs' => array(
			'code' => 'sort:index.price.costs()',
			'internalcode' => 'mindpr."costs"',
			'label' => 'Sort product (shipping) costs, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'string',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
		'index.price.rebate' => array(
			'code' => 'index.price.rebate()',
			'internalcode' => ':site AND mindpr."listtype" = $1 AND mindpr."currencyid" = $2 AND mindpr."type" = $3 AND mindpr."rebate"',
			'label' => 'Product price rebate, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'decimal',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
		'sort:index.price.rebate' => array(
			'code' => 'sort:index.price.rebate()',
			'internalcode' => 'mindpr."rebate"',
			'label' => 'Sort product price rebate, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'string',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
		'index.price.taxrate' => array(
			'code' => 'index.price.taxrate()',
			'internalcode' => ':site AND mindpr."listtype" = $1 AND mindpr."currencyid" = $2 AND mindpr."type" = $3 AND mindpr."taxrate"',
			'label' => 'Product price taxrate, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'decimal',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
		'sort:index.price.taxrate' => array(
			'code' => 'sort:index.price.taxrate()',
			'internalcode' => 'mindpr."taxrate"',
			'label' => 'Sort product price taxrate, parameter(<list type code>,<currency ID>,<price type code>)',
			'type' => 'string',
			'internaltype' => \Aimeos\MW\DB\Statement\Base::PARAM_STR,
			'public' => false,
		),
	);

	private $subManagers;


	/**
	 * Initializes the manager instance.
	 *
	 * @param \Aimeos\MShop\Context\Item\Iface $context Context object
	 */
	public function __construct( \Aimeos\MShop\Context\Item\Iface $context )
	{
		parent::__construct( $context );

		$locale = $context->getLocale();
		$level = \Aimeos\MShop\Locale\Manager\Base::SITE_ALL;
		$level = $context->getConfig()->get( 'mshop/index/manager/sitemode', $level );

		$siteIds = [$locale->getSiteId()];

		if( $level & \Aimeos\MShop\Locale\Manager\Base::SITE_PATH ) {
			$siteIds = array_merge( $siteIds, $locale->getSitePath() );
		}

		if( $level & \Aimeos\MShop\Locale\Manager\Base::SITE_SUBTREE ) {
			$siteIds = array_merge( $siteIds, $locale->getSiteSubTree() );
		}

		$this->replaceSiteMarker( $this->searchConfig['index.price.quantity'], 'mindpr."siteid"', $siteIds );
		$this->replaceSiteMarker( $this->searchConfig['index.price.value'], 'mindpr."siteid"', $siteIds );
		$this->replaceSiteMarker( $this->searchConfig['index.price.costs'], 'mindpr."siteid"', $siteIds );
		$this->replaceSiteMarker( $this->searchConfig['index.price.rebate'], 'mindpr."siteid"', $siteIds );
		$this->replaceSiteMarker( $this->searchConfig['index.price.taxrate'], 'mindpr."siteid"', $siteIds );
	}


	/**
	 * Counts the number products that are available for the values of the given key.
	 *
	 * @param \Aimeos\MW\Criteria\Iface $search Search criteria
	 * @param string $key Search key (usually the ID) to aggregate products for
	 * @return array List of ID values as key and the number of counted products as value
	 */
	public function aggregate( \Aimeos\MW\Criteria\Iface $search, $key )
	{
		return $this->aggregateBase( $search, $key, 'mshop/index/manager/standard/aggregate' );
	}


	/**
	 * Removes old entries from the storage.
	 *
	 * @param integer[] $siteids List of IDs for sites whose entries should be deleted
	 */
	public function cleanup( array $siteids )
	{
		parent::cleanup( $siteids );

		$this->cleanupBase( $siteids, 'mshop/index/manager/price/standard/delete' );
	}


	/**
	 * Removes all entries not touched after the given timestamp in the index.
	 * This can be a long lasting operation.
	 *
	 * @param string $timestamp Timestamp in ISO format (YYYY-MM-DD HH:mm:ss)
	 */
	public function cleanupIndex( $timestamp )
	{
		/** mshop/index/manager/price/standard/cleanup/mysql
		 * Deletes the index price records that haven't been touched
		 *
		 * @see mshop/index/manager/price/standard/cleanup/ansi
		 */

		/** mshop/index/manager/price/standard/cleanup/ansi
		 * Deletes the index price records that haven't been touched
		 *
		 * During the rebuild process of the product index, the entries of all
		 * active products will be removed and readded. Thus, no stale data for
		 * these products will remain in the database.
		 *
		 * All products that have been disabled since the last rebuild will be
		 * still part of the index. The cleanup statement removes all records
		 * that belong to products that haven't been touched during the index
		 * rebuild because these are the disabled ones.
		 *
		 * The SQL statement should conform to the ANSI standard to be
		 * compatible with most relational database systems. This also
		 * includes using double quotes for table and column names.
		 *
		 * @param string SQL statement for deleting the outdated price index records
		 * @since 2014.03
		 * @category Developer
		 * @see mshop/index/manager/price/standard/count/ansi
		 * @see mshop/index/manager/price/standard/delete/ansi
		 * @see mshop/index/manager/price/standard/insert/ansi
		 * @see mshop/index/manager/price/standard/search/ansi
		 */
		$this->cleanupIndexBase( $timestamp, 'mshop/index/manager/price/standard/cleanup' );
	}


	/**
	 * Removes multiple items from the index.
	 *
	 * @param array $ids list of Product IDs
	 */
	public function deleteItems( array $ids )
	{
		/** mshop/index/manager/price/standard/delete/mysql
		 * Deletes the items matched by the given IDs from the database
		 *
		 * @see mshop/index/manager/price/standard/delete/ansi
		 */

		/** mshop/index/manager/price/standard/delete/ansi
		 * Deletes the items matched by the given IDs from the database
		 *
		 * Removes the records specified by the given IDs from the index database.
		 * The records must be from the site that is configured via the
		 * context item.
		 *
		 * The ":cond" placeholder is replaced by the name of the ID column and
		 * the given ID or list of IDs while the site ID is bound to the question
		 * mark.
		 *
		 * The SQL statement should conform to the ANSI standard to be
		 * compatible with most relational database systems. This also
		 * includes using double quotes for table and column names.
		 *
		 * @param string SQL statement for deleting index price records
		 * @since 2014.03
		 * @category Developer
		 * @see mshop/index/manager/price/standard/count/ansi
		 * @see mshop/index/manager/price/standard/cleanup/ansi
		 * @see mshop/index/manager/price/standard/insert/ansi
		 * @see mshop/index/manager/price/standard/search/ansi
		 */
		$this->deleteItemsBase( $ids, 'mshop/index/manager/price/standard/delete' );
	}


	/**
	 * Returns the available manager types
	 *
	 * @param boolean $withsub Return also the resource type of sub-managers if true
	 * @return array Type of the manager and submanagers, subtypes are separated by slashes
	 */
	public function getResourceType( $withsub = true )
	{
		$path = 'mshop/index/manager/price/submanagers';

		return $this->getResourceTypeBase( 'index/price', $path, [], $withsub );
	}


	/**
	 * Returns a list of objects describing the available criterias for searching.
	 *
	 * @param boolean $withsub Return also attributes of sub-managers if true
	 * @return array List of items implementing \Aimeos\MW\Criteria\Attribute\Iface
	 */
	public function getSearchAttributes( $withsub = true )
	{
		$list = parent::getSearchAttributes( $withsub );

		/** mshop/index/manager/price/submanagers
		 * List of manager names that can be instantiated by the index price manager
		 *
		 * Managers provide a generic interface to the underlying storage.
		 * Each manager has or can have sub-managers caring about particular
		 * aspects. Each of these sub-managers can be instantiated by its
		 * parent manager using the getSubManager() method.
		 *
		 * The search keys from sub-managers can be normally used in the
		 * manager as well. It allows you to search for items of the manager
		 * using the search keys of the sub-managers to further limit the
		 * retrieved list of items.
		 *
		 * @param array List of sub-manager names
		 * @since 2014.03
		 * @category Developer
		 */
		$path = 'mshop/index/manager/price/submanagers';

		$list += $this->getSearchAttributesBase( $this->searchConfig, $path, [], $withsub );

		return $list;
	}


	/**
	 * Returns a new manager for product extensions.
	 *
	 * @param string $manager Name of the sub manager type in lower case
	 * @param string|null $name Name of the implementation, will be from configuration (or Default) if null
	 * @return \Aimeos\MShop\Common\Manager\Iface Manager for different extensions, e.g stock, tags, locations, etc.
	 */
	public function getSubManager( $manager, $name = null )
	{
		/** mshop/index/manager/price/name
		 * Class name of the used index price manager implementation
		 *
		 * Each default index price manager can be replaced by an alternative imlementation.
		 * To use this implementation, you have to set the last part of the class
		 * name as configuration value so the manager factory knows which class it
		 * has to instantiate.
		 *
		 * For example, if the name of the default class is
		 *
		 *  \Aimeos\MShop\Index\Manager\Price\Standard
		 *
		 * and you want to replace it with your own version named
		 *
		 *  \Aimeos\MShop\Index\Manager\Price\Myprice
		 *
		 * then you have to set the this configuration option:
		 *
		 *  mshop/index/manager/price/name = Myprice
		 *
		 * The value is the last part of your own class name and it's case sensitive,
		 * so take care that the configuration value is exactly named like the last
		 * part of the class name.
		 *
		 * The allowed characters of the class name are A-Z, a-z and 0-9. No other
		 * characters are possible! You should always start the last part of the class
		 * name with an upper case character and continue only with lower case characters
		 * or numbers. Avoid chamel case names like "MyPrice"!
		 *
		 * @param string Last part of the class name
		 * @since 2014.03
		 * @category Developer
		 */

		/** mshop/index/manager/price/decorators/excludes
		 * Excludes decorators added by the "common" option from the index price manager
		 *
		 * 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 remove a decorator added via
		 * "mshop/common/manager/decorators/default" before they are wrapped
		 * around the index price manager.
		 *
		 *  mshop/index/manager/price/decorators/excludes = array( 'decorator1' )
		 *
		 * This would remove the decorator named "decorator1" from the list of
		 * common decorators ("\Aimeos\MShop\Common\Manager\Decorator\*") added via
		 * "mshop/common/manager/decorators/default" for the index price manager.
		 *
		 * @param array List of decorator names
		 * @since 2014.03
		 * @category Developer
		 * @see mshop/common/manager/decorators/default
		 * @see mshop/index/manager/price/decorators/global
		 * @see mshop/index/manager/price/decorators/local
		 */

		/** mshop/index/manager/price/decorators/global
		 * Adds a list of globally available decorators only to the index price manager
		 *
		 * 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 wrap global decorators
		 * ("\Aimeos\MShop\Common\Manager\Decorator\*") around the index price manager.
		 *
		 *  mshop/index/manager/price/decorators/global = array( 'decorator1' )
		 *
		 * This would add the decorator named "decorator1" defined by
		 * "\Aimeos\MShop\Common\Manager\Decorator\Decorator1" only to the catalog controller.
		 *
		 * @param array List of decorator names
		 * @since 2014.03
		 * @category Developer
		 * @see mshop/common/manager/decorators/default
		 * @see mshop/index/manager/price/decorators/excludes
		 * @see mshop/index/manager/price/decorators/local
		 */

		/** mshop/index/manager/price/decorators/local
		 * Adds a list of local decorators only to the index price manager
		 *
		 * 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 wrap local decorators
		 * ("\Aimeos\MShop\Common\Manager\Decorator\*") around the index price manager.
		 *
		 *  mshop/index/manager/price/decorators/local = array( 'decorator2' )
		 *
		 * This would add the decorator named "decorator2" defined by
		 * "\Aimeos\MShop\Common\Manager\Decorator\Decorator2" only to the catalog
		 * controller.
		 *
		 * @param array List of decorator names
		 * @since 2014.03
		 * @category Developer
		 * @see mshop/common/manager/decorators/default
		 * @see mshop/index/manager/price/decorators/excludes
		 * @see mshop/index/manager/price/decorators/global
		 */

		return $this->getSubManagerBase( 'index', 'price/' . $manager, $name );
	}


	/**
	 * Optimizes the index if necessary.
	 * Execution of this operation can take a very long time and shouldn't be
	 * called through a web server enviroment.
	 */
	public function optimize()
	{
		/** mshop/index/manager/price/standard/optimize/mysql
		 * Optimizes the stored price data for retrieving the records faster
		 *
		 * @see mshop/index/manager/price/standard/optimize/ansi
		 */

		/** mshop/index/manager/price/standard/optimize/ansi
		 * Optimizes the stored price data for retrieving the records faster
		 *
		 * The SQL statement should reorganize the data in the DBMS storage to
		 * optimize access to the records of the table or tables. Some DBMS
		 * offer specialized statements to optimize indexes and records. This
		 * statement doesn't return any records.
		 *
		 * The SQL statement should conform to the ANSI standard to be
		 * compatible with most relational database systems. This also
		 * includes using double quotes for table and column names.
		 *
		 * @param string SQL statement for optimizing the stored price data
		 * @since 2014.09
		 * @category Developer
		 * @see mshop/index/manager/price/standard/count/ansi
		 * @see mshop/index/manager/price/standard/search/ansi
		 * @see mshop/index/manager/price/standard/aggregate/ansi
		 */
		$this->optimizeBase( 'mshop/index/manager/price/standard/optimize' );
	}


	/**
	 * Rebuilds the index price for searching products or specified list of products.
	 * This can be a long lasting operation.
	 *
	 * @param \Aimeos\MShop\Common\Item\Iface[] $items Associative list of product IDs and items implementing \Aimeos\MShop\Product\Item\Iface
	 */
	public function rebuildIndex( array $items = [] )
	{
		if( empty( $items ) ) { return; }

		\Aimeos\MW\Common\Base::checkClassList( '\\Aimeos\\MShop\\Product\\Item\\Iface', $items );

		$context = $this->getContext();
		$dbm = $context->getDatabaseManager();
		$dbname = $this->getResourceName();
		$conn = $dbm->acquire( $dbname );

		try
		{
			/** mshop/index/manager/price/standard/insert/mysql
			 * Inserts a new price record into the product index database
			 *
			 * @see mshop/index/manager/price/standard/insert/ansi
			 */

			/** mshop/index/manager/price/standard/insert/ansi
			 * Inserts a new price record into the product index database
			 *
			 * During the product index rebuild, prices related to a product
			 * will be stored in the index for this product. All records
			 * are deleted before the new ones are inserted.
			 *
			 * The SQL statement must be a string suitable for being used as
			 * prepared statement. It must include question marks for binding
			 * the values from the order item to the statement before they are
			 * sent to the database server. The number of question marks must
			 * be the same as the number of columns listed in the INSERT
			 * statement. The order of the columns must correspond to the
			 * order in the rebuildIndex() method, so the correct values are
			 * bound to the columns.
			 *
			 * The SQL statement should conform to the ANSI standard to be
			 * compatible with most relational database systems. This also
			 * includes using double quotes for table and column names.
			 *
			 * @param string SQL statement for inserting records
			 * @since 2014.03
			 * @category Developer
			 * @see mshop/index/manager/price/standard/cleanup/ansi
			 * @see mshop/index/manager/price/standard/delete/ansi
			 * @see mshop/index/manager/price/standard/search/ansi
			 * @see mshop/index/manager/price/standard/count/ansi
			 */
			$stmt = $this->getCachedStatement( $conn, 'mshop/index/manager/price/standard/insert' );

			foreach( $items as $item )
			{
				$listTypes = [];
				foreach( $item->getListItems( 'price' ) as $listItem ) {
					$listTypes[$listItem->getRefId()][] = $listItem->getType();
				}

				$this->savePrices( $stmt, $item, $listTypes );
			}

			$dbm->release( $conn, $dbname );
		}
		catch( \Exception $e )
		{
			$dbm->release( $conn, $dbname );
			throw $e;
		}


		foreach( $this->getSubManagers() as $submanager ) {
			$submanager->rebuildIndex( $items );
		}
	}


	/**
	 * Searches for items matching the given criteria.
	 *
	 * @param \Aimeos\MW\Criteria\Iface $search Search criteria object
	 * @param string[] $ref List of domains to fetch list items and referenced items for
	 * @param integer|null &$total Number of items that are available in total
	 * @return array List of items implementing \Aimeos\MShop\Product\Item\Iface with ids as keys
	 */
	public function searchItems( \Aimeos\MW\Criteria\Iface $search, array $ref = [], &$total = null )
	{
		/** mshop/index/manager/price/standard/search/mysql
		 * Retrieves the records matched by the given criteria in the database
		 *
		 * @see mshop/index/manager/price/standard/search/ansi
		 */

		/** mshop/index/manager/price/standard/search/ansi
		 * Retrieves the records matched by the given criteria in the database
		 *
		 * Fetches the records matched by the given criteria from the product index
		 * database. The records must be from one of the sites that are
		 * configured via the context item. If the current site is part of
		 * a tree of sites, the SELECT statement can retrieve all records
		 * from the current site and the complete sub-tree of sites.
		 *
		 * As the records can normally be limited by criteria from sub-managers,
		 * their tables must be joined in the SQL context. This is done by
		 * using the "internaldeps" property from the definition of the ID
		 * column of the sub-managers. These internal dependencies specify
		 * the JOIN between the tables and the used columns for joining. The
		 * ":joins" placeholder is then replaced by the JOIN strings from
		 * the sub-managers.
		 *
		 * To limit the records matched, conditions can be added to the given
		 * criteria object. It can contain comparisons like column names that
		 * must match specific values which can be combined by AND, OR or NOT
		 * operators. The resulting string of SQL conditions replaces the
		 * ":cond" placeholder before the statement is sent to the database
		 * server.
		 *
		 * If the records that are retrieved should be ordered by one or more
		 * columns, the generated string of column / sort direction pairs
		 * replaces the ":order" placeholder. In case no ordering is required,
		 * the complete ORDER BY part including the "\/*-orderby*\/...\/*orderby-*\/"
		 * markers is removed to speed up retrieving the records. Columns of
		 * sub-managers can also be used for ordering the result set but then
		 * no index can be used.
		 *
		 * The number of returned records can be limited and can start at any
		 * number between the begining and the end of the result set. For that
		 * the ":size" and ":start" placeholders are replaced by the
		 * corresponding values from the criteria object. The default values
		 * are 0 for the start and 100 for the size value.
		 *
		 * The SQL statement should conform to the ANSI standard to be
		 * compatible with most relational database systems. This also
		 * includes using double quotes for table and column names.
		 *
		 * @param string SQL statement for searching items
		 * @since 2014.03
		 * @category Developer
		 * @see mshop/index/manager/price/standard/count/ansi
		 * @see mshop/index/manager/price/standard/optimize/ansi
		 * @see mshop/index/manager/price/standard/aggregate/ansi
		 */
		$cfgPathSearch = 'mshop/index/manager/price/standard/search';

		/** mshop/index/manager/price/standard/count/mysql
		 * Counts the number of records matched by the given criteria in the database
		 *
		 * @see mshop/index/manager/price/standard/count/ansi
		 */

		/** mshop/index/manager/price/standard/count/ansi
		 * Counts the number of records matched by the given criteria in the database
		 *
		 * Counts all records matched by the given criteria from the product index
		 * database. The records must be from one of the sites that are
		 * configured via the context item. If the current site is part of
		 * a tree of sites, the statement can count all records from the
		 * current site and the complete sub-tree of sites.
		 *
		 * As the records can normally be limited by criteria from sub-managers,
		 * their tables must be joined in the SQL context. This is done by
		 * using the "internaldeps" property from the definition of the ID
		 * column of the sub-managers. These internal dependencies specify
		 * the JOIN between the tables and the used columns for joining. The
		 * ":joins" placeholder is then replaced by the JOIN strings from
		 * the sub-managers.
		 *
		 * To limit the records matched, conditions can be added to the given
		 * criteria object. It can contain comparisons like column names that
		 * must match specific values which can be combined by AND, OR or NOT
		 * operators. The resulting string of SQL conditions replaces the
		 * ":cond" placeholder before the statement is sent to the database
		 * server.
		 *
		 * Both, the strings for ":joins" and for ":cond" are the same as for
		 * the "search" SQL statement.
		 *
		 * Contrary to the "search" statement, it doesn't return any records
		 * but instead the number of records that have been found. As counting
		 * thousands of records can be a long running task, the maximum number
		 * of counted records is limited for performance reasons.
		 *
		 * The SQL statement should conform to the ANSI standard to be
		 * compatible with most relational database systems. This also
		 * includes using double quotes for table and column names.
		 *
		 * @param string SQL statement for counting items
		 * @since 2014.03
		 * @category Developer
		 * @see mshop/index/manager/price/standard/search/ansi
		 * @see mshop/index/manager/price/standard/optimize/ansi
		 * @see mshop/index/manager/price/standard/aggregate/ansi
		 */
		$cfgPathCount = 'mshop/index/manager/price/standard/count';

		return $this->searchItemsIndexBase( $search, $ref, $total, $cfgPathSearch, $cfgPathCount );
	}


	/**
	 * Returns the list of sub-managers available for the index attribute manager.
	 *
	 * @return array Associative list of the sub-domain as key and the manager object as value
	 */
	protected function getSubManagers()
	{
		if( $this->subManagers === null )
		{
			$this->subManagers = [];

			/** mshop/index/manager/price/submanagers
			 * A list of sub-manager names used for indexing associated items to prices
			 *
			 * All items referenced by a product (e.g. texts, prices, media,
			 * etc.) are added to the product index via specialized index
			 * managers. You can add the name of new sub-managers to add more
			 * data to the index or remove existing ones if you don't want to
			 * index that data at all.
			 *
			 * This option configures the sub-managers that cares about
			 * indexing data associated to product prices.
			 *
			 * @param string List of index sub-manager names
			 * @since 2014.09
			 * @category User
			 * @category Developer
			 * @see mshop/index/manager/standard/submanagers
			 */
			$path = 'mshop/index/manager/price/submanagers';

			foreach( $this->getContext()->getConfig()->get( $path, [] ) as $domain ) {
				$this->subManagers[$domain] = $this->getObject()->getSubManager( $domain );
			}

			return $this->subManagers;
		}

		return $this->subManagers;
	}


	/**
	 * Saves the text items referenced indirectly by products
	 *
	 * @param \Aimeos\MW\DB\Statement\Iface $stmt Prepared SQL statement with place holders
	 * @param \Aimeos\MShop\Common\Item\ListRef\Iface $item Item containing associated text items
	 * @param array $listTypes Associative list of item ID / list type code pairs
	 * @throws \Aimeos\MShop\Index\Exception If no list type for the item is available
	 */
	protected function savePrices( \Aimeos\MW\DB\Statement\Iface $stmt, \Aimeos\MShop\Common\Item\ListRef\Iface $item, array $listTypes )
	{
		$context = $this->getContext();
		$siteid = $context->getLocale()->getSiteId();
		$editor = $context->getEditor();
		$date = date( 'Y-m-d H:i:s' );

		foreach( $item->getRefItems( 'price' ) as $refId => $refItem )
		{
			if( !isset( $listTypes[$refId] ) )
			{
				$msg = sprintf( 'List type for price item with ID "%1$s" not available', $refId );
				throw new \Aimeos\MShop\Index\Exception( $msg );
			}

			foreach( $listTypes[$refId] as $listType )
			{
				$stmt->bind( 1, $item->getId(), \Aimeos\MW\DB\Statement\Base::PARAM_INT );
				$stmt->bind( 2, $refId, \Aimeos\MW\DB\Statement\Base::PARAM_INT );
				$stmt->bind( 3, $refItem->getCurrencyId() );
				$stmt->bind( 4, $listType );
				$stmt->bind( 5, $refItem->getType() );
				$stmt->bind( 6, $refItem->getValue() );
				$stmt->bind( 7, $refItem->getCosts() );
				$stmt->bind( 8, $refItem->getRebate() );
				$stmt->bind( 9, $refItem->getTaxRate() );
				$stmt->bind( 10, $refItem->getQuantity(), \Aimeos\MW\DB\Statement\Base::PARAM_INT );
				$stmt->bind( 11, $date ); //mtime
				$stmt->bind( 12, $editor );
				$stmt->bind( 13, $siteid, \Aimeos\MW\DB\Statement\Base::PARAM_INT );
				$stmt->bind( 14, $date ); //ctime

				try {
					$stmt->execute()->finish();
				} catch( \Aimeos\MW\DB\Exception $e ) { ; } // Ignore duplicates
			}
		}
	}
}
aimeos / aimeos-core

Push — master ( 7f3a33...b24c92 )

Standard::__construct() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
