TYPO3\CMS\Frontend\Typolink\LinkResult Class Reference

Inheritance diagram for TYPO3\CMS\Frontend\Typolink\LinkResult:

Public Member Functions
	__construct (string $type, string $url)
	getUrl ()
	getType ()
	getTarget ()
	withTarget (string $target)
	withLinkConfiguration (array $configuration)
	withLinkText (string $linkText)
	getLinkText ()
	withAttributes (array $additionalAttributes, bool $resetExistingAttributes=false)
	withAttribute (string $attributeName, ?string $attributeValue)
	jsonSerialize ()
	hasAttribute (string $attributeName)
	getAttribute (string $attributeName)
	getAttributes ()
	__toString ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
‪Public Member Functions inherited from ‪TYPO3\CMS\Frontend\Typolink\LinkResultInterface
	getLinkConfiguration ()

Public Attributes
array< string, function getLinkConfiguration():array { return $this->	linkConfiguration

Protected Attributes
string	$type = LinkService::TYPE_UNKNOWN
string	$url
string	$target = ''
array	$additionalAttributes = []
string	$linkText = null
array	$linkConfiguration = []

Detailed Description

This class represents a created link to a resource (page, email etc), coming from linkService and after it was executed by the LinkBuilders (mostly in Frontend) after it is called from Typolink.

Definition at line 26 of file LinkResult.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Frontend\Typolink\LinkResult::__construct	(	string	$type,
		string	$url
	)

Definition at line 35 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$type, and TYPO3\CMS\Frontend\Typolink\LinkResult\$url.

Member Function Documentation

__toString()

TYPO3\CMS\Frontend\Typolink\LinkResult::__toString

(

)

Definition at line 189 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\jsonSerialize().

getAttribute()

TYPO3\CMS\Frontend\Typolink\LinkResult::getAttribute

(

string

$attributeName

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 166 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$target, and TYPO3\CMS\Frontend\Typolink\LinkResult\$url.

getAttributes()

TYPO3\CMS\Frontend\Typolink\LinkResult::getAttributes

(

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 177 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$target, and TYPO3\CMS\Frontend\Typolink\LinkResult\$url.

getLinkText()

TYPO3\CMS\Frontend\Typolink\LinkResult::getLinkText

(

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 85 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$linkText.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\offsetGet().

getTarget()

TYPO3\CMS\Frontend\Typolink\LinkResult::getTarget

(

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 51 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$target.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\offsetGet().

getType()

TYPO3\CMS\Frontend\Typolink\LinkResult::getType

(

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 46 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$type.

getUrl()

TYPO3\CMS\Frontend\Typolink\LinkResult::getUrl

(

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 41 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$url.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\offsetGet().

hasAttribute()

TYPO3\CMS\Frontend\Typolink\LinkResult::hasAttribute

(

string

$attributeName

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 155 of file LinkResult.php.

jsonSerialize()

TYPO3\CMS\Frontend\Typolink\LinkResult::jsonSerialize

(

)

Definition at line 136 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$additionalAttributes.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\__toString().

offsetExists()

TYPO3\CMS\Frontend\Typolink\LinkResult::offsetExists

(

$offset

)

Kept for legacy reasons, will be removed in TYPO3 v12.0. This is built because the LinkBuilders now return an object instead an array with three items.

Definition at line 203 of file LinkResult.php.

offsetGet()

TYPO3\CMS\Frontend\Typolink\LinkResult::offsetGet

(

$offset

)

Definition at line 222 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\getLinkText(), TYPO3\CMS\Frontend\Typolink\LinkResult\getTarget(), and TYPO3\CMS\Frontend\Typolink\LinkResult\getUrl().

offsetSet()

TYPO3\CMS\Frontend\Typolink\LinkResult::offsetSet	(		$offset,
			$value
	)

Definition at line 241 of file LinkResult.php.

offsetUnset()

TYPO3\CMS\Frontend\Typolink\LinkResult::offsetUnset

(

$offset

)

Definition at line 263 of file LinkResult.php.

withAttribute()

TYPO3\CMS\Frontend\Typolink\LinkResult::withAttribute	(	string	$attributeName,
		?string	$attributeValue
	)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 116 of file LinkResult.php.

withAttributes()

TYPO3\CMS\Frontend\Typolink\LinkResult::withAttributes	(	array	$additionalAttributes,
		bool	$resetExistingAttributes = false
	)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 90 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$additionalAttributes.

withLinkConfiguration()

TYPO3\CMS\Frontend\Typolink\LinkResult::withLinkConfiguration

(

array

$configuration

)

Definition at line 71 of file LinkResult.php.

withLinkText()

TYPO3\CMS\Frontend\Typolink\LinkResult::withLinkText

(

string

$linkText

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 78 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$linkText.

withTarget()

TYPO3\CMS\Frontend\Typolink\LinkResult::withTarget

(

string

$target

)

Implements TYPO3\CMS\Frontend\Typolink\LinkResultInterface.

Definition at line 56 of file LinkResult.php.

References TYPO3\CMS\Frontend\Typolink\LinkResult\$target.

Member Data Documentation

$additionalAttributes

array TYPO3\CMS\Frontend\Typolink\LinkResult::$additionalAttributes = []

protected

Definition at line 31 of file LinkResult.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\jsonSerialize(), and TYPO3\CMS\Frontend\Typolink\LinkResult\withAttributes().

$linkConfiguration

array TYPO3\CMS\Frontend\Typolink\LinkResult::$linkConfiguration = []

protected

Definition at line 33 of file LinkResult.php.

$linkText

string TYPO3\CMS\Frontend\Typolink\LinkResult::$linkText = null

protected

Definition at line 32 of file LinkResult.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\getLinkText(), and TYPO3\CMS\Frontend\Typolink\LinkResult\withLinkText().

$target

string TYPO3\CMS\Frontend\Typolink\LinkResult::$target = ''

protected

Definition at line 30 of file LinkResult.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\getAttribute(), TYPO3\CMS\Frontend\Typolink\LinkResult\getAttributes(), TYPO3\CMS\Frontend\Typolink\LinkResult\getTarget(), and TYPO3\CMS\Frontend\Typolink\LinkResult\withTarget().

$type

string TYPO3\CMS\Frontend\Typolink\LinkResult::$type = LinkService::TYPE_UNKNOWN

protected

Definition at line 28 of file LinkResult.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\__construct(), and TYPO3\CMS\Frontend\Typolink\LinkResult\getType().

$url

string TYPO3\CMS\Frontend\Typolink\LinkResult::$url

protected

Definition at line 29 of file LinkResult.php.

Referenced by TYPO3\CMS\Frontend\Typolink\LinkResult\__construct(), TYPO3\CMS\Frontend\Typolink\LinkResult\getAttribute(), TYPO3\CMS\Frontend\Typolink\LinkResult\getAttributes(), and TYPO3\CMS\Frontend\Typolink\LinkResult\getUrl().

linkConfiguration

array<string, function getLinkConfiguration(): array { return $this-> TYPO3\CMS\Frontend\Typolink\LinkResult::linkConfiguration

Returns

‪array<string, string>

Definition at line 68 of file LinkResult.php.