• Home
• DmitryDulepov
• Realurl
• Encoder
• UrlEncoder

PHP Class DmitryDulepov\Realurl\Encoder\UrlEncoder

Datei anzeigen Open project: dmitryd/typo3-realurl

Protected Properties

Property	Type	Description
$encodedUrl	string
$encoderParameters	array
$originalUrl	string	This is the URL with sorted GET parameters. It is used for cache manipulation.
$originalUrlParameters	array
$pageRepository	TYPO3\CMS\Frontend\Page\PageRepository
$sysLanguageUid	integer
$urlParameters	array
$urlPrepend	string
$urlPrependRegister	array
$urlToEncode	string
$usedAliases	array

Public Methods

Method	Description
__construct ( )	Initializes the class.
cleanUpAlias ( array $configuration, string $newAliasValue ) : string	Cleans up the alias
encodeUrl ( array &$encoderParameters ) : void	Entry point for the URL encoder.
getConfiguration ( ) : ConfigurationReader	Returns the configuration reader. This can be used in hooks.
getOriginalUrlParameters ( ) : array	Returns a coipy of original url parameters. This can be used in hooks.
getUtility ( ) : Utility	Returns $this->utility. This can be used in hooks.
postProcessEncodedUrl ( array &$parameters, TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer $pObj ) : void	Post-processes the URL. If necessary prepends another domain to the URL.

Protected Methods

Method	Description
addRemainingUrlParameters ( ) : void	Adds remaining parameters to the generated URL. Note: parameters that are ignored by the 'cache/ignoredGetParametersRegExp' configuration option are not considered here!
addToPathCache ( string $pagePath ) : void	Adds an entry to the path cache.
appendToEncodedUrl ( string $stringToAppend, boolean $addSlash = TRUE ) : void	Appends a string to $this->encodedUrl properly handling slashes in between.
callPostEncodeHooks ( )	Calls user-defined hooks after encoding
canCacheUrl ( string $url ) : boolean	Checks if the URL can be cached. This function may prevent RealURL cache pollution with Solr or Indexed search URLs. Also some doktypes are ignored for the cache.
canEncoderExecute ( ) : boolean	Checks if RealURL can encode URLs.
checkForAllEmptySegments ( array &$segments ) : void	Checks if all segments are empty and makes the empty array in such case.
createAliasForValue ( string $getVarValue, array $configuration ) : string	Converts value to the alias
createPathComponent ( ) : void	Creates a path part of the URL.
createPathComponentThroughOverride ( ) : boolean	Checks if tx_realurl_pathoverride is set and goes the easy way.
createPathComponentUsingRootline ( ) : void	Creates a path part of the URL.
createUniqueAlias ( array $configuration, $newAliasValue, $idValue ) : string	Creates a unique alias.
encodeFixedPostVars ( ) : void	Encodes fixed postVars.
encodePathComponents ( ) : void	Encodes the path to the page.
encodePostVarSets ( ) : void	Encodes 'postVarSets' into URL segments.
encodePreVars ( ) : void	Encodes 'preVars' into URL segments.
encodeSingleVariable ( array $configuration, string &$previousValue, array &$segments )	Encodes a single variable for xxxVars.
encodeUrlParameterBlock ( array $configurationArray ) : string	Encodes pre- or postVars according to the given configuration.
encodeUrlParameterBlockUseAsIs ( string $getVarName, string $getVarValue, array $configuration, array &$segments, string &$previousValue ) : boolean	Just sets the value to the segment as is.
encodeUrlParameterBlockUsingLookupTable ( string $getVarName, string $getVarValue, array $configuration, array &$segments, string &$previousValue ) : boolean	Uses lookUpMap to set the segment.
encodeUrlParameterBlockUsingNoMatch ( string $getVarName, string $getVarValue, array $configuration, array &$segments, string &$previousValue ) : boolean	Uses 'noMatch' options to set the segment.
encodeUrlParameterBlockUsingUserFunc ( string $getVarName, string $getVarValue, array $configuration, array &$segments, string &$previousValue ) : boolean	Calls the userFunc for the value to get the segment.
encodeUrlParameterBlockUsingValueDefault ( string $getVarName, string $getVarValue, array $configuration, array &$segments, string &$previousValue ) : boolean	Just sets the default value to the segment.
encodeUrlParameterBlockUsingValueMap ( string $getVarName, string $getVarValue, array $configuration, array &$segments, string &$previousValue ) : boolean	Uses the value map to determine the segment value.
executeEncoder ( ) : void	Encodes the URL.
fetchFromUrlCache ( ) : boolean	Attempts to fetch the speaking URL from the url cache.
fixEmptySegments ( array &$segments )	Changes empty segments to the value of $this->emptySegmentValue.
fixPageId ( )	Fixes page id if it is not a direct numeric page id.
getFromAliasCache ( array $configuration, string $getVarValue, integer $languageUid, string $onlyThisAlias = '' ) : string | null	Obtains the value from the alias cache.
handleFileName ( ) : void	Appends file name and suffix if necessary.
handleFileNameSetDefaultSuffix ( ) : void	Sets the default suffix to the URL if configured so.
handleFileNameUsingGetVars ( ) : boolean	Checks if the file name like 'rss.xml' should be produced according to _GET vars.
hasUrlParameters ( array $configurationArray ) : boolean	Checks if any GETvar from the parameter block is present in $this->urlParameters.
initializeConfiguration ( )	Initializes configuration reader.
initializeUrlPrepend ( ) : void	Checks if we should prpend URL according to _DOMAINS configuration.
isProperTsfe ( ) : boolean	Checks if TSFE is initialized correctly.
isRealURLEnabled ( ) : boolean	Checks if RealURL is enabled.
isSimulateStaticEnabled ( ) : boolean	Checks if simulatestatic is enabled.
isTypo3Url ( ) : boolean	Checks if a TYPO3 URL is going to be encoded.
parseUrlParameters ( ) : void	Parses query string to a set of key/value inside $this->urlParameters.
prepareUrlPrepend ( ) : void	Prepares the URL to use with _DOMAINS configuration.
reapplyAbsRefPrefix ( ) : void	Reapplies absRefPrefix if necessary.
removeIgnoredUrlParameters ( )	Removes ignored parameters from various members.
removeIgnoredUrlParametersFromArray ( array $urlParameters ) : array	Removes ignored URL parameters from the parameter list.
setLanguage ( ) : void	Sets language for the encoder either from the URl or from the TSFE.
storeAliasToUrlCacheMapping ( string $urlCacheId ) : void	Stores mapping between used aliases and url cache id. This information is used in the DataHandle hook to clear URl cache when record are renamed (= aliases change).
storeInAliasCache ( array $configuration, string $newAliasValue, string $idValue, integer $languageUid ) : string	Adds the value to the alias cache.
storeInUrlCache ( ) : void	Stores data in the URL cache.
trimMultipleSlashes ( )	Removes multiple slashes at the end of the encoded URL.

Method Details

Property Details