77cfcd86-13ba-4918-aeab-35e967c86487

Committed 28 Sep 2024 11:34AM UTC coverage: 91.619% (-0.02%) from 91.637%

Build # 77cfcd86-13ba-4918-aeab-35e967c86487

Build Type

push

circleci

Committed by

aimeos

Commit Message

Fixed file check

Run Details

1 of 2 new or added lines in 1 file covered. (50.0%)

2 existing lines in 1 file now uncovered.

9543 of 10416 relevant lines covered (91.62%)

79.88 hits per line

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

93.66

/src/MShop/Media/Manager/Standard.php

<?php

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


namespace Aimeos\MShop\Media\Manager;

use \Psr\Http\Message\UploadedFileInterface;


/**
 * Default media manager implementation.
 *
 * @package MShop
 * @subpackage Media
 */
class Standard
        extends Base
        implements \Aimeos\MShop\Media\Manager\Iface, \Aimeos\MShop\Common\Manager\Factory\Iface
{
        use \Aimeos\MShop\Upload;
        use Preview;


        /**
         * Copies the media item and the referenced files
         *
         * @param \Aimeos\MShop\Media\Item\Iface $item Media item whose files should be copied
         * @return \Aimeos\MShop\Media\Item\Iface Copied media item with new files
         */
        public function copy( \Aimeos\MShop\Media\Item\Iface $item ) : \Aimeos\MShop\Media\Item\Iface
        {
                $item = ( clone $item )->setId( null );

                $path = $item->getUrl();
                $mime = $item->getMimeType();
                $domain = $item->getDomain();
                $previews = $item->getPreviews();
                $fsname = $item->getFileSystem();
                $fs = $this->context()->fs( $fsname );

                if( $fs->has( $path ) )
                {
                        $newPath = $this->path( substr( basename( $path ), 9 ), $mime, $domain );
                        $fs->copy( $path, $newPath );
                        $item->setUrl( $newPath );
                }

                if( empty( $previews ) ) {
                        return $this->scale( $item, true );
                }

                foreach( $previews as $size => $preview )
                {
                        if( $fsname !== 'fs-mimeicon' && $fs->has( $preview ) )
                        {
                                $newPath = $this->path( substr( basename( $preview ), 9 ), $mime, $domain );
                                $fs->copy( $preview, $newPath );
                                $previews[$size] = $newPath;
                        }
                }

                return $item->setPreviews( $previews );
        }


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

                $values['.languageid'] = $locale->getLanguageId();
                $values['media.siteid'] = $values['media.siteid'] ?? $locale->getSiteId();

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


        /**
         * Removes multiple items.
         *
         * @param \Aimeos\MShop\Common\Item\Iface[]|string[] $items List of item objects or IDs of the items
         * @return \Aimeos\MShop\Media\Manager\Iface Manager object for chaining method calls
         */
        public function delete( $items ) : \Aimeos\MShop\Common\Manager\Iface
        {
                foreach( map( $items ) as $item )
                {
                        if( $item instanceof \Aimeos\MShop\Media\Item\Iface && $item->getFileSystem() === 'fs-media' )
                        {
                                try
                                {
                                        $this->deletePreviews( $item, $item->getPreviews() );
                                        $this->deleteFile( $item->getUrl(), 'fs-media' );
                                }
                                catch( \Exception $e )
                                {
                                        $this->context()->logger()->notice( $e->getMessage() );
                                }
                        }
                }

                return parent::delete( $items );
        }


        /**
         * 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
        {
                $filter = $this->filterBase( 'media', $default );

                if( $default !== false )
                {
                        if( $langid = $this->context()->locale()->getLanguageId() )
                        {
                                $filter->add( $filter->or( [
                                        $filter->compare( '==', 'media.languageid', $langid ),
                                        $filter->compare( '==', 'media.languageid', null ),
                                ] ) );
                        }
                }

                return $filter;
        }


        /**
         * 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( [
                        'media.type' => [
                                'label' => 'Type',
                                'internalcode' => 'type',
                        ],
                        'media.label' => [
                                'label' => 'Label',
                                'internalcode' => 'label',
                        ],
                        'media.domain' => [
                                'label' => 'Domain',
                                'internalcode' => 'domain',
                        ],
                        'media.languageid' => [
                                'label' => 'Language code',
                                'internalcode' => 'langid',
                        ],
                        'media.mimetype' => [
                                'label' => 'Mime type',
                                'internalcode' => 'mimetype',
                        ],
                        'media.url' => [
                                'label' => 'URL',
                                'internalcode' => 'link',
                        ],
                        'media.previews' => [
                                'label' => 'Preview URLs as JSON encoded string',
                                'internalcode' => 'preview',
                                'type' => 'json',
                        ],
                        'media.filesystem' => [
                                'label' => 'File sytem name',
                                'internalcode' => 'fsname',
                        ],
                        'media.status' => [
                                'label' => 'Status',
                                'internalcode' => 'status',
                                'type' => 'int',
                        ],
                ] );
        }


        /**
         * 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
        {
                return array_replace( parent::getSearchAttributes( $withsub ), $this->createAttributes( [
                        'media.preview' => [
                                'label' => 'Preview URLs as JSON encoded string',
                                'internalcode' => 'preview',
                                'type' => 'json',
                        ],
                ] ) );
        }


        /**
         * 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 'media.';
        }


        /**
         * Rescales the original file to preview files referenced by the media item
         *
         * The height/width configuration for scaling
         * - mshop/media/<files|preview>/maxheight
         * - mshop/media/<files|preview>/maxwidth
         * - mshop/media/<files|preview>/force-size
         *
         * @param \Aimeos\MShop\Media\Item\Iface $item Media item whose files should be scaled
         * @param bool $force True to enforce creating new preview images
         * @return \Aimeos\MShop\Media\Item\Iface Rescaled media item
         */
        public function scale( \Aimeos\MShop\Media\Item\Iface $item, bool $force = false ) : \Aimeos\MShop\Media\Item\Iface
        {
                $mime = $item->getMimeType();

                if( empty( $url = $item->getUrl() )
                        || $item->getFileSystem() === 'fs-mimeicon'
                        || strncmp( 'data:', $url, 5 ) === 0
                        || strncmp( 'image/svg', $mime, 9 ) === 0
                        || strncmp( 'image/', $mime, 6 ) !== 0
                ) {
                        return $item;
                }

                $fs = $this->context()->fs( $item->getFileSystem() );
                $is = ( $fs instanceof \Aimeos\Base\Filesystem\MetaIface ? true : false );

                if( !$force
                        && !empty( $item->getPreviews() )
                        && preg_match( '#^[a-zA-Z]{2,6}://#', $url ) !== 1
                        && ( $is && date( 'Y-m-d H:i:s', $fs->time( $url ) ) < $item->getTimeModified() || $fs->has( $url ) )
                ) {
                        return $item;
                }

                $domain = $item->getDomain() ?: '-';
                $sizes = $this->sizes( $domain, $item->getType() );
                $image = $this->image( $url );
                $quality = $this->quality();
                $old = $item->getPreviews();
                $previews = [];

                foreach( $this->createPreviews( $image, $sizes ) as $width => $image )
                {
                        $path = $old[$width] ?? $this->path( $url, 'image/webp', $domain );
                        $fs->write( $path, (string) $image->toWebp( $quality ) );

                        $previews[$width] = $path;
                        unset( $old[$width] );
                }

                $item = $this->deletePreviews( $item, $old )->setPreviews( $previews );

                $this->call( 'scaled', $item, $image );

                return $item;
        }


        /**
         * Returns the preview image sizes for scaling the images.
         *
         * @param string $domain Domain of the image
         * @param string $type Type of the image
         * @return array List of image sizes with "maxwidth", "maxheight" and "force-size" properties
         */
        protected function sizes( string $domain, string $type ) : array
        {
                $config = $this->context()->config();

                /** mshop/media/manager/previews/common
                 * Scaling options for preview images
                 *
                 * For responsive images, several preview images of different sizes are
                 * generated. This setting controls how many preview images are generated,
                 * what's their maximum width and height and if the given width/height is
                 * enforced by cropping images that doesn't fit.
                 *
                 * The setting must consist of a list image size definitions like:
                 *
                 *  [
                 *    ['maxwidth' => 240, 'maxheight' => 320, 'force-size' => 2],
                 *    ['maxwidth' => 720, 'maxheight' => 960, 'force-size' => 1],
                 *    ['maxwidth' => 2160, 'maxheight' => 2880, 'force-size' => 0],
                 *  ]
                 *
                 * "maxwidth" sets the maximum allowed width of the image whereas
                 * "maxheight" does the same for the maximum allowed height. If both
                 * values are given, the image is scaled proportionally so it fits into
                 * the box defined by both values.
                 *
                 * In case the image has different proportions than the specified ones
                 * and "force-size" is "0", the image is resized to fit entirely into
                 * the specified box. One side of the image will be shorter than it
                 * would be possible by the specified box.
                 *
                 * If "force-size" is "1", scaled images that doesn't fit into the
                 * given maximum width/height are centered and then filled with the
                 * background color.
                 *
                 * The value of "2" will center the image while the given maxwidth and
                 * maxheight are fully covered and crop the parts of the image which
                 * are outside the box created by maxwidth and maxheight.
                 *
                 * By default, images aren't padded or cropped, only scaled.
                 *
                 * The values for "maxwidth" and "maxheight" can also be null or not
                 * used. In that case, the width or height or both is unbound. If none
                 * of the values are given, the image won't be scaled at all. If only
                 * one value is set, the image will be scaled exactly to the given width
                 * or height and the other side is scaled proportionally.
                 *
                 * You can also define different preview sizes for different domains (e.g.
                 * for catalog images) and for different types (e.g. catalog stage images).
                 * Use configuration settings like
                 *
                 *  mshop/media/manager/previews/previews/<domain>/
                 *  mshop/media/manager/previews/previews/<domain>/<type>/
                 *
                 * for example:
                 *
                 *  mshop/media/manager/previews/catalog/previews => [
                 *    ['maxwidth' => 240, 'maxheight' => 320, 'force-size' => true],
                 *  ]
                 *  mshop/media/manager/previews/catalog/previews => [
                 *    ['maxwidth' => 400, 'maxheight' => 300, 'force-size' => false]
                 *  ]
                 *  mshop/media/manager/previews/catalog/stage/previews => [
                 *    ['maxwidth' => 360, 'maxheight' => 320, 'force-size' => true],
                 *    ['maxwidth' => 720, 'maxheight' => 480, 'force-size' => true]
                 *  ]
                 *
                 * These settings will create two preview images for catalog stage images,
                 * one with a different size for all other catalog images and all images
                 * from other domains will be sized to 240x320px. The available domains
                 * which can have images are:
                 *
                 * * attribute
                 * * catalog
                 * * product
                 * * service
                 * * supplier
                 *
                 * There are a few image types included per domain ("default" is always
                 * available). You can also add your own types in the admin backend and
                 * extend the frontend to display them where you need them.
                 *
                 * @param array List of image size definitions
                 * @since 2019.07
                 */
                $sizes = $config->get( 'mshop/media/manager/previews/common', [] );
                $sizes = $config->get( 'mshop/media/manager/previews/' . $domain, $sizes );
                $sizes = $config->get( 'mshop/media/manager/previews/' . $domain . '/' . $type, $sizes );

                return $sizes;
        }


        /**
         * Stores the uploaded file and returns the updated item
         *
         * @param \Aimeos\MShop\Media\Item\Iface $item Media item for storing the file meta data, "domain" must be set
         * @param \Psr\Http\Message\UploadedFileInterface|null $file Uploaded file object
         * @param \Psr\Http\Message\UploadedFileInterface|null $preview Uploaded preview image
         * @return \Aimeos\MShop\Media\Item\Iface Updated media item including file and preview paths
         */
        public function upload( \Aimeos\MShop\Media\Item\Iface $item, ?UploadedFileInterface $file, UploadedFileInterface $preview = null ) : \Aimeos\MShop\Media\Item\Iface
        {
                $domain = $item->getDomain() ?: '-';
                $fsname = $item->getFileSystem() ?: 'fs-media';
                $fs = $this->context()->fs( $fsname );

                if( $file && $file->getError() !== UPLOAD_ERR_NO_FILE && $this->isAllowed( $mime = $this->mimetype( $file ) ) )
                {
                        try
                        {
                                $oldpath = $item->getUrl();

                                $path = $this->path( $file->getClientFilename(), $mime, $domain );
                                $fs->write( $path, $this->sanitize( $file->getStream()->getContents(), $mime ) );

                                $item->setLabel( $file->getClientFilename() )
                                        ->setMimetype( $mime )
                                        ->setUrl( $path );

                                if( !$preview ) {
                                        $this->scale( $item, true );
                                }

                                if( !empty( $oldpath ) && $fs->has( $oldpath ) ) {
                                        $fs->rm( $oldpath );
                                }
                        }
                        catch( \Exception $e )
                        {
                                if( !empty( $path ) && $fs->has( $path ) ) {
                                        $fs->rm( $path );
                                }

                                throw $e;
                        }
                }

                if( $preview && $preview->getError() !== UPLOAD_ERR_NO_FILE && $this->isAllowed( $mime = $this->mimetype( $preview ) ) )
                {
                        $path = $this->path( $preview->getClientFilename(), $mime, $domain );
                        $fs->write( $path, $this->sanitize( $preview->getStream()->getContents(), $mime ) );

                        $item->setPreview( $path );
                }

                return $item;
        }


        /** mshop/media/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/media/manager/name
         * Class name of the used media 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\Media\Manager\Standard
         *
         * and you want to replace it with your own version named
         *
         *  \Aimeos\MShop\Media\Manager\Mymanager
         *
         * then you have to set the this configuration option:
         *
         *  mshop/media/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 2015.10
         */

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

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

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

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

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

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

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

        /** mshop/media/manager/insert/ansi
         * Inserts a new media 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 media 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 2015.10
         * @see mshop/media/manager/update/ansi
         * @see mshop/media/manager/newid/ansi
         * @see mshop/media/manager/delete/ansi
         * @see mshop/media/manager/search/ansi
         * @see mshop/media/manager/count/ansi
         */

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

        /** mshop/media/manager/update/ansi
         * Updates an existing media 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 media 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 2015.10
         * @see mshop/media/manager/insert/ansi
         * @see mshop/media/manager/newid/ansi
         * @see mshop/media/manager/delete/ansi
         * @see mshop/media/manager/search/ansi
         * @see mshop/media/manager/count/ansi
         */

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

        /** mshop/media/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_mmed_id')
         * For SQL Server:
         *  SELECT SCOPE_IDENTITY()
         * For Oracle:
         *  SELECT "seq_mmed_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 2015.10
         * @see mshop/media/manager/insert/ansi
         * @see mshop/media/manager/update/ansi
         * @see mshop/media/manager/delete/ansi
         * @see mshop/media/manager/search/ansi
         * @see mshop/media/manager/count/ansi
         */

        /** mshop/media/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 media 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/media/manager/search/mysql
         * Retrieves the records matched by the given criteria in the database
         *
         * @see mshop/media/manager/search/ansi
         */

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

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

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

aimeos / aimeos-core / 77cfcd86-13ba-4918-aeab-35e967c86487

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