Public Member Functions
	injectConfigurationManager (ConfigurationManagerInterface $configurationManager)

	injectExtensionService (ExtensionService $extensionService)

	injectEnvironmentService (EnvironmentService $environmentService)

	initializeObject ()

Request null	getRequest ()

array	getArguments ()

string	getSection ()

string	getFormat ()

bool	getCreateAbsoluteUri ()

string null	getAbsoluteUriScheme ()

UriBuilder	setLanguage (?string $language)

	getLanguage ()

bool	getAddQueryString ()

string	getAddQueryStringMethod ()

array	getArgumentsToBeExcludedFromQueryString ()

string null	getArgumentPrefix ()

bool	getLinkAccessRestrictedPages ()

int null	getTargetPageUid ()

int	getTargetPageType ()

bool	getNoCache ()

bool	getUseCacheHash ()

array	getLastArguments ()

string	uriFor (?string $actionName=null, ?array $controllerArguments=null, ?string $controllerName=null, ?string $extensionName=null, ?string $pluginName=null)

string	build ()

string	buildBackendUri ()

string	buildFrontendUri ()

array	convertTransientObjectToArray (AbstractDomainObject $object)

Static Public Member Functions
static	setRequest (Request $request)

static	setArguments (array $arguments)

static	setSection (string $section)

static	setFormat (string $format)

static	setCreateAbsoluteUri (bool $createAbsoluteUri)

static	setAbsoluteUriScheme (string $absoluteUriScheme)

static	setAddQueryString (bool $addQueryString)

static	setAddQueryStringMethod (string $addQueryStringMethod)

static	setArgumentsToBeExcludedFromQueryString (array $argumentsToBeExcludedFromQueryString)

static	setArgumentPrefix (string $argumentPrefix)

static	setLinkAccessRestrictedPages (bool $linkAccessRestrictedPages)

static	setTargetPageUid (int $targetPageUid)

static	setTargetPageType (int $targetPageType)

static	setNoCache (bool $noCache)

static	setUseCacheHash ()

static	reset ()

