‪TYPO3CMS  9.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder Class Reference

Public Member Functions

 injectConfigurationManager (\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
 
 injectExtensionService (\TYPO3\CMS\Extbase\Service\ExtensionService $extensionService)
 
 injectEnvironmentService (\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService)
 
 initializeObject ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setRequest (Request $request)
 
Request getRequest ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setArguments (array $arguments)
 
array getArguments ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setSection ($section)
 
string getSection ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setFormat ($format)
 
string getFormat ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setCreateAbsoluteUri ($createAbsoluteUri)
 
bool getCreateAbsoluteUri ()
 
string getAbsoluteUriScheme ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setAbsoluteUriScheme ($absoluteUriScheme)
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setAddQueryString ($addQueryString)
 
bool getAddQueryString ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setAddQueryStringMethod ($addQueryStringMethod)
 
string getAddQueryStringMethod ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setArgumentsToBeExcludedFromQueryString (array $argumentsToBeExcludedFromQueryString)
 
array getArgumentsToBeExcludedFromQueryString ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setArgumentPrefix ($argumentPrefix)
 
string getArgumentPrefix ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setLinkAccessRestrictedPages ($linkAccessRestrictedPages)
 
bool getLinkAccessRestrictedPages ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setTargetPageUid ($targetPageUid)
 
int getTargetPageUid ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setTargetPageType ($targetPageType)
 
int getTargetPageType ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setNoCache ($noCache)
 
bool getNoCache ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder setUseCacheHash ($useCacheHash)
 
bool getUseCacheHash ()
 
array getLastArguments ()
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder reset ()
 
string uriFor ($actionName=null, $controllerArguments=[], $controllerName=null, $extensionName=null, $pluginName=null)
 
string build ()
 
string buildBackendUri ()
 
string buildFrontendUri ()
 
array convertTransientObjectToArray (\TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject $object)
 

Protected Member Functions

array removeDefaultControllerAndAction (array $controllerArguments, $extensionName, $pluginName)
 
array buildTypolinkConfiguration ()
 
array convertDomainObjectsToIdentityArrays (array $arguments)
 
array convertIteratorToArray (\Iterator $iterator)
 

Protected Attributes

TYPO3 CMS Extbase Configuration ConfigurationManagerInterface $configurationManager
 
TYPO3 CMS Extbase Service ExtensionService $extensionService
 
TYPO3 CMS Frontend ContentObject ContentObjectRenderer $contentObject
 
Request $request
 
array $arguments = array( )
 
array $lastArguments = array( )
 
string $section = ''
 
bool $createAbsoluteUri = false
 
string $absoluteUriScheme
 
bool $addQueryString = false
 
string $addQueryStringMethod
 
array $argumentsToBeExcludedFromQueryString = array( )
 
bool $linkAccessRestrictedPages = false
 
int $targetPageUid
 
int $targetPageType = 0
 
bool $noCache = false
 
bool $useCacheHash = true
 
string $format = ''
 
string $argumentPrefix
 
TYPO3 CMS Extbase Service EnvironmentService $environmentService
 

Detailed Description

An URI Builder

Definition at line 28 of file UriBuilder.php.

Member Function Documentation

◆ build()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::build ( )

Builds the URI Depending on the current context this calls buildBackendUri() or buildFrontendUri()

Returns
‪string The URI
See also
‪buildBackendUri()
‪buildFrontendUri()

Definition at line 588 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildFrontendUri().

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\uriFor().

◆ buildBackendUri()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::buildBackendUri ( )

Builds the URI, backend flavour The resulting URI is relative and starts with "index.php". The settings pageUid, pageType, noCache, useCacheHash & linkAccessRestrictedPages will be ignored in the backend.

Returns
‪string The URI

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 605 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$arguments, TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$section, TYPO3\CMS\Core\Utility\ArrayUtility\arrayDiffAssocRecursive(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertDomainObjectsToIdentityArrays(), and TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule().

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\build().

◆ buildFrontendUri()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::buildFrontendUri ( )

Builds the URI, frontend flavour

Returns
‪string The URI
See also
‪buildTypolinkConfiguration()

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 683 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$absoluteUriScheme, and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildTypolinkConfiguration().

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\build(), TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriCreatesAbsoluteUrisIfSpecified(), TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriCreatesTypoLink(), TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriDoesNotSetAbsoluteUriSchemeIfCreateAbsoluteUriIsFalse(), and TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriSetsAbsoluteUriSchemeIfSpecified().

◆ buildTypolinkConfiguration()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::buildTypolinkConfiguration ( )
protected

Builds a TypoLink configuration array from the current settings

Returns
‪array typolink configuration array
See also
‪TSref/typolink

Definition at line 702 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$addQueryStringMethod, TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$arguments, $GLOBALS, TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$section, TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$targetPageType, TYPO3\CMS\Core\Utility\HttpUtility\buildQueryString(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertDomainObjectsToIdentityArrays().

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildFrontendUri().

◆ convertDomainObjectsToIdentityArrays()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::convertDomainObjectsToIdentityArrays ( array  $arguments)
protected

Recursively iterates through the specified arguments and turns instances of type \TYPO3\CMS\Extbase\DomainObject\AbstractEntity into an arrays containing the uid of the domain object.

Parameters
array$arguments‪The arguments to be iterated
Exceptions

Definition at line 750 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$arguments, TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertIteratorToArray(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertTransientObjectToArray().

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildTypolinkConfiguration(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertTransientObjectToArray().

◆ convertIteratorToArray()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::convertIteratorToArray ( \Iterator  $iterator)
protected
Parameters
\Iterator$iterator
Returns
‪array

Definition at line 782 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertDomainObjectsToIdentityArrays(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertTransientObjectToArray().

◆ convertTransientObjectToArray()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::convertTransientObjectToArray ( \TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject  $object)

Converts a given object recursively into an array.

Parameters
\TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject$object
Returns
‪array
Todo:
‪Refactore this into convertDomainObjectsToIdentityArrays()

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 800 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertDomainObjectsToIdentityArrays(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertIteratorToArray().

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertDomainObjectsToIdentityArrays(), TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\tansientObjectsAreConvertedToAnArrayOfProperties(), TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\tansientObjectsAreRecursivelyConverted(), and TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\tansientObjectsWithObjectStorageAreConvertedToAnArrayOfProperties().

◆ getAbsoluteUriScheme()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getAbsoluteUriScheme ( )
Returns
‪string

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 258 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$absoluteUriScheme.

◆ getAddQueryString()

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getAddQueryString ( )
Returns
‪bool

Definition at line 292 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$addQueryString.

◆ getAddQueryStringMethod()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getAddQueryStringMethod ( )
Returns
‪string

Definition at line 314 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$addQueryStringMethod.

◆ getArgumentPrefix()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getArgumentPrefix ( )
Returns
‪string

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 359 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$argumentPrefix.

◆ getArguments()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getArguments ( )
Returns
‪array

Definition at line 189 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$arguments.

◆ getArgumentsToBeExcludedFromQueryString()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getArgumentsToBeExcludedFromQueryString ( )
Returns
‪array

Definition at line 337 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$argumentsToBeExcludedFromQueryString.

◆ getCreateAbsoluteUri()

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getCreateAbsoluteUri ( )
Returns
‪bool

Definition at line 249 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$createAbsoluteUri.

◆ getFormat()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getFormat ( )
Returns
‪string

Definition at line 229 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$format.

◆ getLastArguments()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getLastArguments ( )

Returns the arguments being used for the last URI being built. This is only set after build() / uriFor() has been called.

Returns
‪array The last arguments

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 476 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$lastArguments.

◆ getLinkAccessRestrictedPages()

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getLinkAccessRestrictedPages ( )
Returns
‪bool

Definition at line 379 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$linkAccessRestrictedPages.

◆ getNoCache()

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getNoCache ( )
Returns
‪bool

Definition at line 443 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$noCache.

◆ getRequest()

Request TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getRequest ( )
Returns
‪Request

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 167 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$request.

◆ getSection()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getSection ( )
Returns
‪string

Definition at line 209 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$section.

◆ getTargetPageType()

int TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getTargetPageType ( )
Returns
‪int

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 422 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$targetPageType.

◆ getTargetPageUid()

int TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getTargetPageUid ( )

returns $this->targetPageUid.

Returns
‪int

Definition at line 401 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$targetPageUid.

◆ getUseCacheHash()

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::getUseCacheHash ( )
Returns
‪bool

Definition at line 464 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$useCacheHash.

◆ initializeObject()

TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::initializeObject ( )

Life-cycle method that is called by the DI container as soon as this object is completely built

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 145 of file UriBuilder.php.

◆ injectConfigurationManager()

TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::injectConfigurationManager ( \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface  $configurationManager)
Parameters
\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface$configurationManager

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 118 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$configurationManager.

◆ injectEnvironmentService()

TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::injectEnvironmentService ( \TYPO3\CMS\Extbase\Service\EnvironmentService  $environmentService)
Parameters
\TYPO3\CMS\Extbase\Service\EnvironmentService$environmentService

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 136 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$environmentService.

◆ injectExtensionService()

TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::injectExtensionService ( \TYPO3\CMS\Extbase\Service\ExtensionService  $extensionService)
Parameters
\TYPO3\CMS\Extbase\Service\ExtensionService$extensionService

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 127 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$extensionService.

◆ removeDefaultControllerAndAction()

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::removeDefaultControllerAndAction ( array  $controllerArguments,
  $extensionName,
  $pluginName 
)
protected

This removes controller and/or action arguments from given controllerArguments if they are equal to the default controller/action of the target plugin. Note: This is only active in FE mode and if feature "skipDefaultArguments" is enabled

See also
‪\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::isFeatureEnabled()
Parameters
array$controllerArguments‪the current controller arguments to be modified
string$extensionName‪target extension name
string$pluginName‪target plugin name
Returns
‪array

Definition at line 565 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\uriFor().

◆ reset()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::reset ( )

Resets all UriBuilder options to their default value

Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 486 of file UriBuilder.php.

◆ setAbsoluteUriScheme()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setAbsoluteUriScheme (   $absoluteUriScheme)

Sets the scheme that should be used for absolute URIs in FE mode

Parameters
string$absoluteUriScheme‪the scheme to be used for absolute URIs
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 270 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$absoluteUriScheme.

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriDoesNotSetAbsoluteUriSchemeIfCreateAbsoluteUriIsFalse(), and TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriSetsAbsoluteUriSchemeIfSpecified().

◆ setAddQueryString()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setAddQueryString (   $addQueryString)

If set, the current query parameters will be merged with $this->arguments. Defaults to FALSE.

Parameters
bool$addQueryString
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
See also
‪TSref/typolink.addQueryString

Definition at line 283 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$addQueryString.

◆ setAddQueryStringMethod()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setAddQueryStringMethod (   $addQueryStringMethod)

Sets the method to get the addQueryString parameters. Defaults undefined which results in using QUERY_STRING.

Parameters
string$addQueryStringMethod
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
See also
‪TSref/typolink.addQueryString.method

Definition at line 305 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$addQueryStringMethod.

◆ setArgumentPrefix()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setArgumentPrefix (   $argumentPrefix)

Specifies the prefix to be used for all arguments.

Parameters
string$argumentPrefix
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 349 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$argumentPrefix.

◆ setArguments()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setArguments ( array  $arguments)

Additional query parameters. If you want to "prefix" arguments, you can pass in multidimensional arrays: array('prefix1' => array('foo' => 'bar')) gets "&prefix1[foo]=bar"

Parameters
array$arguments
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 180 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$arguments.

◆ setArgumentsToBeExcludedFromQueryString()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setArgumentsToBeExcludedFromQueryString ( array  $argumentsToBeExcludedFromQueryString)

A list of arguments to be excluded from the query parameters Only active if addQueryString is set

Parameters
array$argumentsToBeExcludedFromQueryString
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining
See also
‪TSref/typolink.addQueryString.exclude
‪setAddQueryString()

Definition at line 328 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$argumentsToBeExcludedFromQueryString.

◆ setCreateAbsoluteUri()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setCreateAbsoluteUri (   $createAbsoluteUri)

If set, the URI is prepended with the current base URI. Defaults to FALSE.

Parameters
bool$createAbsoluteUri
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 240 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$createAbsoluteUri.

Referenced by TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriCreatesAbsoluteUrisIfSpecified(), TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriDoesNotSetAbsoluteUriSchemeIfCreateAbsoluteUriIsFalse(), and TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\buildFrontendUriSetsAbsoluteUriSchemeIfSpecified().

◆ setFormat()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setFormat (   $format)

Specifies the format of the target (e.g. "html" or "xml")

Parameters
string$format
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 220 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$format.

◆ setLinkAccessRestrictedPages()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setLinkAccessRestrictedPages (   $linkAccessRestrictedPages)

If set, URIs for pages without access permissions will be created

Parameters
bool$linkAccessRestrictedPages
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 370 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$linkAccessRestrictedPages.

◆ setNoCache()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setNoCache (   $noCache)

by default FALSE; if TRUE, &no_cache=1 will be appended to the URI This overrules the useCacheHash setting

Parameters
bool$noCache
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 434 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$noCache.

◆ setRequest()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setRequest ( Request  $request)

Sets the current request

Parameters
Request$request
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

only to be used within Extbase, not part of TYPO3 Core API.

Definition at line 157 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$request.

◆ setSection()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setSection (   $section)

If specified, adds a given HTML anchor to the URI (#...)

Parameters
string$section
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 200 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$section.

◆ setTargetPageType()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setTargetPageType (   $targetPageType)

Sets the page type of the target URI. Defaults to 0

Parameters
int$targetPageType
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 412 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$targetPageType.

◆ setTargetPageUid()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setTargetPageUid (   $targetPageUid)

Uid of the target page

Parameters
int$targetPageUid
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 390 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$targetPageUid.

◆ setUseCacheHash()

TYPO3 CMS Extbase Mvc Web Routing UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setUseCacheHash (   $useCacheHash)

by default TRUE; if FALSE, no cHash parameter will be appended to the URI If noCache is set, this setting will be ignored.

Parameters
bool$useCacheHash
Returns
‪\TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder the current UriBuilder to allow method chaining

Definition at line 455 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$useCacheHash.

◆ uriFor()

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::uriFor (   $actionName = null,
  $controllerArguments = [],
  $controllerName = null,
  $extensionName = null,
  $pluginName = null 
)

Creates an URI used for linking to an Extbase action. Works in Frontend and Backend mode of TYPO3.

Parameters
string$actionName‪Name of the action to be called
array$controllerArguments‪Additional query parameters. Will be "namespaced" and merged with $this->arguments.
string$controllerName‪Name of the target controller. If not set, current ControllerName is used.
string$extensionName‪Name of the target extension, without underscores. If not set, current ExtensionName is used.
string$pluginName‪Name of the target plugin. If not set, current PluginName is used.
Returns
‪string the rendered URI
See also
‪build()

Definition at line 516 of file UriBuilder.php.

References TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\$format, TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\build(), TYPO3\CMS\Core\Utility\ArrayUtility\mergeRecursiveWithOverrule(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\removeDefaultControllerAndAction().

Member Data Documentation

◆ $absoluteUriScheme

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$absoluteUriScheme
protected

Definition at line 68 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildFrontendUri(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getAbsoluteUriScheme(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setAbsoluteUriScheme().

◆ $addQueryString

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$addQueryString = false
protected

Definition at line 72 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getAddQueryString(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setAddQueryString().

◆ $addQueryStringMethod

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$addQueryStringMethod
protected

Definition at line 76 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildTypolinkConfiguration(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getAddQueryStringMethod(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setAddQueryStringMethod().

◆ $argumentPrefix

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$argumentPrefix
protected

Definition at line 108 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getArgumentPrefix(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setArgumentPrefix().

◆ $arguments

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$arguments = array( )
protected

Definition at line 50 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildTypolinkConfiguration(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\convertDomainObjectsToIdentityArrays(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getArguments(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setArguments().

◆ $argumentsToBeExcludedFromQueryString

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$argumentsToBeExcludedFromQueryString = array( )
protected

Definition at line 80 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getArgumentsToBeExcludedFromQueryString(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setArgumentsToBeExcludedFromQueryString().

◆ $configurationManager

TYPO3 CMS Extbase Configuration ConfigurationManagerInterface TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$configurationManager
protected

Definition at line 32 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\injectConfigurationManager().

◆ $contentObject

TYPO3 CMS Frontend ContentObject ContentObjectRenderer TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$contentObject
protected

An instance of \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer

Definition at line 42 of file UriBuilder.php.

◆ $createAbsoluteUri

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$createAbsoluteUri = false
protected

Definition at line 64 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getCreateAbsoluteUri(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setCreateAbsoluteUri().

◆ $environmentService

TYPO3 CMS Extbase Service EnvironmentService TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$environmentService
protected

Definition at line 112 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\injectEnvironmentService().

◆ $extensionService

TYPO3 CMS Extbase Service ExtensionService TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$extensionService
protected

Definition at line 36 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\injectExtensionService().

◆ $format

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$format = ''
protected

Definition at line 104 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getFormat(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setFormat(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\uriFor().

◆ $lastArguments

array TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$lastArguments = array( )
protected

Arguments which have been used for building the last URI

Definition at line 56 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getLastArguments().

◆ $linkAccessRestrictedPages

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$linkAccessRestrictedPages = false
protected

Definition at line 84 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getLinkAccessRestrictedPages(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setLinkAccessRestrictedPages().

◆ $noCache

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$noCache = false
protected

Definition at line 96 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getNoCache(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setNoCache().

◆ $request

Request TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$request
protected

Definition at line 46 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getRequest(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setRequest().

◆ $section

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$section = ''
protected

Definition at line 60 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildBackendUri(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildTypolinkConfiguration(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getSection(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setSection().

◆ $targetPageType

int TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$targetPageType = 0
protected

Definition at line 92 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\buildTypolinkConfiguration(), TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getTargetPageType(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setTargetPageType().

◆ $targetPageUid

int TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$targetPageUid
protected

Definition at line 88 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getTargetPageUid(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setTargetPageUid().

◆ $useCacheHash

bool TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$useCacheHash = true
protected

Definition at line 100 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\getUseCacheHash(), and TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder\setUseCacheHash().