UrlRewrite Class Reference

Inheritance diagram for UrlRewrite:

Public Member Functions
	validateRequestPath ($requestPath)
	validateSuffix ($suffix)
Public Member Functions inherited from AbstractHelper
	__construct (Context $context)
	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	VERR_MANYSLASHES = 1
const	VERR_ANCHOR = 2

Protected Member Functions
	_validateRequestPath ($requestPath)
Protected Member Functions inherited from AbstractHelper
	_getRequest ()
	_getModuleName ()
	_getUrl ($route, $params=[])

Additional Inherited Members
Protected Attributes inherited from AbstractHelper
	$_moduleName
	$_request
	$_moduleManager
	$_logger
	$_urlBuilder
	$_httpHeader
	$_eventManager
	$_remoteAddress
	$urlEncoder
	$urlDecoder
	$scopeConfig
	$_cacheConfig

Detailed Description

Definition at line 8 of file UrlRewrite.php.

Member Function Documentation

_validateRequestPath()

_validateRequestPath (   $requestPath )

protected

Core func to validate request path If something is wrong with a path it throws localized error message and error code, that can be checked to by wrapper func to alternate error message

Parameters

string

$requestPath

Returns

bool

Exceptions

Definition at line 29 of file UrlRewrite.php.

    {
        if (strpos($requestPath, '//') !== false) {
            throw new \Exception(
                __('Do not use two or more consecutive slashes in the request path.'),
                self::VERR_MANYSLASHES
            );
        }
        if (strpos($requestPath, '#') !== false) {
            throw new \Exception(__('Anchor symbol (#) is not supported in request path.'), self::VERR_ANCHOR);
        }
        return true;
    }

validateRequestPath()

validateRequestPath

(

$requestPath

)

Validates request path Either returns TRUE (success) or throws error (validation failed)

Parameters

string

$requestPath

Exceptions

Definition at line 51 of file UrlRewrite.php.

    {
        try {
            $this->_validateRequestPath($requestPath);
        } catch (\Exception $e) {
            throw new \Magento\Framework\Exception\LocalizedException(__($e->getMessage()));
        }
        return true;
    }

validateSuffix()

validateSuffix

(

$suffix

)

Validates suffix for url rewrites to inform user about errors in it Either returns TRUE (success) or throws error (validation failed)

Parameters

string

$suffix

Exceptions

Definition at line 69 of file UrlRewrite.php.

    {
        try {
            // Suffix itself must be a valid request path
            $this->_validateRequestPath($suffix);
        } catch (\Exception $e) {
            // Make message saying about suffix, not request path
            switch ($e->getCode()) {
                case self::VERR_MANYSLASHES:
                    throw new \Magento\Framework\Exception\LocalizedException(
                        __('Do not use two or more consecutive slashes in the url rewrite suffix.')
                    );
                case self::VERR_ANCHOR:
                    throw new \Magento\Framework\Exception\LocalizedException(
                        __('Anchor symbol (#) is not supported in url rewrite suffix.')
                    );
            }
        }
        return true;
    }

Field Documentation

VERR_ANCHOR

const VERR_ANCHOR = 2

Definition at line 16 of file UrlRewrite.php.

VERR_MANYSLASHES

const VERR_MANYSLASHES = 1

Validation error constants

Definition at line 13 of file UrlRewrite.php.

---

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

• vendor/magento/module-url-rewrite/Helper/UrlRewrite.php