CSWhiteboardMergedItemList
in package
This class creates and returns an array of CSWhiteboardMergedItem objects of planned and placed referenced Item(s) lists, e.g for INDD or WBD files in the proof reader or PPM InDesign Editor.
Tags
Table of Contents
- __construct() : mixed
- CSWhiteboardMergedItemList constructor.
- acceptChanges() : array<string|int, mixed>
- This method is used to copy all the attributes of a placed Item into the planned Item
- createPlannedFromPlaced() : CSCometItemApiReference|null
- This method is used to create a planned Item out of a placed Item
- getItems() : array<string|int, CSWhiteboardMergedItem>
- Returns an array with all merged CSWhiteboardMergedItem(s) of planned and placed list includes items that have to be deleted or placed
- getItemsToDelete() : array<string|int, mixed>
- Returns an array with all CSWhiteboardMergedItem(s) that have to be deleted (they have no match in the planned list)
- getItemsToPlace() : array<string|int, mixed>
- Returns an array with all CSWhiteboardMergedItem(s) that have to be placed (they have no match in the placed list)
- getMergeItemByID() : mixed
- getMergeItemByPlacedID() : array<string|int, mixed>
- This method is used to get an item from the mergeItemArray by placedID
- getMergeItemByPlannedID() : array<string|int, mixed>
- This method is used to get an item from the mergeItemArray by plannedID
- getPlacedItemForPlannedItemID() : CSCometItemApiReference
- Returns the placed CSCometItemApiReference for a given ID of a planned CSCometItemApiReference
- getPlannedItemForPlacedItemID() : CSCometItemApiReference
- Returns the planned CSCometItemApiReference for a given ID of a placed CSCometItemApiReference
- getState() : mixed
- markAsPlaced() : mixed
- This method is used to copy all the attributes of a Planned Item into the Placed Item and thus, marking the Planned Item as Placed
Methods
__construct()
CSWhiteboardMergedItemList constructor.
public
__construct(CSMamWhiteboardDocumentFile $document) : mixed
Parameters
- $document : CSMamWhiteboardDocumentFile
Tags
Return values
mixed —acceptChanges()
This method is used to copy all the attributes of a placed Item into the planned Item
public
acceptChanges(int $placedReferenceID) : array<string|int, mixed>
Parameters
- $placedReferenceID : int
Tags
Return values
array<string|int, mixed> —createPlannedFromPlaced()
This method is used to create a planned Item out of a placed Item
public
createPlannedFromPlaced(int $placedReferenceID, CSCometItemApiReference $placedReference, CSCometItemTemplate $template) : CSCometItemApiReference|null
Parameters
- $placedReferenceID : int
- $placedReference : CSCometItemApiReference
- $template : CSCometItemTemplate
Tags
Return values
CSCometItemApiReference|null —getItems()
Returns an array with all merged CSWhiteboardMergedItem(s) of planned and placed list includes items that have to be deleted or placed
public
getItems() : array<string|int, CSWhiteboardMergedItem>
Tags
Return values
array<string|int, CSWhiteboardMergedItem> —array of merge items
getItemsToDelete()
Returns an array with all CSWhiteboardMergedItem(s) that have to be deleted (they have no match in the planned list)
public
getItemsToDelete() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of CSWhiteboardMergedItem
getItemsToPlace()
Returns an array with all CSWhiteboardMergedItem(s) that have to be placed (they have no match in the placed list)
public
getItemsToPlace() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —of CSWhiteboardMergedItem
getMergeItemByID()
public
getMergeItemByID(mixed $id) : mixed
Parameters
- $id : mixed
Tags
Return values
mixed —getMergeItemByPlacedID()
This method is used to get an item from the mergeItemArray by placedID
public
getMergeItemByPlacedID(int $placedID) : array<string|int, mixed>
Parameters
- $placedID : int
Tags
Return values
array<string|int, mixed> —mergeListItem
getMergeItemByPlannedID()
This method is used to get an item from the mergeItemArray by plannedID
public
getMergeItemByPlannedID(int $plannedID) : array<string|int, mixed>
Parameters
- $plannedID : int
Tags
Return values
array<string|int, mixed> —mergeListItem
getPlacedItemForPlannedItemID()
Returns the placed CSCometItemApiReference for a given ID of a planned CSCometItemApiReference
public
getPlacedItemForPlannedItemID(int $plannedReferenceID) : CSCometItemApiReference
Parameters
- $plannedReferenceID : int
Tags
Return values
CSCometItemApiReference —object
getPlannedItemForPlacedItemID()
Returns the planned CSCometItemApiReference for a given ID of a placed CSCometItemApiReference
public
getPlannedItemForPlacedItemID(int $placedReferenceID) : CSCometItemApiReference
Parameters
- $placedReferenceID : int
Tags
Return values
CSCometItemApiReference —object
getState()
public
getState(mixed $refID) : mixed
Parameters
- $refID : mixed
Tags
Return values
mixed —markAsPlaced()
This method is used to copy all the attributes of a Planned Item into the Placed Item and thus, marking the Planned Item as Placed
public
markAsPlaced(int $plannedReferenceID, int $cometGroupID) : mixed
Parameters
- $plannedReferenceID : int
- $cometGroupID : int