DbStorage Class Reference

Inheritance diagram for DbStorage:

Public Member Functions
	__construct (UrlRewriteFactory $urlRewriteFactory, DataObjectHelper $dataObjectHelper, ResourceConnection $resource, LoggerInterface $logger=null)
	deleteByData (array $data)
Public Member Functions inherited from AbstractStorage
	__construct (UrlRewriteFactory $urlRewriteFactory, DataObjectHelper $dataObjectHelper)
	findAllByData (array $data)
	findOneByData (array $data)
	replace (array $urls)

Data Fields
const	TABLE_NAME = 'url_rewrite'
const	ERROR_CODE_DUPLICATE_ENTRY = 1062

Protected Member Functions
	prepareSelect (array $data)
	doFindAllByData (array $data)
	doFindOneByData (array $data)
	insertMultiple ($data)
	createFilterDataBasedOnUrls ($urls)
Protected Member Functions inherited from AbstractStorage
	doFindAllByData (array $data)
	doFindOneByData (array $data)
	doReplace (array $urls)
	createUrlRewrite ($data)

Protected Attributes
	$connection
	$resource
Protected Attributes inherited from AbstractStorage
	$urlRewriteFactory
	$dataObjectHelper

Detailed Description

Url rewrites DB storage.

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 24 of file DbStorage.php.

Constructor & Destructor Documentation

__construct()

__construct	(	UrlRewriteFactory	$urlRewriteFactory,
		DataObjectHelper	$dataObjectHelper,
		ResourceConnection	$resource,
		LoggerInterface	$logger = null
	)

Parameters

UrlRewriteFactory	$urlRewriteFactory
DataObjectHelper	$dataObjectHelper
ResourceConnection	$resource
LoggerInterface | null	$logger

Definition at line 57 of file DbStorage.php.

      {
        $this->connection = $resource->getConnection();
        $this->resource = $resource;
        $this->logger = $logger ?: ObjectManager::getInstance()
            ->get(LoggerInterface::class);

        parent::__construct($urlRewriteFactory, $dataObjectHelper);
    }

Member Function Documentation

createFilterDataBasedOnUrls()

createFilterDataBasedOnUrls (   $urls )

protected

Get filter for url rows deletion due to provided urls

Parameters

UrlRewrite[]

$urls

Returns

array

Deprecated:

101.0.3 Not used anymore.

Definition at line 275 of file DbStorage.php.

    {
        $data = [];
        foreach ($urls as $url) {
            $entityType = $url->getEntityType();
            foreach ([UrlRewrite::ENTITY_ID, UrlRewrite::STORE_ID] as $key) {
                $fieldValue = $url->getByKey($key);
                if (!isset($data[$entityType][$key]) || !in_array($fieldValue, $data[$entityType][$key])) {
                    $data[$entityType][$key][] = $fieldValue;
                }
            }
        }

        return $data;
    }

deleteByData()

deleteByData

(

array

$data

)

{Remove rewrites that contains some rewrites data

Parameters

array

$data

Returns

void @api

}

Implements UrlPersistInterface.

Definition at line 294 of file DbStorage.php.

    {
        $this->connection->query(
            $this->prepareSelect($data)->deleteFromSelect($this->resource->getTableName(self::TABLE_NAME))
        );
    }

doFindAllByData()

doFindAllByData ( array  $data )

protected

{}

Definition at line 92 of file DbStorage.php.

    {
        return $this->connection->fetchAll($this->prepareSelect($data));
    }

doFindOneByData()

doFindOneByData ( array  $data )

protected

{}

Definition at line 100 of file DbStorage.php.

    {
        if (array_key_exists(UrlRewrite::REQUEST_PATH, $data)
            && is_string($data[UrlRewrite::REQUEST_PATH])
        ) {
            $result = null;

            $requestPath = $data[UrlRewrite::REQUEST_PATH];

            $data[UrlRewrite::REQUEST_PATH] = [
                rtrim($requestPath, '/'),
                rtrim($requestPath, '/') . '/',
            ];

            $resultsFromDb = $this->connection->fetchAll($this->prepareSelect($data));

            if (count($resultsFromDb) === 1) {
                $resultFromDb = current($resultsFromDb);
                $redirectTypes = [OptionProvider::TEMPORARY, OptionProvider::PERMANENT];

                // If request path matches the DB value or it's redirect - we can return result from DB
                $canReturnResultFromDb = ($resultFromDb[UrlRewrite::REQUEST_PATH] === $requestPath
                    || in_array((int)$resultFromDb[UrlRewrite::REDIRECT_TYPE], $redirectTypes, true));

                // Otherwise return 301 redirect to request path from DB results
                $result = $canReturnResultFromDb ? $resultFromDb : [
                    UrlRewrite::ENTITY_TYPE => 'custom',
                    UrlRewrite::ENTITY_ID => '0',
                    UrlRewrite::REQUEST_PATH => $requestPath,
                    UrlRewrite::TARGET_PATH => $resultFromDb[UrlRewrite::REQUEST_PATH],
                    UrlRewrite::REDIRECT_TYPE => OptionProvider::PERMANENT,
                    UrlRewrite::STORE_ID => $resultFromDb[UrlRewrite::STORE_ID],
                    UrlRewrite::DESCRIPTION => null,
                    UrlRewrite::IS_AUTOGENERATED => '0',
                    UrlRewrite::METADATA => null,
                ];
            } else {
                // If we have 2 results - return the row that matches request path
                foreach ($resultsFromDb as $resultFromDb) {
                    if ($resultFromDb[UrlRewrite::REQUEST_PATH] === $requestPath) {
                        $result = $resultFromDb;
                        break;
                    }
                }
            }

            return $result;
        }

        return $this->connection->fetchRow($this->prepareSelect($data));
    }

insertMultiple()

insertMultiple (   $data )

protected

Insert multiple

Parameters

array

$data

Returns

void

Exceptions

Definition at line 251 of file DbStorage.php.

    {
        try {
            $this->connection->insertMultiple($this->resource->getTableName(self::TABLE_NAME), $data);
        } catch (\Exception $e) {
            if (($e->getCode() === self::ERROR_CODE_DUPLICATE_ENTRY)
                && preg_match('#SQLSTATE\[23000\]: [^:]+: 1062[^\d]#', $e->getMessage())
            ) {
                throw new \Magento\Framework\Exception\AlreadyExistsException(
                    __('URL key for specified store already exists.'),
                    $e
                );
            }
            throw $e;
        }
    }

prepareSelect()

prepareSelect ( array  $data )

protected

Prepare select statement for specific filter

Parameters

array

$data

Returns

Select

Definition at line 77 of file DbStorage.php.

    {
        $select = $this->connection->select();
        $select->from($this->resource->getTableName(self::TABLE_NAME));

        foreach ($data as $column => $value) {
            $select->where($this->connection->quoteIdentifier($column) . ' IN (?)', $value);
        }

        return $select;
    }

Field Documentation

$connection

$connection

protected

Definition at line 39 of file DbStorage.php.

$resource

$resource

protected

Definition at line 44 of file DbStorage.php.

ERROR_CODE_DUPLICATE_ENTRY

const ERROR_CODE_DUPLICATE_ENTRY = 1062

Code of "Integrity constraint violation: 1062 Duplicate entry" error

Definition at line 34 of file DbStorage.php.

TABLE_NAME

const TABLE_NAME = 'url_rewrite'

DB Storage table name

Definition at line 29 of file DbStorage.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-url-rewrite/Model/Storage/DbStorage.php