‪TYPO3CMS  10.4
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Workspaces\Domain\Record\StageRecord Class Reference
Inheritance diagram for TYPO3\CMS\Workspaces\Domain\Record\StageRecord:
TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord

Public Member Functions

 __construct (WorkspaceRecord $workspace, array $record)
 
WorkspaceRecord getWorkspace ()
 
StageRecord null getPrevious ()
 
StageRecord null getNext ()
 
int determineOrder (StageRecord $stageRecord)
 
bool isPreviousTo (StageRecord $stageRecord)
 
bool isNextTo (StageRecord $stageRecord)
 
string getDefaultComment ()
 
 setInternal ($internal=true)
 
bool isInternal ()
 
bool isEditStage ()
 
bool isPublishStage ()
 
bool isExecuteStage ()
 
bool isDialogEnabled ()
 
bool isPreselectionChangeable ()
 
bool areOwnersPreselected ()
 
bool areMembersPreselected ()
 
bool areEditorsPreselected ()
 
bool areResponsiblePersonsPreselected ()
 
bool hasDefaultRecipients ()
 
bool hasPreselection ()
 
array getResponsiblePersons ()
 
array getDefaultRecipients ()
 
array getAllRecipients ()
 
int[] getPreselectedRecipients ()
 
bool isAllowed ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord
 __construct (array $record)
 
string __toString ()
 
int getUid ()
 
string getTitle ()
 

Static Public Member Functions

static StageRecord get ($uid, array $record=null)
 
static StageRecord build (WorkspaceRecord $workspace, $uid, array $record=null)
 

Protected Attributes

WorkspaceRecord $workspace
 
bool $internal = false
 
array $responsiblePersons
 
array $defaultRecipients
 
array $preselectedRecipients
 
array $allRecipients
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord
array $record
 

Additional Inherited Members

- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord
StagesService getStagesService ()
 
- ‪Static Protected Member Functions inherited from ‪TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord
static fetch ($tableName, $uid)
 
static TYPO3 CMS Core Authentication BackendUserAuthentication getBackendUser ()
 
static TYPO3 CMS Core Localization LanguageService getLanguageService ()
 

Detailed Description

Combined record class

Definition at line 23 of file StageRecord.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Workspaces\Domain\Record\StageRecord::__construct ( WorkspaceRecord  $workspace,
array  $record 
)
Parameters
WorkspaceRecord$workspace
array$record

Definition at line 80 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\$record, and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$workspace.

Member Function Documentation

◆ areEditorsPreselected()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::areEditorsPreselected ( )
Returns
‪bool

