CSCometPage
extends CSIcmPage
in package
Represents a Comet Page
Tags
Table of Contents
- storePlaceholders() : bool
- stores the placeholders inside the page
- updatePlaceholders() : bool
- updates the placeholders inside the page
Methods
storePlaceholders()
stores the placeholders inside the page
public
storePlaceholders([array<string|int, mixed> $placeholderIDs = array() ], int $recordID, int $shareID) : bool
Parameters
- $placeholderIDs : array<string|int, mixed> = array()
-
a list of placeholder ids that should be stored
- $recordID : int
-
if set, only placeholder referencing the corresponding record are stored
- $shareID : int
-
if the $recordID is set also the $shareID must be passed
Tags
Return values
bool —true on sccess otherwise false
updatePlaceholders()
updates the placeholders inside the page
public
updatePlaceholders([array<string|int, mixed> $placeholderIDs = array() ][, mixed $textUpdateType = CSComet::COMET_TEXT_UPDATE_TYPE_TO_VALUE ]) : bool
Parameters
- $placeholderIDs : array<string|int, mixed> = array()
-
a list of placeholder ids that should be updated
- $textUpdateType : mixed = CSComet::COMET_TEXT_UPDATE_TYPE_TO_VALUE
Tags
Return values
bool —true on sccess otherwise false