Protected Member Functions
array	removeDefaultControllerAndAction (array $controllerArguments, string $extensionName, string $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 null	$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 null	$targetPageUid

int	$targetPageType = 0

string	$language

bool	$noCache = false

string	$format = ''

string null	$argumentPrefix

TYPO3 CMS Extbase Service EnvironmentService	$environmentService

Detailed Description

An URI Builder

Definition at line 38 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 649 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 & linkAccessRestrictedPages will be ignored in the backend.

Returns: ‪string The URI

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

See also: ‪\TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::getQueryArguments

Definition at line 667 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\arrayDiffKeyRecursive(), 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 728 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: ‪https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Functions/Typolink.html

Definition at line 749 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\$language, 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 799 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 831 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 ( AbstractDomainObject $object )

Converts a given object recursively into an array.

Parameters

\TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject $object

Returns: ‪array

Todo:: ‪Refactor this into convertDomainObjectsToIdentityArrays()

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

Definition at line 849 of file UriBuilder.php.

References TYPO3\CMS\Extbase\DomainObject\AbstractDomainObject\_getProperties(), 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\transientObjectsAreConvertedToAnArrayOfProperties(), TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\transientObjectsAreRecursivelyConverted(), and TYPO3\CMS\Extbase\Tests\Unit\Mvc\Web\Routing\UriBuilderTest\transientObjectsWithObjectStorageAreConvertedToAnArrayOfProperties().

◆ getAbsoluteUriScheme()

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

Returns: ‪string|null

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

Definition at line 273 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 323 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 359 of file UriBuilder.php.

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

◆ getArgumentPrefix()

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

Returns: ‪string|null

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

Definition at line 404 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 201 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 383 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 264 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 243 of file UriBuilder.php.

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

◆ getLanguage()

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

Definition at line 301 of file UriBuilder.php.

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

◆ 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 524 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 425 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 490 of file UriBuilder.php.

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

◆ getRequest()

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

Returns: ‪Request|null

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

Definition at line 178 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 222 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 469 of file UriBuilder.php.

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

◆ getTargetPageUid()

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

returns $this->targetPageUid.

Returns: ‪int|null

Definition at line 448 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 511 of file UriBuilder.php.

◆ 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 155 of file UriBuilder.php.

◆ injectConfigurationManager()

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

Parameters

\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager

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

Definition at line 128 of file UriBuilder.php.

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

◆ injectEnvironmentService()

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

Parameters

\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService

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

Definition at line 146 of file UriBuilder.php.

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

◆ injectExtensionService()

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

Parameters

\TYPO3\CMS\Extbase\Service\ExtensionService $extensionService

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

Definition at line 137 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,
		string	$extensionName,
		string	$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 626 of file UriBuilder.php.

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

◆ reset()

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

static

Resets all UriBuilder options to their default value

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 534 of file UriBuilder.php.

Referenced by TYPO3\CMS\Extensionmanager\Controller\AbstractModuleController\getHref(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\getHref(), TYPO3\CMS\Extensionmanager\Controller\UpdateScriptController\registerDocheaderButtons(), TYPO3\CMS\Extensionmanager\Controller\DistributionController\registerDocheaderButtons(), and TYPO3\CMS\Extensionmanager\Controller\ListController\registerDocheaderButtons().

◆ setAbsoluteUriScheme()

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

static

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: ‪static the current UriBuilder to allow method chaining

Definition at line 284 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()

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

static

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

Parameters

bool $addQueryString

Returns: ‪static the current UriBuilder to allow method chaining

See also: ‪https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Functions/Typolink.html#addquerystring

Definition at line 313 of file UriBuilder.php.

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

◆ setAddQueryStringMethod()

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

static

Sets the method to get the addQueryString parameters. Defaults to an empty string which results in using GeneralUtility::_GET(). Possible values are

‪'' -> uses GeneralUtility::_GET()
‪'0' -> uses GeneralUtility::_GET()
‪'GET' -> uses GeneralUtility::_GET()
‪'<any>' -> uses parse_str(GeneralUtility::getIndpEnv('QUERY_STRING')) (<any> refers to literally everything else than previously mentioned values)

Parameters

string $addQueryStringMethod

Returns: ‪static the current UriBuilder to allow method chaining

See also: ‪https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Functions/Typolink.html#addquerystring

Definition at line 342 of file UriBuilder.php.

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

◆ setArgumentPrefix()

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

static

Specifies the prefix to be used for all arguments.

Parameters

string $argumentPrefix

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 394 of file UriBuilder.php.

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

◆ setArguments()

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

static

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: ‪static the current UriBuilder to allow method chaining

Definition at line 191 of file UriBuilder.php.

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

◆ setArgumentsToBeExcludedFromQueryString()

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

static

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

Parameters

array $argumentsToBeExcludedFromQueryString

Returns: ‪static the current UriBuilder to allow method chaining

See also: ‪https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/Functions/Typolink.html#addquerystring; ‪setAddQueryString()

Definition at line 373 of file UriBuilder.php.

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

◆ setCreateAbsoluteUri()

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

static

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

Parameters

bool $createAbsoluteUri

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 254 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()

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

static

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

Parameters

string $format

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 233 of file UriBuilder.php.

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

◆ setLanguage()

UriBuilder TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::setLanguage ( ?string $language )

Enforces a URI / link to a page to a specific language (or use "current")

Parameters

string | null $language

Returns: ‪UriBuilder

Definition at line 295 of file UriBuilder.php.

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

◆ setLinkAccessRestrictedPages()

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

static

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

Parameters

bool $linkAccessRestrictedPages

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 415 of file UriBuilder.php.

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

◆ setNoCache()

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

static

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

Parameters

bool $noCache

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 480 of file UriBuilder.php.

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

◆ setRequest()

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

static

Sets the current request

Parameters

Request $request

Returns: ‪static the current UriBuilder to allow method chaining

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

Definition at line 168 of file UriBuilder.php.

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

Referenced by TYPO3\CMS\Extensionmanager\Controller\AbstractModuleController\generateMenu(), TYPO3\CMS\IndexedSearch\Controller\AdministrationController\generateMenu(), TYPO3\CMS\Extensionmanager\Controller\AbstractModuleController\getHref(), and TYPO3\CMS\IndexedSearch\Controller\AdministrationController\getHref().

◆ setSection()

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

static

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

Parameters

string $section

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 212 of file UriBuilder.php.

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

◆ setTargetPageType()

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

static

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

Parameters

int $targetPageType

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 459 of file UriBuilder.php.

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

◆ setTargetPageUid()

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

static

Uid of the target page

Parameters

int $targetPageUid

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 436 of file UriBuilder.php.

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

◆ setUseCacheHash()

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

static

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

Returns: ‪static the current UriBuilder to allow method chaining

Definition at line 501 of file UriBuilder.php.

◆ uriFor()

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

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

Parameters

string \| null	$actionName	‪Name of the action to be called
array \| null	$controllerArguments	‪Additional query parameters. Will be "namespaced" and merged with $this->arguments.
string \| null	$controllerName	‪Name of the target controller. If not set, current ControllerName is used.
string \| null	$extensionName	‪Name of the target extension, without underscores. If not set, current ExtensionName is used.
string \| null	$pluginName	‪Name of the target plugin. If not set, current PluginName is used.

Returns: ‪string the rendered URI

See also: ‪build()

Definition at line 570 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 78 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 82 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 86 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 null TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$argumentPrefix

protected

Definition at line 118 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 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\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 90 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 42 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 52 of file UriBuilder.php.

◆ $createAbsoluteUri

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

protected

Definition at line 74 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 122 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 46 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 114 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().

◆ $language

string TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$language

protected

Definition at line 106 of file UriBuilder.php.

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

◆ $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 66 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 94 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 110 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 null TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$request

protected

Definition at line 56 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 70 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 102 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 null TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder::$targetPageUid

protected

Definition at line 98 of file UriBuilder.php.

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ build()

◆ buildBackendUri()

◆ buildFrontendUri()

◆ buildTypolinkConfiguration()

◆ convertDomainObjectsToIdentityArrays()

◆ convertIteratorToArray()

◆ convertTransientObjectToArray()

◆ getAbsoluteUriScheme()

◆ getAddQueryString()

◆ getAddQueryStringMethod()

◆ getArgumentPrefix()

◆ getArguments()

◆ getArgumentsToBeExcludedFromQueryString()

◆ getCreateAbsoluteUri()

◆ getFormat()

◆ getLanguage()

◆ getLastArguments()

◆ getLinkAccessRestrictedPages()

◆ getNoCache()

◆ getRequest()

◆ getSection()

◆ getTargetPageType()

◆ getTargetPageUid()

◆ getUseCacheHash()

◆ initializeObject()

◆ injectConfigurationManager()

◆ injectEnvironmentService()

◆ injectExtensionService()

◆ removeDefaultControllerAndAction()

◆ reset()

◆ setAbsoluteUriScheme()

◆ setAddQueryString()

◆ setAddQueryStringMethod()

◆ setArgumentPrefix()

◆ setArguments()

◆ setArgumentsToBeExcludedFromQueryString()

◆ setCreateAbsoluteUri()

◆ setFormat()

◆ setLanguage()

◆ setLinkAccessRestrictedPages()

◆ setNoCache()

◆ setRequest()

◆ setSection()

◆ setTargetPageType()

◆ setTargetPageUid()

◆ setUseCacheHash()

◆ uriFor()

Member Data Documentation

◆ $absoluteUriScheme

◆ $addQueryString

◆ $addQueryStringMethod

◆ $argumentPrefix

◆ $arguments

◆ $argumentsToBeExcludedFromQueryString

◆ $configurationManager

◆ $contentObject

◆ $createAbsoluteUri

◆ $environmentService

◆ $extensionService

◆ $format

◆ $language

◆ $lastArguments

◆ $linkAccessRestrictedPages

◆ $noCache

◆ $request

◆ $section

◆ $targetPageType

◆ $targetPageUid