TYPO3 CMS  TYPO3_7-6
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)
 
 getWorkspace ()
 
 getPrevious ()
 
 getNext ()
 
 determineOrder (StageRecord $stageRecord)
 
 isPreviousTo (StageRecord $stageRecord)
 
 isNextTo (StageRecord $stageRecord)
 
 getDefaultComment ()
 
 setInternal ($internal=true)
 
 isInternal ()
 
 isEditStage ()
 
 isPublishStage ()
 
 isExecuteStage ()
 
 isDialogEnabled ()
 
 isPreselectionChangeable ()
 
 areOwnersPreselected ()
 
 areMembersPreselected ()
 
 areEditorsPreselected ()
 
 areResponsiblePersonsPreselected ()
 
 hasPreselection ()
 
 getResponsiblePersons ()
 
 getDefaultRecipients ()
 
 getAllRecipients ()
 
 getPreselectedRecipients ()
 
 isAllowed ()
 
- Public Member Functions inherited from TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord
 __construct (array $record)
 
 __toString ()
 
 getUid ()
 
 getTitle ()
 

Static Public Member Functions

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

Protected Attributes

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

Additional Inherited Members

- Protected Member Functions inherited from TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord
 getStagesService ()
 
- Static Protected Member Functions inherited from TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord
static fetch ($tableName, $uid)
 
static getDatabaseConnection ()
 
static getBackendUser ()
 
static getLanguageService ()
 

Detailed Description

Combined record class

Definition at line 21 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 84 of file StageRecord.php.

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

Member Function Documentation

◆ areEditorsPreselected()

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

Definition at line 253 of file StageRecord.php.

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

◆ areMembersPreselected()

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

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

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

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

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

Definition at line 261 of file StageRecord.php.

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

◆ build()

static 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 72 of file StageRecord.php.

References TYPO3\CMS\Workspaces\Domain\Record\AbstractRecord\$record, $uid, 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()

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

Definition at line 118 of file StageRecord.php.

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

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

◆ get()

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

Definition at line 58 of file StageRecord.php.

References $uid, and TYPO3\CMS\Workspaces\Domain\Record\WorkspaceRecord\get().

◆ getAllRecipients()

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

Gets all recipients (backend user ids).

Returns
array

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

◆ getDefaultComment()

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

Definition at line 169 of file StageRecord.php.

◆ getDefaultRecipients()

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

Definition at line 296 of file StageRecord.php.

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

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

◆ getNext()

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

Definition at line 109 of file StageRecord.php.

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

◆ getPreselectedRecipients()

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

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

◆ getPrevious()

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

Definition at line 101 of file StageRecord.php.

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

◆ getResponsiblePersons()

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

Definition at line 282 of file StageRecord.php.

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

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

◆ getWorkspace()

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

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

◆ hasPreselection()

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

Definition at line 269 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(), and TYPO3\CMS\Workspaces\Domain\Record\StageRecord\areResponsiblePersonsPreselected().

◆ isAllowed()

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

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

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

Definition at line 221 of file StageRecord.php.

◆ isEditStage()

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

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

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

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

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

Definition at line 189 of file StageRecord.php.

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

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

◆ isNextTo()

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 154 of file StageRecord.php.

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

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

◆ isPreselectionChangeable()

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

Definition at line 229 of file StageRecord.php.

◆ isPreviousTo()

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 136 of file StageRecord.php.

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

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

◆ isPublishStage()

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

Definition at line 205 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 181 of file StageRecord.php.

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

Member Data Documentation

◆ $allRecipients

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

Definition at line 51 of file StageRecord.php.

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

◆ $defaultRecipients

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

Definition at line 41 of file StageRecord.php.

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

◆ $internal

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

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

Definition at line 46 of file StageRecord.php.

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

◆ $responsiblePersons

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

Definition at line 36 of file StageRecord.php.

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

◆ $workspace

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

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