CSComet
extends CSItemApi
in package
Tags
Table of Contents
- COMET_TEXT_LINK_TYPE_ALWAYS = 0
- COMET_TEXT_LINK_TYPE_DEFAULT = -1
- COMET_TEXT_LINK_TYPE_NEVER = 2
- COMET_TEXT_LINK_TYPE_ONCHECKIN = 1
- COMET_TEXT_UPDATE_TYPE_DUMMY_TO_VALUE = 2
- COMET_TEXT_UPDATE_TYPE_NOTHING = 3
- COMET_TEXT_UPDATE_TYPE_TO_DUMMY = 1
- COMET_TEXT_UPDATE_TYPE_TO_VALUE = 0
- ENVIRONMENT_COMET = 'comet'
- ENVIRONMENT_CS = 'cs'
- ITEMCLASS_ITEM = 'item'
- PLACEHOLDER_ATTRIBUTE_NAME_AUTHOR = 1000000004
- PLACEHOLDER_ATTRIBUTE_NAME_CREATIONDATE = 1000000006
- PLACEHOLDER_ATTRIBUTE_NAME_EXTERNALKEY = 1000000002
- PLACEHOLDER_ATTRIBUTE_NAME_IMAGE = 1002000003
- PLACEHOLDER_ATTRIBUTE_NAME_LABEL = 1000000001
- PLACEHOLDER_ATTRIBUTE_NAME_LASTCHANGE = 1000000005
- PLACEHOLDER_ATTRIBUTE_NAME_LASTEDITOR = 1000000003
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_AUTHOR = 1000002012
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_CREATIONDATE = 1000002015
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_DOCUMENTPLANNEDPAGENAME = 1000002018
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_EXTERNALKEY = 1000002004
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILECREATIONDATE = 1000002006
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILEMODIFICATIONDATE = 1000002005
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILENAME = 1000002001
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILESIZE = 1000002007
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILETYPE = 1000002002
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGECOLORSPACE = 1000002011
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGEHEIGHT = 1000002009
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGERESOULTION = 1000002010
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGEWIDTH = 1000002008
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_LABEL = 1000002000
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_LASTCHANGE = 1000002014
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_LASTEDITOR = 1000002013
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_MAMFILECONFIGURATIONID = 1000002017
- PLACEHOLDER_ATTRIBUTE_NAME_MAM_MAMFILEID = 1000002016
- PLACEHOLDER_ATTRIBUTE_NAME_PDMARTICLEID = 1000000007
- PLACEHOLDER_ATTRIBUTE_NAME_USER_BIRTHDAY = 1000001024
- PLACEHOLDER_ATTRIBUTE_NAME_USER_CITY = 1000001012
- PLACEHOLDER_ATTRIBUTE_NAME_USER_CITYPRIV = 1000001020
- PLACEHOLDER_ATTRIBUTE_NAME_USER_COMPANYNAME = 1000001027
- PLACEHOLDER_ATTRIBUTE_NAME_USER_COUNTRY = 1000001014
- PLACEHOLDER_ATTRIBUTE_NAME_USER_COUNTRYPRIV = 1000001023
- PLACEHOLDER_ATTRIBUTE_NAME_USER_DEPARTMENT = 1000001025
- PLACEHOLDER_ATTRIBUTE_NAME_USER_EMAIL = 1000001006
- PLACEHOLDER_ATTRIBUTE_NAME_USER_EMAILPRIV = 1000001015
- PLACEHOLDER_ATTRIBUTE_NAME_USER_EXTERNALKEY = 1000001001
- PLACEHOLDER_ATTRIBUTE_NAME_USER_FAXCOMP = 1000001009
- PLACEHOLDER_ATTRIBUTE_NAME_USER_FAXPRIV = 1000001018
- PLACEHOLDER_ATTRIBUTE_NAME_USER_FIRSTNAME = 1000001003
- PLACEHOLDER_ATTRIBUTE_NAME_USER_LANGUAGE = 1000001005
- PLACEHOLDER_ATTRIBUTE_NAME_USER_LASTNAME = 1000001004
- PLACEHOLDER_ATTRIBUTE_NAME_USER_MOBILE = 1000001007
- PLACEHOLDER_ATTRIBUTE_NAME_USER_MOBILEPRIV = 1000001016
- PLACEHOLDER_ATTRIBUTE_NAME_USER_NAME = 1000001002
- PLACEHOLDER_ATTRIBUTE_NAME_USER_NOTE = 1000001032
- PLACEHOLDER_ATTRIBUTE_NAME_USER_POSITION = 1000001026
- PLACEHOLDER_ATTRIBUTE_NAME_USER_POSTALCODE = 1000001011
- PLACEHOLDER_ATTRIBUTE_NAME_USER_POSTALCODEPRIV = 1000001021
- PLACEHOLDER_ATTRIBUTE_NAME_USER_SEX = 1000001030
- PLACEHOLDER_ATTRIBUTE_NAME_USER_STATE = 1000001013
- PLACEHOLDER_ATTRIBUTE_NAME_USER_STATEPRIV = 1000001022
- PLACEHOLDER_ATTRIBUTE_NAME_USER_STREET = 1000001010
- PLACEHOLDER_ATTRIBUTE_NAME_USER_STREETPRIV = 1000001019
- PLACEHOLDER_ATTRIBUTE_NAME_USER_TELEPHONECOMP = 1000001008
- PLACEHOLDER_ATTRIBUTE_NAME_USER_TELEPHONEPRIV = 1000001017
- PLACEHOLDER_ATTRIBUTE_NAME_USER_TITLE = 1000001029
- PLACEHOLDER_ATTRIBUTE_NAME_USER_TYPE = 1000001028
- PLACEHOLDER_ATTRIBUTE_NAME_USER_USERPICTURE = 1000001031
- PLACEHOLDER_TYPE_IMAGEFRAME = 'imageframe'
- PLACEHOLDER_TYPE_PLAINTEXT = 'plaintext'
- PLACEHOLDER_TYPE_TABLE = 'table'
- PLACEHOLDER_TYPE_TEXT = 'text'
- PLACEHOLDER_TYPE_TEXTFRAME = 'textframe'
- PLACESTATE_BASE_CHANGED = 0x2000000
- PLACESTATE_BASE_DELETED = 0x3000000
- PLACESTATE_BASE_PLACED = 0x1000000
- PLACESTATE_BASE_UNPLACED = 0x0
- PLACESTATE_CHANGED = 0x2000000
- PLACESTATE_CHANGED_ITEM = 0x2000008
- PLACESTATE_CHANGED_ITEMPAGE = 0x200000c
- PLACESTATE_CHANGED_ITEMPAGETEMPLATE = 0x200000e
- PLACESTATE_CHANGED_ITEMTEMPLATE = 0x200000a
- PLACESTATE_CHANGED_PAGE = 0x2000004
- PLACESTATE_CHANGED_PAGETEMPLATE = 0x2000006
- PLACESTATE_CHANGED_TEMPLATE = 0x2000002
- PLACESTATE_DELETED = 0x3000000
- PLACESTATE_DELETED_RECYCLED = 0x3000010
- PLACESTATE_FLAG_ITEM = 0x8
- PLACESTATE_FLAG_NONE = 0x0
- PLACESTATE_FLAG_PAGE = 0x4
- PLACESTATE_FLAG_POSITION = 0x1
- PLACESTATE_FLAG_RECYCLE = 0x10
- PLACESTATE_FLAG_TEMPLATE = 0x2
- PLACESTATE_MASK_BASE = 0xff000000
- PLACESTATE_MASK_FLAGS = 0xffffff
- PLACESTATE_PLACED = 0x1000000
- PLACESTATE_UNPLACED = 0x0
- PLACESTATE_UNPLACED_POSITIONED = 0x1
- PREFIX_TRANSLATE_PLACESTATES = 'COMET_GUI_EDIT_COMET_PLACESTATE_'
- REFATTR_CLASS = 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_CLASS'
- REFATTR_CONFIG = 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_CONFIG'
- REFATTR_FIELD_COMETGROUP = 'PDM_GUI_EDIT_ATTRIBUTE_COMETGROUP_LABEL'
- REFATTR_FIELD_GROSSAREA = 'PDM_GUI_EDIT_ATTRIBUTE_GROSSAREA_LABEL'
- REFATTR_FIELD_HEIGHT = 'PDM_GUI_EDIT_ATTRIBUTE_HEIGHT_LABEL'
- REFATTR_FIELD_NETAREA = 'PDM_GUI_EDIT_ATTRIBUTE_NETAREA_LABEL'
- REFATTR_FIELD_NOTES = 'PDM_GUI_EDIT_ATTRIBUTE_NOTES_LABEL'
- REFATTR_FIELD_PAGE = 'PDM_GUI_EDIT_ATTRIBUTE_PAGE_LABEL'
- REFATTR_FIELD_PLACESTATE = 'PDM_GUI_EDIT_ATTRIBUTE_PLACESTATE_LABEL'
- REFATTR_FIELD_POSITION_LEFT = 'PDM_GUI_EDIT_ATTRIBUTE_POSITION_LEFT_LABEL'
- REFATTR_FIELD_POSITION_TOP = 'PDM_GUI_EDIT_ATTRIBUTE_POSITION_TOP_LABEL'
- REFATTR_FIELD_SHARE = 'PDM_GUI_EDIT_ATTRIBUTE_SHARE_LABEL'
- REFATTR_FIELD_TEMPLATE = 'PDM_GUI_EDIT_ATTRIBUTE_TEMPLATE_LABEL'
- REFATTR_FIELD_WIDTH = 'PDM_GUI_EDIT_ATTRIBUTE_WIDTH_LABEL'
- REFATTR_FIELD_ZLEVEL = 'PDM_GUI_EDIT_ATTRIBUTE_ZLEVEL_LABEL'
- REFATTR_PLACED_CLASS = 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLACED_CLASS'
- REFATTR_PLACED_CONFIG = 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLACED_CONFIG'
- REFATTR_PLANNED_CLASS = 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLANNED_CLASS'
- REFATTR_PLANNED_CONFIG = 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLANNED_CONFIG'
- SYNCACTION_ADD = 0x3
- SYNCACTION_DELETE = 0x4
- SYNCACTION_MODIFY = 0x1
- TEMPLATE_PAGE_FIRST = 0
- TEMPLATE_PAGE_UNASSIGNED = ''
- TEMPLATE_SOURCE_INHERIT = ''
- TEMPLATE_SOURCE_UNASSIGNED = 0
- $ENUM_SORTALGOS_FORMATTED : mixed
- $ENUM_SORTTYPES_DESC : mixed
- $tableApiClass : string
- $tableRowApiClass : string
- __construct() : mixed
- addStateFlag() : int
- Combines a base placement state with optional placement state flags into a single placement state.
- clearStateFlag() : int
- Clears one or more optional attribute flags in a given placement state.
- commitFile() : mixed
- createDocument() : mixed
- createNewFile() : CSMamFile
- creates a new mam file in the folder with the specified id, with the specified file name and the specified content
- createPdfForContent() : CSMamFile
- Stores a PDF File for an Indd File
- createVariant() : mixed
- debug() : mixed
- deleteVariant() : mixed
- escapeNoteText() : mixed
- escapes text by replacing tagged text special characters and encode it with html entities the following tagged text characters are escaped: < => \< > => \> \ => \\
- getApiFieldForExternalKey() : CSItemApiField
- Returns a specific field of an item or an empty Api Field when the key is null, empty or invalid
- getApiItem() : mixed
- getClassName() : mixed
- getColorFromIndex() : mixed
- getColorMappings() : mixed
- getCometDocumentStatus() : mixed
- getCometOS() : mixed
- getCometPlaceholderTypeForField() : string
- This method returns for a given field the corresponding placeholder type as it is known on the comet side.
- getComparator() : CSItemComparator
- Creates a comparator object that can be used with the CSGuiItemComparatorTable
- getDataFolder() : mixed
- getDocument() : mixed
- getDocumentContextFolder() : mixed
- getDocumentLinkTypes() : mixed
- getDocumentSubFolder() : mixed
- getDocumentVariantsFolder() : mixed
- getErrorMessage() : mixed
- getImageLinkTypes() : array<string|int, mixed>
- Sample Description
- getInstance() : mixed
- getItemTemplate() : CSCometItemTemplate
- getItemTemplates() : array<string|int, CSCometItemTemplate>
- getItemTemplateTypes() : array<string|int, mixed>
- Returns the list of project-specific product template types that an administrator defined in the PPM Comet Connector settings.
- getMasterOfVariant() : mixed
- getNotesXml() : mixed
- getPageTemplate() : mixed
- getPageTemplatePreview() : mixed
- getPageTemplates() : mixed
- getPageTypeForPageSide() : int|null
- Returns the comet page type value for the passed indesign page side constant
- getPageTypeLabel() : mixed
- getPlaceholderType() : string
- Retrieves the Placeholder Type
- getPlacementStateIcon() : string
- Returns the placement state icon for a given placement state and item class.
- getPlacementStates() : array<string|int, mixed>
- Returns the placement states that are available for a given item class.
- getRecordClassNameByCometClassId() : null|string
- Delivers the target records class id based on a given comet class id
- getSearchableApiFields() : mixed
- Returns an array with CSItemApiField matching the searchable condition in the given sort order and limit If $returnSimpleSearchables and $returnExtendedSearchables are set to false all fields are returned which are not searchable Otherwise the fields are returned matching at least one of the set criterias.
- getSharepoint() : mixed
- getSharepoints() : array<string|int, CSCometSharepoint>
- getSketchNotesXML() : string
- Get the XML for sketch notes(comments)
- getStateBase() : int
- Returns the BASE portion of a placement state, which is the most significant part for the placement process flow.
- getStateFlags() : int
- Returns the FLAGS portion of a placement state, which signals additional state features.
- getStateFlagsArray() : array<string|int, mixed>
- Returns the FLAGS portion of a placement state, which signals additional state features.
- getStateName() : string
- Returns the name (CS dictionary key) for a given placement state.
- getTextLinkTypes() : mixed
- getValueGetter() : CSItemValueGetter
- Returns a new CSItemValueGetter object
- getValueSetter() : CSItemValueSetter
- Returns a new CSItemValueSetter object
- getValuesGetter() : CSItemValuesGetter
- Returns a new CSItemValuesGetter object
- getValuesSetter() : CSItemValuesSetter
- Returns a new CSItemValuesSetter object
- getVariants() : mixed
- getWorkflowOptions() : mixed
- handleCometResult() : mixed
- hasStateFlag() : bool
- Tests if specific attribute flags are set in a given placement state.
- html2tagged() : mixed
- isVariant() : mixed
- limitAllowedHtmlTags() : mixed
- Limits all tags which are allowed in the formatted value result of any item This can e.g. be used for media neutral exports where not all html tags are supported
- logRequest() : mixed
- mmToPt() : mixed
- ptToMM() : mixed
- setCometOS() : mixed
- setMetaDataFromExif() : void
- Extracts the metadata and thumbs from the indesign file and writes it to the MAM file
- setMetaDataFromSpreadsXmlAndExif() : void
- Writes the metadata of the comet spreads.xml to the metadata of the InDesign MamFile in Contentserv.
- setNotesXml() : void
- grabs the notes.xml supplied by the comet client and synchronize the contained comments with the CS database
- synchronizeItemTemplates() : array<string|int, mixed>
- Parses the project-specific product template XML configuration file and synchronizes the contained templates with the CS database.
- synchronizePageTemplates() : array<string|int, mixed>
- Parses the project-specific page template XML configuration file and synchronizes the contained templates with the CS database.
- updateServerInstances() : mixed
- useVariantAsMaster() : mixed
- writeConnectionsFile() : mixed
Constants
COMET_TEXT_LINK_TYPE_ALWAYS
public
mixed
COMET_TEXT_LINK_TYPE_ALWAYS
= 0
Tags
COMET_TEXT_LINK_TYPE_DEFAULT
public
mixed
COMET_TEXT_LINK_TYPE_DEFAULT
= -1
Tags
COMET_TEXT_LINK_TYPE_NEVER
public
mixed
COMET_TEXT_LINK_TYPE_NEVER
= 2
Tags
COMET_TEXT_LINK_TYPE_ONCHECKIN
public
mixed
COMET_TEXT_LINK_TYPE_ONCHECKIN
= 1
Tags
COMET_TEXT_UPDATE_TYPE_DUMMY_TO_VALUE
public
mixed
COMET_TEXT_UPDATE_TYPE_DUMMY_TO_VALUE
= 2
Tags
COMET_TEXT_UPDATE_TYPE_NOTHING
public
mixed
COMET_TEXT_UPDATE_TYPE_NOTHING
= 3
Tags
COMET_TEXT_UPDATE_TYPE_TO_DUMMY
public
mixed
COMET_TEXT_UPDATE_TYPE_TO_DUMMY
= 1
Tags
COMET_TEXT_UPDATE_TYPE_TO_VALUE
public
mixed
COMET_TEXT_UPDATE_TYPE_TO_VALUE
= 0
Tags
ENVIRONMENT_COMET
public
mixed
ENVIRONMENT_COMET
= 'comet'
Tags
ENVIRONMENT_CS
public
mixed
ENVIRONMENT_CS
= 'cs'
Tags
ITEMCLASS_ITEM
public
mixed
ITEMCLASS_ITEM
= 'item'
Tags
PLACEHOLDER_ATTRIBUTE_NAME_AUTHOR
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_AUTHOR
= 1000000004
Tags
PLACEHOLDER_ATTRIBUTE_NAME_CREATIONDATE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_CREATIONDATE
= 1000000006
Tags
PLACEHOLDER_ATTRIBUTE_NAME_EXTERNALKEY
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_EXTERNALKEY
= 1000000002
Tags
PLACEHOLDER_ATTRIBUTE_NAME_IMAGE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_IMAGE
= 1002000003
Tags
PLACEHOLDER_ATTRIBUTE_NAME_LABEL
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_LABEL
= 1000000001
Tags
PLACEHOLDER_ATTRIBUTE_NAME_LASTCHANGE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_LASTCHANGE
= 1000000005
Tags
PLACEHOLDER_ATTRIBUTE_NAME_LASTEDITOR
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_LASTEDITOR
= 1000000003
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_AUTHOR
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_AUTHOR
= 1000002012
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_CREATIONDATE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_CREATIONDATE
= 1000002015
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_DOCUMENTPLANNEDPAGENAME
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_DOCUMENTPLANNEDPAGENAME
= 1000002018
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_EXTERNALKEY
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_EXTERNALKEY
= 1000002004
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILECREATIONDATE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILECREATIONDATE
= 1000002006
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILEMODIFICATIONDATE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILEMODIFICATIONDATE
= 1000002005
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILENAME
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILENAME
= 1000002001
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILESIZE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILESIZE
= 1000002007
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILETYPE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_FILETYPE
= 1000002002
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGECOLORSPACE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGECOLORSPACE
= 1000002011
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGEHEIGHT
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGEHEIGHT
= 1000002009
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGERESOULTION
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGERESOULTION
= 1000002010
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGEWIDTH
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_IMAGEWIDTH
= 1000002008
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_LABEL
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_LABEL
= 1000002000
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_LASTCHANGE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_LASTCHANGE
= 1000002014
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_LASTEDITOR
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_LASTEDITOR
= 1000002013
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_MAMFILECONFIGURATIONID
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_MAMFILECONFIGURATIONID
= 1000002017
Tags
PLACEHOLDER_ATTRIBUTE_NAME_MAM_MAMFILEID
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_MAM_MAMFILEID
= 1000002016
Tags
PLACEHOLDER_ATTRIBUTE_NAME_PDMARTICLEID
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_PDMARTICLEID
= 1000000007
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_BIRTHDAY
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_BIRTHDAY
= 1000001024
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_CITY
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_CITY
= 1000001012
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_CITYPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_CITYPRIV
= 1000001020
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_COMPANYNAME
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_COMPANYNAME
= 1000001027
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_COUNTRY
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_COUNTRY
= 1000001014
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_COUNTRYPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_COUNTRYPRIV
= 1000001023
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_DEPARTMENT
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_DEPARTMENT
= 1000001025
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_EMAIL
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_EMAIL
= 1000001006
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_EMAILPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_EMAILPRIV
= 1000001015
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_EXTERNALKEY
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_EXTERNALKEY
= 1000001001
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_FAXCOMP
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_FAXCOMP
= 1000001009
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_FAXPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_FAXPRIV
= 1000001018
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_FIRSTNAME
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_FIRSTNAME
= 1000001003
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_LANGUAGE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_LANGUAGE
= 1000001005
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_LASTNAME
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_LASTNAME
= 1000001004
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_MOBILE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_MOBILE
= 1000001007
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_MOBILEPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_MOBILEPRIV
= 1000001016
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_NAME
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_NAME
= 1000001002
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_NOTE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_NOTE
= 1000001032
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_POSITION
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_POSITION
= 1000001026
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_POSTALCODE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_POSTALCODE
= 1000001011
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_POSTALCODEPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_POSTALCODEPRIV
= 1000001021
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_SEX
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_SEX
= 1000001030
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_STATE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_STATE
= 1000001013
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_STATEPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_STATEPRIV
= 1000001022
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_STREET
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_STREET
= 1000001010
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_STREETPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_STREETPRIV
= 1000001019
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_TELEPHONECOMP
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_TELEPHONECOMP
= 1000001008
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_TELEPHONEPRIV
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_TELEPHONEPRIV
= 1000001017
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_TITLE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_TITLE
= 1000001029
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_TYPE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_TYPE
= 1000001028
Tags
PLACEHOLDER_ATTRIBUTE_NAME_USER_USERPICTURE
public
mixed
PLACEHOLDER_ATTRIBUTE_NAME_USER_USERPICTURE
= 1000001031
Tags
PLACEHOLDER_TYPE_IMAGEFRAME
public
mixed
PLACEHOLDER_TYPE_IMAGEFRAME
= 'imageframe'
Tags
PLACEHOLDER_TYPE_PLAINTEXT
public
mixed
PLACEHOLDER_TYPE_PLAINTEXT
= 'plaintext'
Tags
PLACEHOLDER_TYPE_TABLE
public
mixed
PLACEHOLDER_TYPE_TABLE
= 'table'
Tags
PLACEHOLDER_TYPE_TEXT
public
mixed
PLACEHOLDER_TYPE_TEXT
= 'text'
Tags
PLACEHOLDER_TYPE_TEXTFRAME
public
mixed
PLACEHOLDER_TYPE_TEXTFRAME
= 'textframe'
Tags
PLACESTATE_BASE_CHANGED
public
mixed
PLACESTATE_BASE_CHANGED
= 0x2000000
Tags
PLACESTATE_BASE_DELETED
public
mixed
PLACESTATE_BASE_DELETED
= 0x3000000
Tags
PLACESTATE_BASE_PLACED
public
mixed
PLACESTATE_BASE_PLACED
= 0x1000000
Tags
PLACESTATE_BASE_UNPLACED
public
mixed
PLACESTATE_BASE_UNPLACED
= 0x0
Tags
PLACESTATE_CHANGED
public
mixed
PLACESTATE_CHANGED
= 0x2000000
Tags
PLACESTATE_CHANGED_ITEM
public
mixed
PLACESTATE_CHANGED_ITEM
= 0x2000008
Tags
PLACESTATE_CHANGED_ITEMPAGE
public
mixed
PLACESTATE_CHANGED_ITEMPAGE
= 0x200000c
Tags
PLACESTATE_CHANGED_ITEMPAGETEMPLATE
public
mixed
PLACESTATE_CHANGED_ITEMPAGETEMPLATE
= 0x200000e
Tags
PLACESTATE_CHANGED_ITEMTEMPLATE
public
mixed
PLACESTATE_CHANGED_ITEMTEMPLATE
= 0x200000a
Tags
PLACESTATE_CHANGED_PAGE
public
mixed
PLACESTATE_CHANGED_PAGE
= 0x2000004
Tags
PLACESTATE_CHANGED_PAGETEMPLATE
public
mixed
PLACESTATE_CHANGED_PAGETEMPLATE
= 0x2000006
Tags
PLACESTATE_CHANGED_TEMPLATE
public
mixed
PLACESTATE_CHANGED_TEMPLATE
= 0x2000002
Tags
PLACESTATE_DELETED
public
mixed
PLACESTATE_DELETED
= 0x3000000
Tags
PLACESTATE_DELETED_RECYCLED
public
mixed
PLACESTATE_DELETED_RECYCLED
= 0x3000010
Tags
PLACESTATE_FLAG_ITEM
public
mixed
PLACESTATE_FLAG_ITEM
= 0x8
Tags
PLACESTATE_FLAG_NONE
public
mixed
PLACESTATE_FLAG_NONE
= 0x0
Tags
PLACESTATE_FLAG_PAGE
public
mixed
PLACESTATE_FLAG_PAGE
= 0x4
Tags
PLACESTATE_FLAG_POSITION
public
mixed
PLACESTATE_FLAG_POSITION
= 0x1
Tags
PLACESTATE_FLAG_RECYCLE
public
mixed
PLACESTATE_FLAG_RECYCLE
= 0x10
Tags
PLACESTATE_FLAG_TEMPLATE
public
mixed
PLACESTATE_FLAG_TEMPLATE
= 0x2
Tags
PLACESTATE_MASK_BASE
public
mixed
PLACESTATE_MASK_BASE
= 0xff000000
Tags
PLACESTATE_MASK_FLAGS
public
mixed
PLACESTATE_MASK_FLAGS
= 0xffffff
Tags
PLACESTATE_PLACED
public
mixed
PLACESTATE_PLACED
= 0x1000000
Tags
PLACESTATE_UNPLACED
public
mixed
PLACESTATE_UNPLACED
= 0x0
Tags
PLACESTATE_UNPLACED_POSITIONED
public
mixed
PLACESTATE_UNPLACED_POSITIONED
= 0x1
Tags
PREFIX_TRANSLATE_PLACESTATES
public
mixed
PREFIX_TRANSLATE_PLACESTATES
= 'COMET_GUI_EDIT_COMET_PLACESTATE_'
Tags
REFATTR_CLASS
public
mixed
REFATTR_CLASS
= 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_CLASS'
Tags
REFATTR_CONFIG
public
mixed
REFATTR_CONFIG
= 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_CONFIG'
Tags
REFATTR_FIELD_COMETGROUP
public
mixed
REFATTR_FIELD_COMETGROUP
= 'PDM_GUI_EDIT_ATTRIBUTE_COMETGROUP_LABEL'
Tags
REFATTR_FIELD_GROSSAREA
public
mixed
REFATTR_FIELD_GROSSAREA
= 'PDM_GUI_EDIT_ATTRIBUTE_GROSSAREA_LABEL'
Tags
REFATTR_FIELD_HEIGHT
public
mixed
REFATTR_FIELD_HEIGHT
= 'PDM_GUI_EDIT_ATTRIBUTE_HEIGHT_LABEL'
Tags
REFATTR_FIELD_NETAREA
public
mixed
REFATTR_FIELD_NETAREA
= 'PDM_GUI_EDIT_ATTRIBUTE_NETAREA_LABEL'
Tags
REFATTR_FIELD_NOTES
public
mixed
REFATTR_FIELD_NOTES
= 'PDM_GUI_EDIT_ATTRIBUTE_NOTES_LABEL'
Tags
REFATTR_FIELD_PAGE
public
mixed
REFATTR_FIELD_PAGE
= 'PDM_GUI_EDIT_ATTRIBUTE_PAGE_LABEL'
Tags
REFATTR_FIELD_PLACESTATE
public
mixed
REFATTR_FIELD_PLACESTATE
= 'PDM_GUI_EDIT_ATTRIBUTE_PLACESTATE_LABEL'
Tags
REFATTR_FIELD_POSITION_LEFT
public
mixed
REFATTR_FIELD_POSITION_LEFT
= 'PDM_GUI_EDIT_ATTRIBUTE_POSITION_LEFT_LABEL'
Tags
REFATTR_FIELD_POSITION_TOP
public
mixed
REFATTR_FIELD_POSITION_TOP
= 'PDM_GUI_EDIT_ATTRIBUTE_POSITION_TOP_LABEL'
Tags
REFATTR_FIELD_SHARE
public
mixed
REFATTR_FIELD_SHARE
= 'PDM_GUI_EDIT_ATTRIBUTE_SHARE_LABEL'
Tags
REFATTR_FIELD_TEMPLATE
public
mixed
REFATTR_FIELD_TEMPLATE
= 'PDM_GUI_EDIT_ATTRIBUTE_TEMPLATE_LABEL'
Tags
REFATTR_FIELD_WIDTH
public
mixed
REFATTR_FIELD_WIDTH
= 'PDM_GUI_EDIT_ATTRIBUTE_WIDTH_LABEL'
Tags
REFATTR_FIELD_ZLEVEL
public
mixed
REFATTR_FIELD_ZLEVEL
= 'PDM_GUI_EDIT_ATTRIBUTE_ZLEVEL_LABEL'
Tags
REFATTR_PLACED_CLASS
public
mixed
REFATTR_PLACED_CLASS
= 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLACED_CLASS'
Tags
REFATTR_PLACED_CONFIG
public
mixed
REFATTR_PLACED_CONFIG
= 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLACED_CONFIG'
Tags
REFATTR_PLANNED_CLASS
public
mixed
REFATTR_PLANNED_CLASS
= 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLANNED_CLASS'
Tags
REFATTR_PLANNED_CONFIG
public
mixed
REFATTR_PLANNED_CONFIG
= 'PDM_GUI_TREE_NODE_PRODUCT_REFERENCES_PLANNED_CONFIG'
Tags
SYNCACTION_ADD
public
mixed
SYNCACTION_ADD
= 0x3
Tags
SYNCACTION_DELETE
public
mixed
SYNCACTION_DELETE
= 0x4
Tags
SYNCACTION_MODIFY
public
mixed
SYNCACTION_MODIFY
= 0x1
Tags
TEMPLATE_PAGE_FIRST
public
mixed
TEMPLATE_PAGE_FIRST
= 0
Tags
TEMPLATE_PAGE_UNASSIGNED
public
mixed
TEMPLATE_PAGE_UNASSIGNED
= ''
Tags
TEMPLATE_SOURCE_INHERIT
public
mixed
TEMPLATE_SOURCE_INHERIT
= ''
Tags
TEMPLATE_SOURCE_UNASSIGNED
public
mixed
TEMPLATE_SOURCE_UNASSIGNED
= 0
Tags
Properties
$ENUM_SORTALGOS_FORMATTED
public
static mixed
$ENUM_SORTALGOS_FORMATTED
= array(\CS_SORT_FORMATTED_ASC => 'GUI_EDIT_SORT_FORMATTED_ASC', \CS_SORT_FORMATTED_DESC => 'GUI_EDIT_SORT_FORMATTED_DESC')
Tags
$ENUM_SORTTYPES_DESC
public
static mixed
$ENUM_SORTTYPES_DESC
= array(\CS_SORT_NUMERICAL_DESC => 'GUI_EDIT_SORT_NUMERICAL_DESC', \CS_SORT_CASE_STRING_DESC => 'GUI_EDIT_SORT_CASE_STRING_DES', \CS_SORT_FORMATTED_DESC => 'GUI_EDIT_SORT_FORMATTED_DESC', \CS_SORT_STRING_DESC => 'GUI_EDIT_SORT_STRING_DESC', \CS_SORT_DATE_DESC => 'GUI_EDIT_SORT_DATE_DESC', \CS_SORT_DEFAULT_DESC => 'GUI_EDIT_SORT_DEFAULT_DESC')
Tags
$tableApiClass
public
string
$tableApiClass
Tags
$tableRowApiClass
public
string
$tableRowApiClass
Tags
Methods
__construct()
public
__construct([mixed $itemClass = 'CometPageTemplate' ]) : mixed
Parameters
- $itemClass : mixed = 'CometPageTemplate'
Tags
Return values
mixed —addStateFlag()
Combines a base placement state with optional placement state flags into a single placement state.
public
static addStateFlag(int $iPlacementStateBase[, int $iPlacementStateFlags = self::PLACESTATE_FLAG_NONE ][, string $sItemClass = self::ITEMCLASS_ITEM ]) : int
This method can also be used to add further placement state flags to an already assembled state value.
Parameters
- $iPlacementStateBase : int
-
The base placement state, describing the most significant part of the placement status. This should be one of the CSComet::PLACESTATE_BASE_* or CSComet::PLACESTATE_* constants.
- $iPlacementStateFlags : int = self::PLACESTATE_FLAG_NONE
-
An integer value, describing the flag(s) will be OR'ed to the existing $iPlacementStateBase. This should be one of the CSComet::PLACESTATE_FLAG_* constant or an additive/OR'ed combination of them. If this parameter is omitted, no flags will be added -- in this case, only the state validity check is performed.
- $sItemClass : string = self::ITEMCLASS_ITEM
-
Not used at the moment. Reserved for future use. The item class to which the resulting placement state should belong (e.g. PdmArticle, MamFile, ...) or a general 'item' class CSComet::ITEMCLASS_ITEM
Tags
Return values
int —The combined placement state.
clearStateFlag()
Clears one or more optional attribute flags in a given placement state.
public
static clearStateFlag(int $iPlacementState[, int $iPlacementStateFlags = self::PLACESTATE_MASK_FLAGS ][, string $sItemClass = self::ITEMCLASS_ITEM ]) : int
Parameters
- $iPlacementState : int
-
The placement state to be modified, which should correspond to one of the CSComet::PLACESTATE_* constants.
- $iPlacementStateFlags : int = self::PLACESTATE_MASK_FLAGS
-
An integer value, describing the flag(s) to be cleared in the existing $iPlacementState. This should be one of the CSComet::PLACESTATE_FLAG_* constants or an additive/OR'ed combination of them. If this parameter is omitted, all flags will be cleared (this is equivalent to the {@see getStateBase() method).
- $sItemClass : string = self::ITEMCLASS_ITEM
-
Not used at the moment. Reserved for future use. The item class to which the resulting placement state should belong (e.g. PdmArticle, MamFile, ...) or a general 'item' class CSComet::ITEMCLASS_ITEM
Tags
Return values
int —The combined placement state.
commitFile()
public
static commitFile(mixed $FileID, mixed $content[, mixed $keepLocked = false ][, mixed $bSynchronize = false ]) : mixed
Parameters
- $FileID : mixed
- $content : mixed
- $keepLocked : mixed = false
- $bSynchronize : mixed = false
Tags
Return values
mixed —createDocument()
public
static createDocument(mixed $mamPath, mixed $templateFileID[, mixed $sessionContext = CSCOMET_SESSCTX_USER ]) : mixed
Parameters
- $mamPath : mixed
- $templateFileID : mixed
- $sessionContext : mixed = CSCOMET_SESSCTX_USER
Tags
Return values
mixed —createNewFile()
creates a new mam file in the folder with the specified id, with the specified file name and the specified content
public
static createNewFile(int $iFolderID, string $sFileName, string $sContent) : CSMamFile
Parameters
- $iFolderID : int
-
the folder id of the folder where the new file should be created
- $sFileName : string
-
the file name of the new file
- $sContent : string
-
the content that should be set for the file
Tags
Return values
CSMamFile —the new created mam file
createPdfForContent()
Stores a PDF File for an Indd File
public
static createPdfForContent(int $FileID, string $sContent) : CSMamFile
Parameters
- $FileID : int
-
the ID of the MAM File to be updated
- $sContent : string
-
the file content for the PDF file
Tags
Return values
CSMamFile —createVariant()
public
static createVariant(mixed $FileID[, mixed $content = null ]) : mixed
Parameters
- $FileID : mixed
- $content : mixed = null
Tags
Return values
mixed —debug()
public
static debug(mixed $content, mixed $type) : mixed
Parameters
- $content : mixed
- $type : mixed
Tags
Return values
mixed —deleteVariant()
public
static deleteVariant(mixed $FileID) : mixed
Parameters
- $FileID : mixed
Tags
Return values
mixed —escapeNoteText()
escapes text by replacing tagged text special characters and encode it with html entities the following tagged text characters are escaped: < => \< > => \> \ => \\
public
static escapeNoteText(string $sNoteText) : mixed
Parameters
- $sNoteText : string
-
the note text that should be escaped
Tags
Return values
mixed —getApiFieldForExternalKey()
Returns a specific field of an item or an empty Api Field when the key is null, empty or invalid
public
getApiFieldForExternalKey(string $sExternalKey) : CSItemApiField
If you pass the ExternalKey of the field as identifier be aware that labels are not unique and the first field with that label will be returned.
Parameters
- $sExternalKey : string
-
External key of the Item (or Field)
Tags
Return values
CSItemApiField —Returns an instance of the CSItemApiField object
getApiItem()
public
getApiItem([mixed $ID = null ]) : mixed
Parameters
- $ID : mixed = null
Tags
Return values
mixed —getClassName()
public
static getClassName(mixed $ClassID) : mixed
Parameters
- $ClassID : mixed
Tags
Return values
mixed —getColorFromIndex()
public
static getColorFromIndex(mixed $index) : mixed
Parameters
- $index : mixed
Tags
Return values
mixed —getColorMappings()
public
static getColorMappings() : mixed
Tags
Return values
mixed —getCometDocumentStatus()
public
static getCometDocumentStatus(mixed $file) : mixed
Parameters
- $file : mixed
Tags
Return values
mixed —getCometOS()
public
static getCometOS() : mixed
Tags
Return values
mixed —getCometPlaceholderTypeForField()
This method returns for a given field the corresponding placeholder type as it is known on the comet side.
public
static getCometPlaceholderTypeForField(CSItemApiField $field[, string $environment = CSComet::ENVIRONMENT_COMET ]) : string
While on the CS side a placeholder type CSComet::PLACEHOLDER_TYPE_PLAINTEXT is known and will be handled differently (e.g. when it comes to whitespace or brackets) on the Comet side only 'text' is understood.
Parameters
- $field : CSItemApiField
-
the field to analyse
- $environment : string = CSComet::ENVIRONMENT_COMET
-
one of the CSComet::ENVIRONMENT_* constants
Tags
Return values
string —one of the CSComet::PLACEHOLDER_TYPE_* constants
getComparator()
Creates a comparator object that can be used with the CSGuiItemComparatorTable
public
getComparator(CSItemComparatorData $oComparatorData) : CSItemComparator
Parameters
- $oComparatorData : CSItemComparatorData
-
CSItemComparatorData object with already setted data.
Tags
Return values
CSItemComparator —the newly created CSItemComparator-object that can be used for further configuration.
getDataFolder()
public
static getDataFolder() : mixed
Tags
Return values
mixed —getDocument()
public
static getDocument(mixed $mamFileID[, mixed $sessionContext = CSCOMET_SESSCTX_USER ]) : mixed
Parameters
- $mamFileID : mixed
- $sessionContext : mixed = CSCOMET_SESSCTX_USER
Tags
Return values
mixed —getDocumentContextFolder()
public
static getDocumentContextFolder(mixed $MamFileID[, mixed $Type = '' ][, mixed $autoCreate = false ]) : mixed
Parameters
- $MamFileID : mixed
- $Type : mixed = ''
- $autoCreate : mixed = false
Tags
Return values
mixed —getDocumentLinkTypes()
public
static getDocumentLinkTypes([mixed $includeDefault = true ]) : mixed
Parameters
- $includeDefault : mixed = true
Tags
Return values
mixed —getDocumentSubFolder()
public
static getDocumentSubFolder(mixed $MamFileID[, mixed $Type = 'Links' ]) : mixed
Parameters
- $MamFileID : mixed
- $Type : mixed = 'Links'
Tags
Return values
mixed —getDocumentVariantsFolder()
public
static getDocumentVariantsFolder(mixed $MamFileID[, mixed $autoCreate = false ]) : mixed
Parameters
- $MamFileID : mixed
- $autoCreate : mixed = false
Tags
Return values
mixed —getErrorMessage()
public
static getErrorMessage(mixed $ErrorCode) : mixed
Parameters
- $ErrorCode : mixed
Tags
Return values
mixed —getImageLinkTypes()
Sample Description
public
static getImageLinkTypes([bool $includeDefault = TRUE ]) : array<string|int, mixed>
Parameters
- $includeDefault : bool = TRUE
Tags
Return values
array<string|int, mixed> —getInstance()
public
static getInstance(mixed $apiName[, mixed $itemClass = null ]) : mixed
Parameters
- $apiName : mixed
- $itemClass : mixed = null
Tags
Return values
mixed —getItemTemplate()
public
static getItemTemplate(int $iPageTemplateId) : CSCometItemTemplate
Parameters
- $iPageTemplateId : int
Tags
Return values
CSCometItemTemplate —getItemTemplates()
public
static getItemTemplates() : array<string|int, CSCometItemTemplate>
Tags
Return values
array<string|int, CSCometItemTemplate> —getItemTemplateTypes()
Returns the list of project-specific product template types that an administrator defined in the PPM Comet Connector settings.
public
static getItemTemplateTypes() : array<string|int, mixed>
Note that the list will be cached during a single request.
Tags
Return values
array<string|int, mixed> —An array of product template types (ID => Label). The template types should be defined in the GUI as follows: One template type entry per line, with the template ID and the template label separated by a pipe ("|") character. If the ID (plus the pipe char!) is omitted, the IDs will be calculated automatically.
getMasterOfVariant()
public
static getMasterOfVariant(mixed $FileID) : mixed
Parameters
- $FileID : mixed
Tags
Return values
mixed —getNotesXml()
public
static getNotesXml(mixed $FileID) : mixed
Parameters
- $FileID : mixed
Tags
Return values
mixed —getPageTemplate()
public
static getPageTemplate(mixed $iPageTemplateId) : mixed
Parameters
- $iPageTemplateId : mixed
Tags
Return values
mixed —getPageTemplatePreview()
public
static getPageTemplatePreview(mixed $iPageTemplateId) : mixed
Parameters
- $iPageTemplateId : mixed
Tags
Return values
mixed —getPageTemplates()
public
static getPageTemplates() : mixed
Tags
Return values
mixed —getPageTypeForPageSide()
Returns the comet page type value for the passed indesign page side constant
public
static getPageTypeForPageSide(int $iPageSide) : int|null
Parameters
- $iPageSide : int
-
the page side for which the page type should be returned. This can be one of the following constants:
CSICM_PAGE_SIDE_LEFT CSICM_PAGE_SIDE_RIGHT CSICM_PAGE_SIDE_SINGLE
Tags
Return values
int|null —the comet page type for the given indesign page side constant. the default value, if no other page type matches, is the neutral page type. the return value can be one of the following constants
CSCOMET_PAGE_TYPE_LEFT CSCOMET_PAGE_TYPE_RIGHT CSCOMET_PAGE_TYPE_NEUTRAL
getPageTypeLabel()
public
static getPageTypeLabel(mixed $pageType) : mixed
Parameters
- $pageType : mixed
Tags
Return values
mixed —getPlaceholderType()
Retrieves the Placeholder Type
public
static getPlaceholderType(mixed $field, mixed $ClassID[, string $environment = CSComet::ENVIRONMENT_COMET ]) : string
Parameters
- $field : mixed
-
the field that is investigated
- $ClassID : mixed
-
the class ID of the item that is investigated
- $environment : string = CSComet::ENVIRONMENT_COMET
-
one of the CSComet::ENVIRONMENT_* constants
Tags
Return values
string —the type
getPlacementStateIcon()
Returns the placement state icon for a given placement state and item class.
public
static getPlacementStateIcon(int $iPlacementState[, string $sItemClass = self::ITEMCLASS_ITEM ][, string $iconSize = CSImageUtils::ICONSIZE_16X16 ]) : string
Parameters
- $iPlacementState : int
-
One of the CSComet::PLACESTATE_* constants that is valid for the given item class.
- $sItemClass : string = self::ITEMCLASS_ITEM
-
Not used at the moment. Reserved for future use. The item class to which the resulting placement state should belong (e.g. PdmArticle, MamFile, ...) or a general 'item' class CSComet::ITEMCLASS_ITEM
- $iconSize : string = CSImageUtils::ICONSIZE_16X16
Tags
Return values
string —The icon path for the given placement state and item class, which is relative to the CONTENTSERV "admin" or project directory. If $iPlacementState is not valid for $sItemClass, a default icon path is returned.
getPlacementStates()
Returns the placement states that are available for a given item class.
public
static getPlacementStates([string $sItemClass = self::ITEMCLASS_ITEM ]) : array<string|int, mixed>
Parameters
- $sItemClass : string = self::ITEMCLASS_ITEM
-
TNot used at the moment. Reserved for future use. The item class to which the resulting placement state should belong (e.g. PdmArticle, MamFile, ...) or a general 'item' class CSComet::ITEMCLASS_ITEM
Tags
Return values
array<string|int, mixed> —An array of valid states for the item class. The CSComet::PLACESTATE_* constants are used as the array keys, the values contain the translatable dictionary keys for visualization purposes. If no placement states are available for the given item class, an empty array is returned.
getRecordClassNameByCometClassId()
Delivers the target records class id based on a given comet class id
public
static getRecordClassNameByCometClassId(int $iCometClassID) : null|string
Parameters
- $iCometClassID : int
-
One of the COMET_CLASS_* constants
Tags
Return values
null|string —The target record class id or null if unknown
getSearchableApiFields()
Returns an array with CSItemApiField matching the searchable condition in the given sort order and limit If $returnSimpleSearchables and $returnExtendedSearchables are set to false all fields are returned which are not searchable Otherwise the fields are returned matching at least one of the set criterias.
public
getSearchableApiFields([bool $returnSimpleSearchables = true ][, bool $returnExtendedSearchables = true ][, string $sortorder = '' ][, mixed $limit = '' ]) : mixed
Parameters
- $returnSimpleSearchables : bool = true
-
whether simple searchable fields are returned
- $returnExtendedSearchables : bool = true
-
whether extended searchable fields are returned
- $sortorder : string = ''
-
SQL Sort Order
- $limit : mixed = ''
-
either a string which is a SQL limit condition or the integer 1, if only the first matching CSItemApiField should be returned
Tags
Return values
mixed —either an array with the CSItemApiFields or the first CSItemApiField, if limit is set to 1
getSharepoint()
public
static getSharepoint(mixed $IDorName) : mixed
Parameters
- $IDorName : mixed
Tags
Return values
mixed —getSharepoints()
public
static getSharepoints([null $UserID = null ][, null $filter = null ]) : array<string|int, CSCometSharepoint>
Parameters
- $UserID : null = null
- $filter : null = null
Tags
Return values
array<string|int, CSCometSharepoint> —getSketchNotesXML()
Get the XML for sketch notes(comments)
public
static getSketchNotesXML(mixed $fileID) : string
Parameters
- $fileID : mixed
Tags
Return values
string —getStateBase()
Returns the BASE portion of a placement state, which is the most significant part for the placement process flow.
public
static getStateBase(int $iPlacementState) : int
Parameters
- $iPlacementState : int
-
The placement state, consisting of an INT32 with combined BASE and FLAGS state information. This can be any of the CSComet::PLACESTATE_* constants.
Tags
Return values
int —The BASE portion of the placement state. This will match one of the CSComet::PLACESTATE_BASE_* constants, if a valid state has been passed. If the resulting BASE portion marks an invalid base state, an exception will be thrown.
getStateFlags()
Returns the FLAGS portion of a placement state, which signals additional state features.
public
static getStateFlags(int $iPlacementState) : int
Parameters
- $iPlacementState : int
-
The placement state, consisting of an INT32 with combined BASE and FLAGS state information. This can be any of the CSComet::PLACESTATE_* constants.
Tags
Return values
int —The FLAGS portion of the placement state. This is a combination of zero or more bit flags, as defined in the CSComet::PLACESTATE_FLAG_* constants. If you need an array containing the various flags for "isset()" tests, consider using the getStateFlagsArray() method instead.
getStateFlagsArray()
Returns the FLAGS portion of a placement state, which signals additional state features.
public
static getStateFlagsArray(int $iPlacementState) : array<string|int, mixed>
Parameters
- $iPlacementState : int
-
The placement state, consisting of an INT32 with combined BASE and FLAGS state information. This can be any of the CSComet::PLACESTATE_* constants.
Tags
Return values
array<string|int, mixed> —An array containing zero or more bit flags, which will be a subset of the CSComet::$ENUM_PLACESTATE_FLAGS enumerator (the CSComet::PLACESTATE_FLAG_NONE flag is excluded from the result array to allow for "count()" and "empty()" checks). The array keys designate the state flags, while the values are the corresponding CS dictionary keys. If you need the plain INT32 value of the state flags to perform bit tests, consider using the getStateFlags() method instead.
getStateName()
Returns the name (CS dictionary key) for a given placement state.
public
static getStateName(int $iPlacementState[, string $sItemClass = self::ITEMCLASS_ITEM ]) : string
Parameters
- $iPlacementState : int
-
The placement state, which should be one of the CSComet::PLACESTATE_* constants.
- $sItemClass : string = self::ITEMCLASS_ITEM
-
Not used at the moment. Reserved for future use. The item class to which the resulting placement state should belong (e.g. PdmArticle, MamFile, ...) or a general 'item' class CSComet::ITEMCLASS_ITEM
Tags
Return values
string —The name for the placement state (as a CS dictionary key).
getTextLinkTypes()
public
static getTextLinkTypes([mixed $includeDefault = true ]) : mixed
Parameters
- $includeDefault : mixed = true
Tags
Return values
mixed —getValueGetter()
Returns a new CSItemValueGetter object
public
static getValueGetter(mixed $mName) : CSItemValueGetter
Parameters
- $mName : mixed
-
The name of the attribute to retrieve
Tags
Return values
CSItemValueGetter —getValueSetter()
Returns a new CSItemValueSetter object
public
static getValueSetter(mixed $mName, mixed $mValue) : CSItemValueSetter
Parameters
- $mName : mixed
-
The name of the attribute to retrieve
- $mValue : mixed
Tags
Return values
CSItemValueSetter —getValuesGetter()
Returns a new CSItemValuesGetter object
public
static getValuesGetter(array<string|int, mixed> $aNames) : CSItemValuesGetter
Parameters
- $aNames : array<string|int, mixed>
-
List of attributes to be retrieved.
Tags
Return values
CSItemValuesGetter —getValuesSetter()
Returns a new CSItemValuesSetter object
public
static getValuesSetter() : CSItemValuesSetter
Tags
Return values
CSItemValuesSetter —getVariants()
public
static getVariants(mixed $FileID) : mixed
Parameters
- $FileID : mixed
Tags
Return values
mixed —getWorkflowOptions()
public
static getWorkflowOptions() : mixed
Tags
Return values
mixed —handleCometResult()
public
static handleCometResult(mixed $result) : mixed
Parameters
- $result : mixed
Tags
Return values
mixed —hasStateFlag()
Tests if specific attribute flags are set in a given placement state.
public
static hasStateFlag(int $iPlacementState[, int $iPlacementStateFlags = self::PLACESTATE_FLAG_NONE ]) : bool
Parameters
- $iPlacementState : int
-
The placement state to be examined, which should correspond to one of the CSComet::PLACESTATE_* constants.
- $iPlacementStateFlags : int = self::PLACESTATE_FLAG_NONE
-
An integer value, describing the flag(s) to be tested for existence in the given $iPlacementState. This should be one of the CSComet::PLACESTATE_FLAG_* constants or an additive/OR'ed combination of them.
Tags
Return values
bool —TRUE, if all of the specified $iPlacementStateFlags bits are set in the placement state. FALSE, if at least one of the specified bits is not set in the placement state.
html2tagged()
public
static html2tagged(mixed $text[, mixed $FieldID = null ]) : mixed
Parameters
- $text : mixed
- $FieldID : mixed = null
Tags
Return values
mixed —isVariant()
public
static isVariant(mixed $FileID) : mixed
Parameters
- $FileID : mixed
Tags
Return values
mixed —limitAllowedHtmlTags()
Limits all tags which are allowed in the formatted value result of any item This can e.g. be used for media neutral exports where not all html tags are supported
public
static limitAllowedHtmlTags([array<string|int, mixed> $htmlTags = array() ]) : mixed
Parameters
- $htmlTags : array<string|int, mixed> = array()
-
an array containing all allowed HTML Tags. If it is an empty array, no html tags are allowed
Tags
Return values
mixed —logRequest()
public
static logRequest(mixed $input, mixed $output) : mixed
Parameters
- $input : mixed
- $output : mixed
Tags
Return values
mixed —mmToPt()
public
static mmToPt(mixed $mm) : mixed
Parameters
- $mm : mixed
Tags
Return values
mixed —ptToMM()
public
static ptToMM(mixed $pt) : mixed
Parameters
- $pt : mixed
Tags
Return values
mixed —setCometOS()
public
static setCometOS(mixed $OS) : mixed
Parameters
- $OS : mixed
Tags
Return values
mixed —setMetaDataFromExif()
Extracts the metadata and thumbs from the indesign file and writes it to the MAM file
public
static setMetaDataFromExif(CSMamFile $oFile) : void
Parameters
- $oFile : CSMamFile
-
the ID of the file
Tags
Return values
void —setMetaDataFromSpreadsXmlAndExif()
Writes the metadata of the comet spreads.xml to the metadata of the InDesign MamFile in Contentserv.
public
static setMetaDataFromSpreadsXmlAndExif(CSMamFile $oFile, mixed $sCometSpreadsXml) : void
Extracts the thumbs from the indesign file
Parameters
- $oFile : CSMamFile
- $sCometSpreadsXml : mixed
Tags
Return values
void —setNotesXml()
grabs the notes.xml supplied by the comet client and synchronize the contained comments with the CS database
public
static setNotesXml(mixed $sMamFileId, mixed $sCometNotesXml) : void
Parameters
- $sMamFileId : mixed
- $sCometNotesXml : mixed
Tags
Return values
void —synchronizeItemTemplates()
Parses the project-specific product template XML configuration file and synchronizes the contained templates with the CS database.
public
static synchronizeItemTemplates() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —A two-dimensional array containing all the template IDs ordered by CSComet::SYNCACTION_* constants. If the XML file is inaccessible and therefore no templates could be synced, the result array will be empty.
synchronizePageTemplates()
Parses the project-specific page template XML configuration file and synchronizes the contained templates with the CS database.
public
static synchronizePageTemplates() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —An two-dimensional array containing all the template IDs ordered by CSComet::SYNCACTION_* constants. If the XML file is inaccessible and therefore no templates could be synced, the result array will be empty.
updateServerInstances()
public
updateServerInstances() : mixed
Tags
Return values
mixed —useVariantAsMaster()
public
static useVariantAsMaster(mixed $FileID) : mixed
Parameters
- $FileID : mixed
Tags
Return values
mixed —writeConnectionsFile()
public
static writeConnectionsFile(mixed $user, mixed $password, mixed $sWebserverURL) : mixed
Parameters
- $user : mixed
- $password : mixed
- $sWebserverURL : mixed
