Contentserv PHP API

CSCometDocument extends CSIcmDocument
in package

Tags

Table of Contents

__construct()  : mixed
adapt()  : bool
Calls the Comet priint:adjust adapt method to resize a document
callCometMethod()  : mixed
getCometGroups()  : array<string|int, CSCometGroup>
getIndesignType()  : mixed
getPageTemplates()  : mixed
getType()  : mixed
importNotes()  : bool
Imports CS Notes into the document
login()  : mixed
placeTemplate()  : mixed
placeTemplates()  : array<string|int, mixed>
This method builds a document with given products and templates
setCometPageTemplate()  : mixed
setPageSettings()  : mixed
Applies page settings
storePlaceholders()  : bool
stores placeholders back to the CONTENTSERV database
updatePlaceholders()  : bool
updates the placeholders in the document

Methods

__construct()

public __construct([mixed $documentID = null ][, mixed $quickMode = false ][, mixed $sessionContext = CSICM_SESSCTX_USER ]) : mixed
Parameters
$documentID : mixed = null
$quickMode : mixed = false
$sessionContext : mixed = CSICM_SESSCTX_USER
Tags
Return values
mixed —

adapt()

Calls the Comet priint:adjust adapt method to resize a document

public adapt(int $width, int $height) : bool
Parameters
$width : int

Width of the resized document in mm

$height : int

Height of the resized document in mm

Tags
access

public

Return values
bool —

true on sccess otherwise false

callCometMethod()

public callCometMethod(mixed $method) : mixed
Parameters
$method : mixed
Tags
Return values
mixed —

getCometGroups()

public getCometGroups(int $parentID[, string $scope = CSCOMET_SCOPE_DOCUMENT ]) : array<string|int, CSCometGroup>
Parameters
$parentID : int
$scope : string = CSCOMET_SCOPE_DOCUMENT
Tags
Return values
array<string|int, CSCometGroup> —

getIndesignType()

public getIndesignType() : mixed
Tags
Return values
mixed —

getPageTemplates()

public getPageTemplates() : mixed
Tags
Return values
mixed —

importNotes()

Imports CS Notes into the document

public importNotes() : bool
Tags
throws
CSIcmException
access

public

Return values
bool —

true on sccess otherwise false

placeTemplate()

public placeTemplate(mixed $templateID, mixed $productID, mixed $shareID, mixed $pageIndex, mixed $left, mixed $top, mixed $referenceID) : mixed
Parameters
$templateID : mixed
$productID : mixed
$shareID : mixed
$pageIndex : mixed
$left : mixed
$top : mixed
$referenceID : mixed
Tags
Return values
mixed —

placeTemplates()

This method builds a document with given products and templates

public placeTemplates(array<string|int, mixed> $aItemIds, mixed $mItemTemplateIds, mixed $mShareIds, array<string|int, mixed>|int $mPageIndexes[, array<string|int, mixed> $aReferenceIds = array() ]) : array<string|int, mixed>
Parameters
$aItemIds : array<string|int, mixed>

A list of product ids that should be placed into the document.

$mItemTemplateIds : mixed

A single product template id or a list of template ids that should be used to place the products.

$mShareIds : mixed

A single share id or a list of share ids which should be used to place the products.

$mPageIndexes : array<string|int, mixed>|int

A single page index or a list of page indexes of the page where the page flow for every item should start with.

$aReferenceIds : array<string|int, mixed> = array()

List of references that should be updated after the build process is done

Tags
access

public

Return values
array<string|int, mixed> —

The changed resulting from the document building.

setCometPageTemplate()

public setCometPageTemplate(mixed $pageID, mixed $templateID) : mixed
Parameters
$pageID : mixed
$templateID : mixed
Tags
Return values
mixed —

setPageSettings()

Applies page settings

public setPageSettings(int $pageID, array<string|int, mixed> $settings) : mixed
Parameters
$pageID : int

the id of the page the settings should be applied to

$settings : array<string|int, mixed>

key-value pairs of the settings to apply

Tags
access

public

Return values
mixed —

storePlaceholders()

stores placeholders back to the CONTENTSERV database

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
throws
CSIcmException
access

public

Return values
bool —

true on success otherwise false

updatePlaceholders()

updates the placeholders in the document

public updatePlaceholders([array<string|int, mixed> $placeholderIDs = array() ][, int $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 : int = CSComet::COMET_TEXT_UPDATE_TYPE_TO_VALUE

One of the COMET_TEXT_* constants

Tags
throws
CSIcmException
access

public

Return values
bool —

true on success otherwise false


        

        
    




    

    

                

    

        

            
Search results