Definition at line 251 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Service\StagesService\getPreselectedRecipients(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\hasPreselection().

◆ areMembersPreselected()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::areMembersPreselected ( )
Returns
‪bool

Definition at line 243 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getAllRecipients(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPreselectedRecipients(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\hasPreselection().

◆ areOwnersPreselected()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::areOwnersPreselected ( )
Returns
‪bool

Definition at line 235 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getAllRecipients(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPreselectedRecipients(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\hasPreselection().

◆ areResponsiblePersonsPreselected()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::areResponsiblePersonsPreselected ( )
Returns
‪bool

Definition at line 259 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPreselectedRecipients(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\hasPreselection().

◆ build()

static StageRecord TYPO3\CMS\Workspaces\Domain\Record\StageRecord::build ( WorkspaceRecord  $workspace,
  $uid,
array  $record = null 
)
static
Parameters
WorkspaceRecord$workspace
int$uid
array$record
Returns
‪StageRecord

Definition at line 68 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\$record, and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$workspace.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\createInternalStage(), and TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\getStages().

◆ determineOrder()

int TYPO3\CMS\Workspaces\Domain\Record\StageRecord::determineOrder ( StageRecord  $stageRecord)
Parameters
StageRecord$stageRecord
Returns
‪int

Definition at line 114 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isEditStage(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isExecuteStage().

Referenced by TYPO3\CMS\Workspaces\Service\StagesService\getStagesForWSUser().

◆ get()

static StageRecord TYPO3\CMS\Workspaces\Domain\Record\StageRecord::get (   $uid,
array  $record = null 
)
static
Parameters
int$uid
array$record
Returns
‪StageRecord

Definition at line 54 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\$record, TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\get(), and TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\getStage().

◆ getAllRecipients()

array TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getAllRecipients ( )

Gets all recipients (backend user ids).

Returns
‪array

Definition at line 316 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$allRecipients, TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areMembersPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areOwnersPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getDefaultRecipients(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getResponsiblePersons(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getWorkspace(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isInternal().

Referenced by TYPO3\CMS\Workspaces\Service\StagesService\getResponsibleBeUser().

◆ getDefaultComment()

string TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getDefaultComment ( )
Returns
‪string

Definition at line 167 of file StageRecord.php.

◆ getDefaultRecipients()

array TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getDefaultRecipients ( )
Returns
‪array

Definition at line 303 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$defaultRecipients, TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getStagesService(), and TYPO3\CMS\Workspaces\Service\StagesService\resolveBackendUserIds().

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getAllRecipients(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPreselectedRecipients().

◆ getNext()

StageRecord null TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getNext ( )
Returns
‪StageRecord|null

Definition at line 105 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\getNextStage(), TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getWorkspace().

Referenced by TYPO3\CMS\Workspaces\Service\StagesService\getStagesForWSUser().

◆ getPreselectedRecipients()

int [] TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getPreselectedRecipients ( )
Returns
‪int[]

Definition at line 340 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$preselectedRecipients, TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areMembersPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areOwnersPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areResponsiblePersonsPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getDefaultRecipients(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getResponsiblePersons(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getWorkspace().

Referenced by TYPO3\CMS\Workspaces\Service\StagesService\getPreselectedRecipients(), and TYPO3\CMS\Workspaces\Controller\Remote\ActionHandler\getRecipientsOfStage().

◆ getPrevious()

StageRecord null TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getPrevious ( )
Returns
‪StageRecord|null

Definition at line 97 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\getPreviousStage(), TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getWorkspace().

Referenced by TYPO3\CMS\Workspaces\Service\StagesService\getStagesForWSUser().

◆ getResponsiblePersons()

array TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getResponsiblePersons ( )
Returns
‪array

Definition at line 289 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$responsiblePersons, TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getStagesService(), and TYPO3\CMS\Workspaces\Service\StagesService\resolveBackendUserIds().

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getAllRecipients(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPreselectedRecipients().

◆ getWorkspace()

WorkspaceRecord TYPO3\CMS\Workspaces\Domain\Record\StageRecord::getWorkspace ( )
Returns
‪WorkspaceRecord

Definition at line 89 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$workspace.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getAllRecipients(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getNext(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPreselectedRecipients(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPrevious().

◆ hasDefaultRecipients()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::hasDefaultRecipients ( )
Returns
‪bool

Definition at line 267 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\hasPreselection().

◆ hasPreselection()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::hasPreselection ( )
Returns
‪bool

Definition at line 275 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areEditorsPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areMembersPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areOwnersPreselected(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areResponsiblePersonsPreselected(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\hasDefaultRecipients().

◆ isAllowed()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isAllowed ( )
Returns
‪bool

Definition at line 364 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isEditStage(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isExecuteStage().

◆ isDialogEnabled()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isDialogEnabled ( )
Returns
‪bool

Definition at line 219 of file StageRecord.php.

◆ isEditStage()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isEditStage ( )
Returns
‪bool

Definition at line 195 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid(), and TYPO3\CMS\Workspaces\Service\StagesService\STAGE_EDIT_ID.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\determineOrder(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isAllowed().

◆ isExecuteStage()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isExecuteStage ( )
Returns
‪bool

Definition at line 211 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid(), and TYPO3\CMS\Workspaces\Service\StagesService\STAGE_PUBLISH_EXECUTE_ID.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\determineOrder(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isAllowed().

◆ isInternal()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isInternal ( )
Returns
‪bool

Definition at line 187 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$internal.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getAllRecipients().

◆ isNextTo()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isNextTo ( StageRecord  $stageRecord)

Determines whether $this is in a later stage compared to $stageRecord.

Parameters
StageRecord$stageRecord
Returns
‪bool

Definition at line 152 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid().

◆ isPreselectionChangeable()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isPreselectionChangeable ( )
Returns
‪bool

Definition at line 227 of file StageRecord.php.

◆ isPreviousTo()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isPreviousTo ( StageRecord  $stageRecord)

Determines whether $this is in a previous stage compared to $stageRecord.

Parameters
StageRecord$stageRecord
Returns
‪bool

Definition at line 134 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid().

◆ isPublishStage()

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::isPublishStage ( )
Returns
‪bool

Definition at line 203 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\getUid(), and TYPO3\CMS\Workspaces\Service\StagesService\STAGE_PUBLISH_ID.

◆ setInternal()

TYPO3\CMS\Workspaces\Domain\Record\StageRecord::setInternal (   $internal = true)
Parameters
bool$internal

Definition at line 179 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\StageRecord\$internal.

Member Data Documentation

◆ $allRecipients

array TYPO3\CMS\Workspaces\Domain\Record\StageRecord::$allRecipients
protected

Definition at line 47 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getAllRecipients().

◆ $defaultRecipients

array TYPO3\CMS\Workspaces\Domain\Record\StageRecord::$defaultRecipients
protected

Definition at line 39 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getDefaultRecipients().

◆ $internal

bool TYPO3\CMS\Workspaces\Domain\Record\StageRecord::$internal = false
protected

Definition at line 31 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\isInternal(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\setInternal().

◆ $preselectedRecipients

array TYPO3\CMS\Workspaces\Domain\Record\StageRecord::$preselectedRecipients
protected

Definition at line 43 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getPreselectedRecipients().

◆ $responsiblePersons

array TYPO3\CMS\Workspaces\Domain\Record\StageRecord::$responsiblePersons
protected

Definition at line 35 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getResponsiblePersons().

◆ $workspace

WorkspaceRecord TYPO3\CMS\Workspaces\Domain\Record\StageRecord::$workspace
protected

Definition at line 27 of file StageRecord.php.

Referenced by TYPO3\CMS\Workspaces\Domain\Record\StageRecord\__construct(), TYPO3\CMS\Workspaces\Domain\Record\StageRecord\build(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\getWorkspace().