Save Class Reference

Inheritance diagram for Save:

Public Member Functions
	__construct (\Magento\Backend\App\Action\Context $context, \Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator $productUrlPathGenerator, \Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator $categoryUrlPathGenerator, \Magento\CmsUrlRewrite\Model\CmsPageUrlPathGenerator $cmsPageUrlPathGenerator, UrlFinderInterface $urlFinder)
Public Member Functions inherited from AbstractAction
	__construct (Action\Context $context)
	dispatch (\Magento\Framework\App\RequestInterface $request)
	_processUrlKeys ()
	getUrl ($route='', $params=[])
Public Member Functions inherited from Action
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getActionFlag ()
Public Member Functions inherited from AbstractAction
	__construct (Context $context)
	dispatch (RequestInterface $request)
	getRequest ()
	getResponse ()
Public Member Functions inherited from ActionInterface
	execute ()

Protected Member Functions
	_handleCatalogUrlRewrite ($model)
	getTargetPath ($model)
	getCanonicalTargetPath ()
Protected Member Functions inherited from Rewrite
	_getCategory ()
	_getProduct ()
	_getCmsPage ()
	_getUrlRewrite ()
Protected Member Functions inherited from AbstractAction
	_isAllowed ()
	_getSession ()
	getMessageManager ()
	_addBreadcrumb ($label, $title, $link=null)
	_addContent (\Magento\Framework\View\Element\AbstractBlock $block)
	_addLeft (\Magento\Framework\View\Element\AbstractBlock $block)
	_addJs (\Magento\Framework\View\Element\AbstractBlock $block)
	_isUrlChecked ()
	_processLocaleSettings ()
	_redirect ($path, $arguments=[])
	_forward ($action, $controller=null, $module=null, array $params=null)
	_validateSecretKey ()
Protected Member Functions inherited from Action
	_forward ($action, $controller=null, $module=null, array $params=null)
	_redirect ($path, $arguments=[])

Protected Attributes
	$productUrlPathGenerator
	$categoryUrlPathGenerator
	$cmsPageUrlPathGenerator
	$urlFinder
Protected Attributes inherited from Rewrite
	$_product
	$_category
	$_cmsPage
	$_urlRewrite
Protected Attributes inherited from AbstractAction
	$_publicActions = []
	$_sessionNamespace = self::SESSION_NAMESPACE
	$_helper
	$_session
	$_authorization
	$_auth
	$_backendUrl
	$_localeResolver
	$_canUseBaseUrl
	$_formKeyValidator
Protected Attributes inherited from Action
	$_objectManager
	$_sessionNamespace
	$_eventManager
	$_actionFlag
	$_redirect
	$_view
	$_url
	$messageManager
Protected Attributes inherited from AbstractAction
	$_request
	$_response
	$resultRedirectFactory
	$resultFactory

Additional Inherited Members
Data Fields inherited from Rewrite
const	ADMIN_RESOURCE = 'Magento_UrlRewrite::urlrewrite'
const	ENTITY_TYPE_CUSTOM = 'custom'
const	ENTITY_TYPE_PRODUCT = 'product'
const	ENTITY_TYPE_CATEGORY = 'category'
const	ENTITY_TYPE_CMS_PAGE = 'cms-page'
Data Fields inherited from AbstractAction
const	FLAG_IS_URLS_CHECKED = 'check_url_settings'
const	SESSION_NAMESPACE = 'adminhtml'
const	ADMIN_RESOURCE = 'Magento_Backend::admin'
Data Fields inherited from ActionInterface
const	FLAG_NO_DISPATCH = 'no-dispatch'
const	FLAG_NO_POST_DISPATCH = 'no-postDispatch'
const	FLAG_NO_DISPATCH_BLOCK_EVENT = 'no-beforeGenerateLayoutBlocksDispatch'
const	PARAM_NAME_BASE64_URL = 'r64'
const	PARAM_NAME_URL_ENCODED = 'uenc'

Detailed Description

