8e9e29f5-efc2-4de8-8a2b-c3576f489780

Committed 17 Sep 2024 08:12AM UTC coverage: 92.154% (-0.03%) from 92.185%

Build # 8e9e29f5-efc2-4de8-8a2b-c3576f489780

Build Type

push

circleci

Committed by

aimeos

Commit Message

Moved fetching locale/site items to manager decorator

Run Details

12 of 13 new or added lines in 1 file covered. (92.31%)

3 existing lines in 1 file now uncovered.

9784 of 10617 relevant lines covered (92.15%)

74.61 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.43

/src/MShop/Product/Manager/Standard.php

<?php

/**
 * @license LGPLv3, https://opensource.org/licenses/LGPL-3.0
 * @copyright Aimeos (aimeos.org), 2015-2024
 * @package MShop
 * @subpackage Product
 */


namespace Aimeos\MShop\Product\Manager;


/**
 * Default product manager.
 *
 * @package MShop
 * @subpackage Product
 */
class Standard
        extends \Aimeos\MShop\Common\Manager\Base
        implements \Aimeos\MShop\Product\Manager\Iface, \Aimeos\MShop\Common\Manager\Factory\Iface,
                \Aimeos\MShop\Common\Manager\ListsRef\Iface, \Aimeos\MShop\Common\Manager\PropertyRef\Iface
{
        use \Aimeos\MShop\Common\Manager\ListsRef\Traits;
        use \Aimeos\MShop\Common\Manager\PropertyRef\Traits;


        private array $cacheTags = [];


        /**
         * Commits the running database transaction on the connection identified by the given name
         *
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function commit() : \Aimeos\MShop\Common\Manager\Iface
        {
                parent::commit();

                $this->context()->cache()->deleteByTags( $this->cacheTags );
                $this->cacheTags = [];

                return $this;
        }


        /**
         * Creates a new empty item instance
         *
         * @param array $values Values the item should be initialized with
         * @return \Aimeos\MShop\Product\Item\Iface New product item object
         */
        public function create( array $values = [] ) : \Aimeos\MShop\Common\Item\Iface
        {
                $context = $this->context();

                $values['.date'] = $context->datetime();
                $values['product.siteid'] = $values['product.siteid'] ?? $context->locale()->getSiteId();

                return new \Aimeos\MShop\Product\Item\Standard( 'product.', $values );
        }


        /**
         * Removes multiple items.
         *
         * @param \Aimeos\MShop\Common\Item\Iface[]|string[] $items List of item objects or IDs of the items
         * @return \Aimeos\MShop\Product\Manager\Iface Manager object for chaining method calls
         */
        public function delete( $items ) : \Aimeos\MShop\Common\Manager\Iface
        {
                parent::delete( $items )->deleteRefItems( $items );

                $this->cacheTags = array_merge( $this->cacheTags, map( $items )->copy()->cast()->prefix( 'product-' )->all() );

                return $this;
        }


        /**
         * Creates a filter object.
         *
         * @param bool|null $default Add default criteria or NULL for relaxed default criteria
         * @param bool $site TRUE for adding site criteria to limit items by the site of related items
         * @return \Aimeos\Base\Criteria\Iface Returns the filter object
         */
        public function filter( ?bool $default = false, bool $site = false ) : \Aimeos\Base\Criteria\Iface
        {
                $object = $this->filterBase( 'product', $default );

                if( $default !== false )
                {
                        $date = $this->context()->datetime();

                        $start = [
                                $object->compare( '<=', 'product.datestart', $date ),
                                $object->compare( '==', 'product.datestart', null ),
                                $object->compare( '==', 'product.type', 'event' ),
                        ];

                        $end = [
                                $object->compare( '>=', 'product.dateend', $date ),
                                $object->compare( '==', 'product.dateend', null ),
                        ];

                        /** mshop/product/manager/strict-events
                         * Hide events automatically if they are over
                         *
                         * Events are hidden by default if they are finished, removed from the
                         * list view and can't be bought any more. If you sell webinars including
                         * an archive of old ones you want to continue to sell for example, then
                         * these webinars should be still shown.
                         *
                         * Setting this configuration option to false will display event products
                         * that are already over and customers can still buy them.
                         *
                         * @param bool TRUE to hide events after they are over (default), FALSE to continue to show them
                         * @since 2019.10
                         */
                        if( !$this->context()->config()->get( 'mshop/product/manager/strict-events', true ) ) {
                                $end[] = $object->compare( '==', 'product.type', 'event' );
                        }

                        $object->setConditions( $object->and( [
                                $object->getConditions(),
                                $object->or( $start ),
                                $object->or( $end ),
                        ] ) );
                }

                return $object;
        }


        /**
         * Returns the item specified by its code and domain/type if necessary
         *
         * @param string $code Code of the item
         * @param string[] $ref List of domains to fetch list items and referenced items for
         * @param string|null $domain Domain of the item if necessary to identify the item uniquely
         * @param string|null $type Type code of the item if necessary to identify the item uniquely
         * @param bool|null $default Add default criteria or NULL for relaxed default criteria
         * @return \Aimeos\MShop\Common\Item\Iface Item object
         */
        public function find( string $code, array $ref = [], string $domain = null, string $type = null,
                ?bool $default = false ) : \Aimeos\MShop\Common\Item\Iface
        {
                return $this->findBase( ['product.code' => $code], $ref, $default );
        }


        /**
         * Returns the additional column/search definitions
         *
         * @return array Associative list of column names as keys and items implementing \Aimeos\Base\Criteria\Attribute\Iface
         */
        public function getSaveAttributes() : array
        {
                return $this->createAttributes( [
                        'product.type' => [
                                'label' => 'Type',
                                'internalcode' => 'type',
                        ],
                        'product.label' => [
                                'label' => 'Label',
                                'internalcode' => 'label',
                        ],
                        'product.code' => [
                                'label' => 'SKU',
                                'internalcode' => 'code',
                        ],
                        'product.url' => [
                                'label' => 'URL segment',
                                'internalcode' => 'url',
                        ],
                        'product.dataset' => [
                                'label' => 'Data set',
                                'internalcode' => 'dataset',
                        ],
                        'product.datestart' => [
                                'label' => 'Start date/time',
                                'internalcode' => 'start',
                                'type' => 'datetime',
                        ],
                        'product.dateend' => [
                                'label' => 'End date/time',
                                'internalcode' => 'end',
                                'type' => 'datetime',
                        ],
                        'product.instock' => [
                                'label' => 'Product in stock',
                                'internalcode' => 'instock',
                                'type' => 'int',
                        ],
                        'product.status' => [
                                'label' => 'Status',
                                'internalcode' => 'status',
                                'type' => 'int',
                        ],
                        'product.scale' => [
                                'label' => 'Quantity scale',
                                'internalcode' => 'scale',
                                'type' => 'float',
                        ],
                        'product.boost' => [
                                'label' => 'Boost factor',
                                'internalcode' => 'boost',
                                'type' => 'float',
                        ],
                        'product.config' => [
                                'label' => 'Configuration',
                                'internalcode' => 'config',
                                'type' => 'json',
                                'public' => false,
                        ],
                        'product.target' => [
                                'label' => 'URL target',
                                'internalcode' => 'target',
                                'public' => false,
                        ],
                        'product.rating' => [
                                'label' => 'Rating value',
                                'internalcode' => 'rating',
                                'type' => 'decimal',
                                'public' => false,
                        ],
                        'product.ratings' => [
                                'label' => 'Number of ratings',
                                'internalcode' => 'ratings',
                                'type' => 'int',
                                'public' => false,
                        ],
                ] );
        }


        /**
         * Returns the attributes that can be used for searching.
         *
         * @param bool $withsub Return also attributes of sub-managers if true
         * @return \Aimeos\Base\Criteria\Attribute\Iface[] List of search attribute items
         */
        public function getSearchAttributes( bool $withsub = true ) : array
        {
                $level = \Aimeos\MShop\Locale\Manager\Base::SITE_ALL;
                $level = $this->context()->config()->get( 'mshop/product/manager/sitemode', $level );

                return array_replace( parent::getSearchAttributes( $withsub ), $this->createAttributes( [
                        'product:has' => array(
                                'code' => 'product:has()',
                                'internalcode' => ':site AND :key AND mproli."id"',
                                'internaldeps' => ['LEFT JOIN "mshop_product_list" AS mproli ON ( mproli."parentid" = mpro."id" )'],
                                'label' => 'Product has list item, parameter(<domain>[,<list type>[,<reference ID>)]]',
                                'type' => 'null',
                                'public' => false,
                                        'function' => function( &$source, array $params ) use ( $level ) {
                                        $keys = [];

                                        foreach( (array) ( $params[1] ?? '' ) as $type ) {
                                                foreach( (array) ( $params[2] ?? '' ) as $id ) {
                                                        $keys[] = $params[0] . '|' . ( $type ? $type . '|' : '' ) . $id;
                                                }
                                        }

                                        $sitestr = $this->siteString( 'mproli."siteid"', $level );
                                        $keystr = $this->toExpression( 'mproli."key"', $keys, ( $params[2] ?? null ) ? '==' : '=~' );
                                        $source = str_replace( [':site', ':key'], [$sitestr, $keystr], $source );

                                        return $params;
                                }
                        ),
                        'product:prop' => array(
                                'code' => 'product:prop()',
                                'internalcode' => ':site AND :key AND mpropr."id"',
                                'internaldeps' => ['LEFT JOIN "mshop_product_property" AS mpropr ON ( mpropr."parentid" = mpro."id" )'],
                                'label' => 'Product has property item, parameter(<property type>[,<language code>[,<property value>]])',
                                'type' => 'null',
                                'public' => false,
                                'function' => function( &$source, array $params ) use ( $level ) {
                                        $keys = [];
                                        $langs = array_key_exists( 1, $params ) ? ( $params[1] ?? 'null' ) : '';

                                        foreach( (array) $langs as $lang ) {
                                                foreach( (array) ( $params[2] ?? '' ) as $val ) {
                                                        $keys[] = substr( $params[0] . '|' . ( $lang === null ? 'null|' : ( $lang ? $lang . '|' : '' ) ) . $val, 0, 255 );
                                                }
                                        }

                                        $sitestr = $this->siteString( 'mpropr."siteid"', $level );
                                        $keystr = $this->toExpression( 'mpropr."key"', $keys, ( $params[2] ?? null ) ? '==' : '=~' );
                                        $source = str_replace( [':site', ':key'], [$sitestr, $keystr], $source );

                                        return $params;
                                }
                        ),
                ] ) );
        }


        /**
         * Updates the rating of the item
         *
         * @param string $id ID of the item
         * @param string $rating Decimal value of the rating
         * @param int $ratings Total number of ratings for the item
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function rate( string $id, string $rating, int $ratings ) : \Aimeos\MShop\Common\Manager\Iface
        {
                $context = $this->context();
                $conn = $context->db( $this->getResourceName() );

                /** mshop/product/manager/rate/mysql
                 * Updates the rating of the product in the database
                 *
                 * @see mshop/product/manager/rate/ansi
                 */

                /** mshop/product/manager/rate/ansi
                 * Updates the rating of the product in the database
                 *
                 * The SQL statement must be a string suitable for being used as
                 * prepared statement. It must include question marks for binding
                 * the values for the rating to the statement before they are
                 * sent to the database server. The order of the columns must
                 * correspond to the order in the rate() 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 update ratings
                 * @since 2020.10
                 * @see mshop/product/manager/insert/ansi
                 * @see mshop/product/manager/update/ansi
                 * @see mshop/product/manager/newid/ansi
                 * @see mshop/product/manager/delete/ansi
                 * @see mshop/product/manager/search/ansi
                 * @see mshop/product/manager/count/ansi
                 * @see mshop/product/manager/stock/ansi
                 */
                $path = 'mshop/product/manager/rate';

                $stmt = $this->getCachedStatement( $conn, $path, $this->getSqlConfig( $path ) );

                $stmt->bind( 1, $rating );
                $stmt->bind( 2, $ratings, \Aimeos\Base\DB\Statement\Base::PARAM_INT );
                $stmt->bind( 3, $context->locale()->getSiteId() );
                $stmt->bind( 4, (int) $id, \Aimeos\Base\DB\Statement\Base::PARAM_INT );

                $stmt->execute()->finish();

                return $this;
        }


        /**
         * Updates if the product is in stock
         *
         * @param string $id ID of the procuct item
         * @param int $value "0" or "1" if product is in stock or not
         * @return \Aimeos\MShop\Common\Manager\Iface Manager object for chaining method calls
         */
        public function stock( string $id, int $value ) : \Aimeos\MShop\Common\Manager\Iface
        {
                $context = $this->context();
                $conn = $context->db( $this->getResourceName() );

                /** mshop/product/manager/stock/mysql
                 * Updates the rating of the product in the database
                 *
                 * @see mshop/product/manager/stock/ansi
                 */

                /** mshop/product/manager/stock/ansi
                 * Updates the rating of the product in the database
                 *
                 * The SQL statement must be a string suitable for being used as
                 * prepared statement. It must include question marks for binding
                 * the values for the rating to the statement before they are
                 * sent to the database server. The order of the columns must
                 * correspond to the order in the stock() 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 update ratings
                 * @since 2021.10
                 * @see mshop/product/manager/insert/ansi
                 * @see mshop/product/manager/update/ansi
                 * @see mshop/product/manager/newid/ansi
                 * @see mshop/product/manager/delete/ansi
                 * @see mshop/product/manager/search/ansi
                 * @see mshop/product/manager/count/ansi
                 * @see mshop/product/manager/rate/ansi
                 */
                $path = 'mshop/product/manager/stock';

                $stmt = $this->getCachedStatement( $conn, $path, $this->getSqlConfig( $path ) );

                $stmt->bind( 1, $value, \Aimeos\Base\DB\Statement\Base::PARAM_INT );
                $stmt->bind( 2, $context->locale()->getSiteId() );
                $stmt->bind( 3, (int) $id, \Aimeos\Base\DB\Statement\Base::PARAM_INT );

                $stmt->execute()->finish();

                return $this;
        }


        /**
         * Adds or updates an item object or a list of them.
         *
         * @param \Aimeos\Map|\Aimeos\MShop\Common\Item\Iface[]|\Aimeos\MShop\Common\Item\Iface $items Item or list of items whose data should be saved
         * @param bool $fetch True if the new ID should be returned in the item
         * @return \Aimeos\Map|\Aimeos\MShop\Common\Item\Iface Saved item or items
         */
        public function save( $items, bool $fetch = true )
        {
                $items = parent::save( $items, $fetch );

                if( ( $ids = map( $items )->getId()->filter() )->count() === map( $items )->count() ) {
                        $this->cacheTags = array_merge( $this->cacheTags, map( $ids )->prefix( 'product-' )->all() );
                } else {
                        $this->cacheTags[] = 'product';
                }

                return $items;
        }


        /**
         * Saves the dependent items of the item
         *
         * @param \Aimeos\MShop\Common\Item\Iface $item Item object
         * @param bool $fetch True if the new ID should be returned in the item
         * @return \Aimeos\MShop\Common\Item\Iface Updated item
         */
        public function saveRefs( \Aimeos\MShop\Common\Item\Iface $item, bool $fetch = true ) : \Aimeos\MShop\Common\Item\Iface
        {
                $this->savePropertyItems( $item, 'product', $fetch );
                $this->saveListItems( $item, 'product', $fetch );

                return $item;
        }


        /**
         * Merges the data from the given map and the referenced items
         *
         * @param array $entries Associative list of ID as key and the associative list of property key/value pairs as values
         * @param array $ref List of referenced items to fetch and add to the entries
         * @return array Associative list of ID as key and the updated entries as value
         */
        public function searchRefs( array $entries, array $ref ) : array
        {
                $parentIds = array_keys( $entries );

                foreach( $this->getStockItems( $parentIds, $ref ) as $stockId => $stockItem ) {
                        $entries[$stockItem->getProductId()]['.stock'][$stockId] = $stockItem;
                }

                if( $this->hasRef( $ref, 'product/property' ) )
                {
                        $name = 'product/property';
                        $propTypes = isset( $ref[$name] ) && is_array( $ref[$name] ) ? $ref[$name] : null;

                        foreach( $this->getPropertyItems( $parentIds, 'product', $propTypes ) as $id => $list ) {
                                $entries[$id]['.propitems'] = $list;
                        }
                }

                foreach( $this->getListItems( $parentIds, $ref, 'product' ) as $id => $listItem ) {
                        $entries[$listItem->getParentId()]['.listitems'][$id] = $listItem;
                }

                return $entries;
        }


        /**
         * Returns the stock items for the given product codes
         *
         * @param array $entries List of product records
         * @return \Aimeos\Map List of product IDs as keys and items implementing \Aimeos\MShop\Locale\Item\Site\Iface as values
         * @deprecated 2025.01 Done by site decorator
         */
        protected function getSiteItems( array $siteIds ) : \Aimeos\Map
        {
                $manager = \Aimeos\MShop::create( $this->context(), 'locale/site' );
                $filter = $manager->filter( true )->add( ['locale.site.siteid' => $siteIds] )->slice( 0, 0x7fffffff );

                return $manager->search( $filter )->col( null, 'locale.site.siteid' );
        }


        /**
         * Returns the stock items for the given product codes
         *
         * @param string[] $ids Unique product codes
         * @param string[] $ref List of domains to fetch referenced items for
         * @return \Aimeos\Map List of IDs as keys and items implementing \Aimeos\MShop\Stock\Item\Iface as values
         */
        protected function getStockItems( array $ids, array $ref ) : \Aimeos\Map
        {
                if( !$this->hasRef( $ref, 'stock' ) ) {
                        return map();
                }

                $manager = \Aimeos\MShop::create( $this->context(), 'stock' );
                $filter = $manager->filter( true )->add( 'stock.productid', '==', $ids )->slice( 0, 0x7fffffff );

                if( isset( $ref['stock'] ) && is_array( $ref['stock'] ) ) {
                        $filter->add( 'stock.type', '==', $ref['stock'] );
                }

                return $manager->search( $filter );
        }


        /**
         * Returns the prefix for the item properties and search keys.
         *
         * @return string Prefix for the item properties and search keys
         */
        protected function prefix() : string
        {
                return 'product.';
        }


        /** mshop/product/manager/resource
         * Name of the database connection resource to use
         *
         * You can configure a different database connection for each data domain
         * and if no such connection name exists, the "db" connection will be used.
         * It's also possible to use the same database connection for different
         * data domains by configuring the same connection name using this setting.
         *
         * @param string Database connection name
         * @since 2023.04
         */

        /** mshop/product/manager/name
         * Class name of the used product manager implementation
         *
         * Each default manager can be replace 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\Product\Manager\Standard
         *
         * and you want to replace it with your own version named
         *
         *  \Aimeos\MShop\Product\Manager\Mymanager
         *
         * then you have to set the this configuration option:
         *
         *  mshop/product/manager/name = Mymanager
         *
         * 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 "MyManager"!
         *
         * @param string Last part of the class name
         * @since 2014.03
         */

        /** mshop/product/manager/decorators/excludes
         * Excludes decorators added by the "common" option from the product 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 product manager.
         *
         *  mshop/product/manager/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 product manager.
         *
         * @param array List of decorator names
         * @since 2014.03
         * @see mshop/common/manager/decorators/default
         * @see mshop/product/manager/decorators/global
         * @see mshop/product/manager/decorators/local
         */

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

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

        /** mshop/product/manager/submanagers
         * List of manager names that can be instantiated by the product 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
         */

        /** mshop/product/manager/delete/mysql
         * Deletes the items matched by the given IDs from the database
         *
         * @see mshop/product/manager/delete/ansi
         */

        /** mshop/product/manager/delete/ansi
         * Deletes the items matched by the given IDs from the database
         *
         * Removes the records specified by the given IDs from the product 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 items
         * @since 2014.03
         * @see mshop/product/manager/insert/ansi
         * @see mshop/product/manager/update/ansi
         * @see mshop/product/manager/newid/ansi
         * @see mshop/product/manager/search/ansi
         * @see mshop/product/manager/count/ansi
         * @see mshop/product/manager/rate/ansi
         * @see mshop/product/manager/stock/ansi
         */

        /** mshop/product/manager/insert/mysql
         * Inserts a new product record into the database table
         *
         * @see mshop/product/manager/insert/ansi
         */

        /** mshop/product/manager/insert/ansi
         * Inserts a new product record into the database table
         *
         * Items with no ID yet (i.e. the ID is NULL) will be created in
         * the database and the newly created ID retrieved afterwards
         * using the "newid" SQL statement.
         *
         * 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 product 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 save() 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
         * @see mshop/product/manager/update/ansi
         * @see mshop/product/manager/newid/ansi
         * @see mshop/product/manager/delete/ansi
         * @see mshop/product/manager/search/ansi
         * @see mshop/product/manager/count/ansi
         * @see mshop/product/manager/rate/ansi
         * @see mshop/product/manager/stock/ansi
         */

        /** mshop/product/manager/update/mysql
         * Updates an existing product record in the database
         *
         * @see mshop/product/manager/update/ansi
         */

        /** mshop/product/manager/update/ansi
         * Updates an existing product record in the database
         *
         * Items which already have an ID (i.e. the ID is not NULL) will
         * be updated in the database.
         *
         * 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 product item to the statement before they are
         * sent to the database server. The order of the columns must
         * correspond to the order in the save() 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 updating records
         * @since 2014.03
         * @see mshop/product/manager/insert/ansi
         * @see mshop/product/manager/newid/ansi
         * @see mshop/product/manager/delete/ansi
         * @see mshop/product/manager/search/ansi
         * @see mshop/product/manager/count/ansi
         * @see mshop/product/manager/rate/ansi
         * @see mshop/product/manager/stock/ansi
         */

        /** mshop/product/manager/newid/mysql
         * Retrieves the ID generated by the database when inserting a new record
         *
         * @see mshop/product/manager/newid/ansi
         */

        /** mshop/product/manager/newid/ansi
         * Retrieves the ID generated by the database when inserting a new record
         *
         * As soon as a new record is inserted into the database table,
         * the database server generates a new and unique identifier for
         * that record. This ID can be used for retrieving, updating and
         * deleting that specific record from the table again.
         *
         * For MySQL:
         *  SELECT LAST_INSERT_ID()
         * For PostgreSQL:
         *  SELECT currval('seq_mpro_id')
         * For SQL Server:
         *  SELECT SCOPE_IDENTITY()
         * For Oracle:
         *  SELECT "seq_mpro_id".CURRVAL FROM DUAL
         *
         * There's no way to retrive the new ID by a SQL statements that
         * fits for most database servers as they implement their own
         * specific way.
         *
         * @param string SQL statement for retrieving the last inserted record ID
         * @since 2014.03
         * @see mshop/product/manager/insert/ansi
         * @see mshop/product/manager/update/ansi
         * @see mshop/product/manager/delete/ansi
         * @see mshop/product/manager/search/ansi
         * @see mshop/product/manager/count/ansi
         * @see mshop/product/manager/rate/ansi
         * @see mshop/product/manager/stock/ansi
         */

        /** mshop/product/manager/sitemode
         * Mode how items from levels below or above in the site tree are handled
         *
         * By default, only items from the current site are fetched from the
         * storage. If the ai-sites extension is installed, you can create a
         * tree of sites. Then, this setting allows you to define for the
         * whole product domain if items from parent sites are inherited,
         * sites from child sites are aggregated or both.
         *
         * Available constants for the site mode are:
         * * 0 = only items from the current site
         * * 1 = inherit items from parent sites
         * * 2 = aggregate items from child sites
         * * 3 = inherit and aggregate items at the same time
         *
         * You also need to set the mode in the locale manager
         * (mshop/locale/manager/sitelevel) to one of the constants.
         * If you set it to the same value, it will work as described but you
         * can also use different modes. For example, if inheritance and
         * aggregation is configured the locale manager but only inheritance
         * in the domain manager because aggregating items makes no sense in
         * this domain, then items wil be only inherited. Thus, you have full
         * control over inheritance and aggregation in each domain.
         *
         * @param int Constant from Aimeos\MShop\Locale\Manager\Base class
         * @since 2018.01
         * @see mshop/locale/manager/sitelevel
         */

        /** mshop/product/manager/search/mysql
         * Retrieves the records matched by the given criteria in the database
         *
         * @see mshop/product/manager/search/ansi
         */

        /** mshop/product/manager/search/ansi
         * Retrieves the records matched by the given criteria in the database
         *
         * Fetches the records matched by the given criteria from the product
         * 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. 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
         * @see mshop/product/manager/insert/ansi
         * @see mshop/product/manager/update/ansi
         * @see mshop/product/manager/newid/ansi
         * @see mshop/product/manager/delete/ansi
         * @see mshop/product/manager/count/ansi
         * @see mshop/product/manager/rate/ansi
         * @see mshop/product/manager/stock/ansi
         */

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

        /** mshop/product/manager/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
         * 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
         * @see mshop/product/manager/insert/ansi
         * @see mshop/product/manager/update/ansi
         * @see mshop/product/manager/newid/ansi
         * @see mshop/product/manager/delete/ansi
         * @see mshop/product/manager/search/ansi
         * @see mshop/product/manager/rate/ansi
         * @see mshop/product/manager/stock/ansi
         */
}

aimeos / aimeos-core / 8e9e29f5-efc2-4de8-8a2b-c3576f489780

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous