TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent Class Reference

Inheritance diagram for TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent:

Public Member Functions
	__construct (string $tableName, int $uid, ?UriInterface $previewUri, array $contextData)
	stop ()
	isPropagationStopped ()
UriInterface null	getPreviewUri ()
	setPreviewUri (UriInterface $previewUri)
string	getTableName ()
int	getUid ()
array	getContextData ()

Private Attributes
string	$tableName
int	$uid
UriInterface null	$previewUri
array	$contextData
bool	$stopped = false

Detailed Description

Used to generate or adjust preview URLs being shown in workspaces backend module.

Definition at line 26 of file RetrievedPreviewUrlEvent.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::__construct	(	string	$tableName,
		int	$uid,
		?UriInterface	$previewUri,
		array	$contextData
	)

Definition at line 48 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$contextData, TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$previewUri, TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$tableName, and TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$uid.

Member Function Documentation

getContextData()

array TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getContextData

(

)

Returns

‪array

Definition at line 101 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$contextData.

getPreviewUri()

UriInterface null TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getPreviewUri

(

)

Returns

‪UriInterface|null

Definition at line 69 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$previewUri.

getTableName()

string TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getTableName

(

)

Returns

‪string

Definition at line 85 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$tableName.

getUid()

int TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::getUid

(

)

Returns

‪int

Definition at line 93 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$uid.

isPropagationStopped()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::isPropagationStopped

(

)

Definition at line 61 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$stopped.

setPreviewUri()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::setPreviewUri

(

UriInterface

$previewUri

)

Parameters

UriInterface

$previewUri

Definition at line 77 of file RetrievedPreviewUrlEvent.php.

References TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\$previewUri.

stop()

TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::stop

(

)

Definition at line 56 of file RetrievedPreviewUrlEvent.php.

Member Data Documentation

$contextData

array TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::$contextData

private

Definition at line 42 of file RetrievedPreviewUrlEvent.php.

Referenced by TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\__construct(), and TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\getContextData().

$previewUri

UriInterface null TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::$previewUri

private

Definition at line 38 of file RetrievedPreviewUrlEvent.php.

Referenced by TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\__construct(), TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\getPreviewUri(), and TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\setPreviewUri().

$stopped

bool TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::$stopped = false

private

Definition at line 46 of file RetrievedPreviewUrlEvent.php.

Referenced by TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\isPropagationStopped().

$tableName

string TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::$tableName

private

Definition at line 30 of file RetrievedPreviewUrlEvent.php.

Referenced by TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\__construct(), and TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\getTableName().

$uid

int TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent::$uid

private

Definition at line 34 of file RetrievedPreviewUrlEvent.php.

Referenced by TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\__construct(), and TYPO3\CMS\Workspaces\Event\RetrievedPreviewUrlEvent\getUid().