Definition at line 15 of file Save.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backend\App\Action\Context	$context,
		\Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator	$productUrlPathGenerator,
		\Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator	$categoryUrlPathGenerator,
		\Magento\CmsUrlRewrite\Model\CmsPageUrlPathGenerator	$cmsPageUrlPathGenerator,
		UrlFinderInterface	$urlFinder
	)

Parameters

\Magento\Backend\App\Action\Context	$context
\Magento\CatalogUrlRewrite\Model\ProductUrlPathGenerator	$productUrlPathGenerator
\Magento\CatalogUrlRewrite\Model\CategoryUrlPathGenerator	$categoryUrlPathGenerator
\Magento\CmsUrlRewrite\Model\CmsPageUrlPathGenerator	$cmsPageUrlPathGenerator
UrlFinderInterface	$urlFinder

Definition at line 44 of file Save.php.

      {
        parent::__construct($context);
        $this->productUrlPathGenerator = $productUrlPathGenerator;
        $this->categoryUrlPathGenerator = $categoryUrlPathGenerator;
        $this->cmsPageUrlPathGenerator = $cmsPageUrlPathGenerator;
        $this->urlFinder = $urlFinder;
    }

Member Function Documentation

_handleCatalogUrlRewrite()

_handleCatalogUrlRewrite (   $model )

protected

Override urlrewrite data, basing on current category and product

Parameters

\Magento\UrlRewrite\Model\UrlRewrite

$model

Returns

void

Exceptions

Definition at line 65 of file Save.php.

    {
        $productId = $this->_getProduct()->getId();
        $categoryId = $this->_getCategory()->getId();
        if ($productId || $categoryId) {
            if ($model->isObjectNew()) {
                $model->setEntityType($productId ? self::ENTITY_TYPE_PRODUCT : self::ENTITY_TYPE_CATEGORY)
                    ->setEntityId($productId ?: $categoryId);
                if ($productId && $categoryId) {
                    $model->setMetadata(['category_id' => $categoryId]);
                }
            }
            $model->setTargetPath($this->getTargetPath($model));
        }
    }

getCanonicalTargetPath()

getCanonicalTargetPath ( )

protected

Returns

string

Definition at line 113 of file Save.php.

    {
        $product = $this->_getProduct()->getId() ? $this->_getProduct() : null;
        $category = $this->_getCategory()->getId() ? $this->_getCategory() : null;
        return $product
            ? $this->productUrlPathGenerator->getCanonicalUrlPath($product, $category)
            : $this->categoryUrlPathGenerator->getCanonicalUrlPath($category);
    }

getTargetPath()

getTargetPath (   $model )

protected

Get Target Path

Parameters

\Magento\UrlRewrite\Model\UrlRewrite

$model

Returns

string

Exceptions

Definition at line 88 of file Save.php.

    {
        $targetPath = $this->getCanonicalTargetPath();
        if ($model->getRedirectType() && !$model->getIsAutogenerated()) {
            $data = [
                UrlRewrite::ENTITY_ID => $model->getEntityId(),
                UrlRewrite::TARGET_PATH => $targetPath,
                UrlRewrite::ENTITY_TYPE => $model->getEntityType(),
                UrlRewrite::STORE_ID => $model->getStoreId(),
            ];
            $rewrite = $this->urlFinder->findOneByData($data);
            if (!$rewrite) {
                $message = $model->getEntityType() === self::ENTITY_TYPE_PRODUCT
                    ? __("The selected product isn't associated with the selected store or category.")
                    : __("The selected category isn't associated with the selected store.");
                throw new LocalizedException($message);
            }
            $targetPath = $rewrite->getRequestPath();
        }
        return $targetPath;
    }

Field Documentation

$categoryUrlPathGenerator

$categoryUrlPathGenerator

protected

Definition at line 25 of file Save.php.

$cmsPageUrlPathGenerator

$cmsPageUrlPathGenerator

protected

Definition at line 30 of file Save.php.

$productUrlPathGenerator

$productUrlPathGenerator

protected

Definition at line 20 of file Save.php.

$urlFinder

$urlFinder

protected

Definition at line 35 of file Save.php.

---

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

• vendor/magento/module-url-rewrite/Controller/Adminhtml/Url/Rewrite/Save.php