IsReferenceConsideredForDependencyEvent

final class \TYPO3\CMS\Workspaces\Event\IsReferenceConsideredForDependencyEvent

Event dispatched per sys_refindex row when evaluating workspace dependencies. Listeners decide whether a given reference constitutes a structural workspace dependency.

References are opt-in: isDependency defaults to false and listeners must explicitly mark relevant references as dependencies.

Table of Contents

Methods

__construct()  : mixed
getAction()  : DependencyCollectionAction
getDirection()  : DependencyLookupDirection
Whether the reference is followed to collect children of the record owning the field, or parents of the referenced record.
getFieldName()  : string
getFlexPointer()  : string
Path of the FlexForm field the reference originates from (sys_refindex.flexpointer), empty if the reference does not originate from a FlexForm.
getRecordId()  : int
getReferenceId()  : int
getReferenceTable()  : string
getSoftReferenceId()  : string
Identifier of the soft reference in the field value (sys_refindex.softref_id), empty if the reference is no soft reference.
getSoftReferenceKey()  : string
Key of the soft reference parser that found the reference (sys_refindex.softref_key), empty if the reference is no soft reference.
getTableName()  : string
getWorkspaceId()  : int
isDependency()  : bool
isSoftReference()  : bool
setDependency()  : void

Methods

__construct()

public __construct(string $tableName, int $recordId, string $fieldName, string $referenceTable, int $referenceId, DependencyCollectionAction $action, int $workspaceId[, string $flexPointer = '' ][, string $softReferenceKey = '' ][, string $softReferenceId = '' ][, DependencyLookupDirection $direction = DependencyLookupDirection::Children ]) : mixed

Parameters

$tableName : string
$recordId : int
$fieldName : string
$referenceTable : string
$referenceId : int
$action : DependencyCollectionAction
$workspaceId : int
$flexPointer : string = ''
$softReferenceKey : string = ''
$softReferenceId : string = ''
$direction : DependencyLookupDirection = DependencyLookupDirection::Children

getFieldName()

public getFieldName() : string

Return values

string

getFlexPointer()

Path of the FlexForm field the reference originates from (sys_refindex.flexpointer), empty if the reference does not originate from a FlexForm.

public getFlexPointer() : string

Return values

string

getRecordId()

public getRecordId() : int

Return values

int

getReferenceId()

public getReferenceId() : int

Return values

int

getReferenceTable()

public getReferenceTable() : string

Return values

string

getSoftReferenceId()

Identifier of the soft reference in the field value (sys_refindex.softref_id), empty if the reference is no soft reference.

public getSoftReferenceId() : string

Return values

string

getSoftReferenceKey()

Key of the soft reference parser that found the reference (sys_refindex.softref_key), empty if the reference is no soft reference.

public getSoftReferenceKey() : string

Return values

string

getTableName()

public getTableName() : string

Return values

string

getWorkspaceId()

public getWorkspaceId() : int

Return values

int

isDependency()

public isDependency() : bool

Return values

bool

isSoftReference()

public isSoftReference() : bool

Return values

bool

setDependency()

public setDependency(bool $isDependency) : void

Parameters

$isDependency : bool
On this page