Contentserv PHP API

CSSmart
in package

PPM

SmartDocuments

BARCODE_TYPE_C128_B


    public
    mixed
    BARCODE_TYPE_C128_B
    = 'C128B'

BARCODE_TYPE_C128_C


    public
    mixed
    BARCODE_TYPE_C128_C
    = 'C128C'

BARCODE_TYPE_C39


    public
    mixed
    BARCODE_TYPE_C39
    = 'C39'

BARCODE_TYPE_CODABAR


    public
    mixed
    BARCODE_TYPE_CODABAR
    = 'CODABAR'

BARCODE_TYPE_EAN_13


    public
    mixed
    BARCODE_TYPE_EAN_13
    = 'EAN13'

BARCODE_TYPE_EAN_8


    public
    mixed
    BARCODE_TYPE_EAN_8
    = 'EAN8'

BARCODE_TYPE_I25


    public
    mixed
    BARCODE_TYPE_I25
    = 'I25'

BARCODE_TYPE_UPC_A


    public
    mixed
    BARCODE_TYPE_UPC_A
    = 'UPCA'

BARCODE_TYPE_UPC_E


    public
    mixed
    BARCODE_TYPE_UPC_E
    = 'UPCE'

DISPLAY_MODE_FULLSCREEN


    public
    mixed
    DISPLAY_MODE_FULLSCREEN
    = 'FullScreen'

DISPLAY_MODE_OUTLINES


    public
    mixed
    DISPLAY_MODE_OUTLINES
    = 'UseOutlines'

DISPLAY_MODE_THUMBS


    public
    mixed
    DISPLAY_MODE_THUMBS
    = 'UseThumbs'

LAYOUT_ONE_COLUMN


    public
    mixed
    LAYOUT_ONE_COLUMN
    = 'OneColumn'

LAYOUT_TWO_COLUMN_LEFT


    public
    mixed
    LAYOUT_TWO_COLUMN_LEFT
    = 'TwoColumnLeft'

LAYOUT_TWO_COLUMN_RIGHT


    public
    mixed
    LAYOUT_TWO_COLUMN_RIGHT
    = 'TwoColumnRight'

LAYOUT_TWO_PAGE_LEFT


    public
    mixed
    LAYOUT_TWO_PAGE_LEFT
    = 'TwoPageLeft'

LAYOUT_TWO_PAGE_RIGHT


    public
    mixed
    LAYOUT_TWO_PAGE_RIGHT
    = 'TwoPageRight'

LOG_EVENT_DATA_READY


    public
    mixed
    LOG_EVENT_DATA_READY
    = 'data ready'

LOG_EVENT_DOCUMENT_READY


    public
    mixed
    LOG_EVENT_DOCUMENT_READY
    = 'document ready'

LOG_EVENT_END


    public
    mixed
    LOG_EVENT_END
    = 'finished'

LOG_EVENT_FILE_STORED


    public
    mixed
    LOG_EVENT_FILE_STORED
    = 'file stored'

LOG_EVENT_RENDERING_DONE


    public
    mixed
    LOG_EVENT_RENDERING_DONE
    = 'rendering done'

LOG_EVENT_START


    public
    mixed
    LOG_EVENT_START
    = 'started'

ORIENTATION_LANDSCAPE


    public
    mixed
    ORIENTATION_LANDSCAPE
    = 'L'

ORIENTATION_PORTRAIT


    public
    mixed
    ORIENTATION_PORTRAIT
    = 'P'

PROTECTION_ANNOTATION


    public
    mixed
    PROTECTION_ANNOTATION
    = 'annot-forms'

PROTECTION_COPY


    public
    mixed
    PROTECTION_COPY
    = 'copy'

PROTECTION_MODIFY


    public
    mixed
    PROTECTION_MODIFY
    = 'modify'

PROTECTION_PRINT


    public
    mixed
    PROTECTION_PRINT
    = 'print'

RENDER_FORMAT_HTML


    public
    mixed
    RENDER_FORMAT_HTML
    = 'html'

RENDER_FORMAT_PDF


    public
    mixed
    RENDER_FORMAT_PDF
    = 'pdf'

RENDER_FORMAT_PDFREACTOR


    public
    mixed
    RENDER_FORMAT_PDFREACTOR
    = 'pdfreactor'

RENDER_FORMAT_PORTAL


    public
    mixed
    RENDER_FORMAT_PORTAL
    = 'portal'

RENDER_FORMAT_SMART


    public
    mixed
    RENDER_FORMAT_SMART
    = 'smart'

RENDER_FORMAT_XML


    public
    mixed
    RENDER_FORMAT_XML
    = 'xml'

SERVICE_NAME_PDFREACTOR


    public
    mixed
    SERVICE_NAME_PDFREACTOR
    = 1

ZOOM_DEFAULT


    public
    mixed
    ZOOM_DEFAULT
    = 'default'

ZOOM_FULLPAGE


    public
    mixed
    ZOOM_FULLPAGE
    = 'fullpage'

ZOOM_FULLWIDTH


    public
    mixed
    ZOOM_FULLWIDTH
    = 'fullwidth'

ZOOM_REAL


    public
    mixed
    ZOOM_REAL
    = 'real'

$events


    public
    static    mixed
    $events

$log


    public
    static    Smartlog
    $log

A record instance of "Smartlog"

createDocument()


    public
            static    createDocument([mixed $orientation = self::ORIENTATION_PORTRAIT ][, mixed $format = 'A4' ][, mixed $margin = 12.7 ]) : mixed

Parameters

$orientation : mixed = self::ORIENTATION_PORTRAIT
$format : mixed = 'A4'
$margin : mixed = 12.7

Return values

mixed —

createEditor()

Creates an online editor for Smart Documents


    public
            static    createEditor() : CSSmartEditor

Return values

CSSmartEditor —

createMacro()


    public
            static    createMacro(string $sType) : CSSmartMacro

Parameters

$sType : string: the macro type or plugin short name

Return values

CSSmartMacro —

the macro object for the type

createPreset()


    public
            static    createPreset() : mixed

Return values

mixed —

createTemplate()

Loads a Smart Template from a Smart Template Plugin and passes parameters The resulting templates then can be rendered straight away like a normal CSSmartDocument or can be modified by overwriting settings or parts of the output


    public
            static    createTemplate(string $pluginPrefix[, CSSmartPreset $preset = null ]) : CSSmartTemplate

Parameters

$pluginPrefix : string: The unique plugin prefix, for example foo when the plugin is fooSmartTemplate.
$preset : CSSmartPreset = null: An array with plugin specific parameters, where the key is the name of the parameter.

Return values

CSSmartTemplate —

the Smart Template

createTemplateEngine()

Creates a new Template Engine


    public
            static    createTemplateEngine(array<string|int, mixed>|string $sTemplateFolder) : CSSmartCSView

Parameters

$sTemplateFolder : array<string|int, mixed>|string: the folder with the templates

Return values

CSSmartCSView —

createTemplateFolder()


    public
            static    createTemplateFolder(mixed $prefix) : mixed

Parameters

$prefix : mixed

Return values

mixed —

getAllFormats()

Method that returns all currently available rendering formats


    public
            static    getAllFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

with name and label of the rendering format

getAvailablePresetLabelsForContext()

Returns the possible Smart Preset labels for a context


    public
            static    getAvailablePresetLabelsForContext([mixed $mContext = null ][, string $sSortOrder = '' ]) : array<string|int, mixed>

Parameters

$mContext : mixed = null: the context may be any kind of object that a consumer of templates might pass with the expectation, that only matching templates should be returned. If no context is given, all templates can be returned
$sSortOrder : string = '': The SQL sort order for the preset labels. Default sort order: "Name ASC"

Return values

array<string|int, mixed> —

with preset labels as values and preset IDs as keys

getAvailablePresetNamesForContext()

Returns the possible Smart Preset names for a context


    public
            static    getAvailablePresetNamesForContext([mixed $mContext = null ][, string $sSortOrder = 'Name ASC' ]) : array<string|int, mixed>

Parameters

$mContext : mixed = null: the context may be any kind of object that a consumer of templates might pass with the expectation, that only matching templates should be returned. If no context is given, all templates can be returned
$sSortOrder : string = 'Name ASC': sort order

Return values

array<string|int, mixed> —

with preset names as values and preset IDs as keys

getAvailablePresetsForContext()

Returns the possible Smart Presets as array


    public
            static    getAvailablePresetsForContext([mixed $context = NULL ][, string $sort = 'Name ASC' ]) : array<string|int, CSSmartPreset>

Parameters

$context : mixed = NULL: the context may be any kind of object that a consumer of templates might pass with the expectation, that only matching templates should be returned. If no context is given, all templates can be returned
$sort : string = 'Name ASC': the sort order

Return values

array<string|int, CSSmartPreset> —

array with CSSmartPresetIDs as keys and CSSmartPreset as values

getDocument()

Loads and unserializes a SmartDocument that was stored to a mam file


    public
            static    getDocument(mixed $MamFileID) : CSSmartDocument

Parameters

$MamFileID : mixed

Return values

CSSmartDocument —

the unserialized file

getExportUrl()

Generates the URL to open when exporting a preset


    public
            static    getExportUrl(mixed $mPresetOrID[, mixed $sContextIDs = NULL ][, array<string|int, string> $asOtherParams = array() ][, string $sBase = 'external' ]) : string

Parameters

$mPresetOrID : mixed

$sContextIDs : mixed = NULL

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

an associative array with preset modifications like

ContextClass
Language
CSSLink
Format
Dpi
Colorspace
MarksAndBleeds
PDFTitle
PDFSubject
PDFAuthor
PDFKeywords
PDFUserPassword
PDFAdminPassword
PDFAllowPrinting
PDFAllowCopying
PDFAllowModification
PDFAllowAnnotation

$sBase : string = 'external'

the base as in @see CS::getLinkToResource()

Return values

string —

a HTTP URL that would generate the required document

getFormatDimensions()

Get the format dimensions for a format string


    public
            static    getFormatDimensions(mixed $format) : array<string|int, mixed>

Parameters

$format : mixed

The format used for pages. It can be either one of the following values (case insensitive) or a custom format in the form of a two-element array containing the width and the height (expressed in the unit given by unit).

4A0
2A0
A0
A1
A2
A3
A4 (default)
A5
A6
A7
A8
A9
A10
B0
B1
B2
B3
B4
B5
B6
B7
B8
B9
B10
C0
C1
C2
C3
C4
C5
C6
C7
C8
C9
C10
RA0
RA1
RA2
RA3
RA4
SRA0
SRA1
SRA2
SRA3
SRA4
LETTER
LEGAL
EXECUTIVE
FOLIO

Return values

array<string|int, mixed> —

with the width and height in mm

getModuleBaseDirectory()


    public
            static    getModuleBaseDirectory() : string

Return values

string —

the location of the smart module as it might be shifted later to the core

getModuleLibDirectory()


    public
            static    getModuleLibDirectory() : string

Return values

string —

the location of the smart modules lib folder

getPDFFormats()

Returns all available rendering PDF formats.


    public
            static    getPDFFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getPdfReactorFormats()

Returns available rendering PDF reactor format.


    public
            static    getPdfReactorFormats() : array<string|int, mixed>

Return values

array<string|int, mixed> —

getPdfReactorVersion()

Fetches the Version of the installed PDFreactor


    public
            static    getPdfReactorVersion([bool $bUseOption = true ][, bool $bReturnDetailVersion = false ]) : string

Parameters

$bUseOption : bool = true: Whether the PDFreactor version option should be used to receive the version.
$bReturnDetailVersion : bool = false: Whether the detailed version should be determined by a command call (<Version>.<Minor Version>.<Detail Version>)

Return values

string —

The Pdfreactor version in the format <Version>.<Minor Version> or in the detail format <Version>.<Minor Version>.<Detail Version>

getPreset()

Returns the Smart Preset for the given ID


    public
            static    getPreset([int $SmartpresetID = NULL ]) : CSSmartPreset

Parameters

$SmartpresetID : int = NULL: the ID of the preset

Return values

CSSmartPreset —

getPresetBaseDirectory()


    public
            static    getPresetBaseDirectory() : string

Return values

string —

the location of the smart preset rest base directory

getPresetForItem()

Finds the CSSmartTemplateTemplatePlugins name for an item All items have an inheritable Smart Template plugin as attribute, that should be used as "default" template, if no other template is specified.


    public
            static    getPresetForItem(CSItemApiItem|Item $item) : CSSmartPreset

Parameters

$item : CSItemApiItem|Item: CSItemApiItem the item

Return values

CSSmartPreset —

the assigned Smart Template plugin name

getPresetForRequest()


    public
            static    getPresetForRequest() : mixed

Return values

mixed —

getPresetLabels()

Returns the possible smart preset labels.


    public
            static    getPresetLabels([string $sTemplateFilter = null ]) : array<string|int, mixed>

Parameters

$sTemplateFilter : string = null: optional SQL filter against the Restservice table model

Return values

array<string|int, mixed> —

with the possible smart preset labels

getPresetNames()

Returns the possible mart Preset names.


    public
            static    getPresetNames([string $sTemplateFilter = null ]) : array<string|int, mixed>

Parameters

$sTemplateFilter : string = null: optional SQL filter against the Restservice table model

Return values

array<string|int, mixed> —

getPresets()

Returns all Smart presets available for a template


    public
            static    getPresets([string $template = NULL ][, string $sort = 'Name asc' ][, bool $bIncludeDisabled = false ]) : array<string|int, CSSmartPreset>

Parameters

$template : string = NULL: optional SQL filter against the Restservice table model
$sort : string = 'Name asc': the sort order
$bIncludeDisabled : bool = false: wether to include disabled presets as well, default is false

Return values

array<string|int, CSSmartPreset> —

array of CSSmartPreset objects

getPresetsIdsForContextsIds()

Return the respective, defined or inherited, presets for the received Context IDS


    public
            static    getPresetsIdsForContextsIds(array<string|int, mixed> $aContextItemIds, string $sContextClass, bool $iSelectedPresetId[, bool $bUseInherited = false ]) : array<string|int, mixed>

Parameters

$aContextItemIds : array<string|int, mixed>: Context items id's
$sContextClass : string: Context class of the context ids
$iSelectedPresetId : bool: Id of the preset to be used in case of undefined item preset
$bUseInherited : bool = false: If inheritance should be used or not when get the preset id

Return values

array<string|int, mixed> —

PresetIds

getPresetUrl()

Creates a ready to GET call URL which obtains a preset based SmartRendering of an item


    public
            static    getPresetUrl(Item $item, CSSmartPreset $preset) : string

Parameters

$item : Item: the item to render
$preset : CSSmartPreset: the preset to render, can contain overwritten settings

Return values

string —

the URL for the preset rendering

getProductIcon()

Retrieves the product icon


    public
            static    getProductIcon([string $type = 'pdf' ]) : string

Parameters

$type : string = 'pdf': pdf or document

Return values

string —

getSupportedPdfreactorVersions()

Fetches the list of all the supported PDFreactor versions from the PDFreactor Integrator API


    public
            static    getSupportedPdfreactorVersions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

List of all the supported PDFreactor versions

getTemplatePlugin()

Returns the plugin for a given Smart Template name


    public
            static    getTemplatePlugin(string $sTemplatePluginName) : CSSmartTemplatePlugin

Parameters

$sTemplatePluginName : string: The template plugin prefix, like catalog for a CatalogSmartTemplate

Return values

CSSmartTemplatePlugin —

the plugin if found

getTemplatePluginNames()

Returns the possible Smart Template names for a context


    public
            static    getTemplatePluginNames([mixed $mContext = null ]) : array<string|int, mixed>

Parameters

$mContext : mixed = null: The context may be any kind of object that a consumer of templates might pass with the expectation, that only matching templates should be returned. If no context is given, all templates can be returned

Return values

array<string|int, mixed> —

with template names as values and upper case first names as values

getTemplatePluginNamesForUI()

Returns the possible Smart Template names for a context which are selectable in the UI.


    public
            static    getTemplatePluginNamesForUI([mixed $mContext = null ]) : array<string|int, mixed>

Parameters

$mContext : mixed = null: The context may be any kind of object that a consumer of templates might pass with the expectation, that only matching templates should be returned. If no context is given, all templates can be returned

Return values

array<string|int, mixed> —

with template names as values and upper case first names as values

getTemplatePlugins()

Returns the possible Smart Template plugins as array


    public
            static    getTemplatePlugins([mixed $mContext = null ]) : array<string|int, CSSmartTemplatePlugin>

Parameters

$mContext : mixed = null: The context may be any kind of object that a consumer of templates might pass with the expectation, that only matching templates should be returned. If no context is given, all templates can be returned

Return values

array<string|int, CSSmartTemplatePlugin> —

array with plugins as values and prefixes as names

getTemplatePluginsForUI()

Returns the possible Smart Template plugins as array which can be selected in the UI.


    public
            static    getTemplatePluginsForUI([mixed $mContext = null ]) : array<string|int, CSSmartTemplatePlugin>

Parameters

$mContext : mixed = null: The context may be any kind of object that a consumer of templates might pass with the expectation, that only matching templates should be returned. If no context is given, all templates can be returned

Return values

array<string|int, CSSmartTemplatePlugin> —

array with plugins as values and prefixes as names

getTokenForBarcode()


    public
            static    getTokenForBarcode(string $value[, string $style = '' ][, string $type = 'EAN13' ][, bool $showLabel = TRUE ]) : string

Parameters

$value : string: value to convert into barcode
$style : string = '': Sets the color for the bar, its width and height (without the label) and the size of the label if it is displayed (not required)
$type : string = 'EAN13': type of barcode to use, see http://wiki.spipu.net/doku.php?id=html2pdf:en:v4:barcode_1d
$showLabel : bool = TRUE: if TRUE the value will be added below the barcode as a label string

Return values

string —

that can be understood by the html2pdf converter

getTokenForBookmark()

Generates a token that can be understood by the html2pdf converter as a bookmark


    public
            static    getTokenForBookmark(string $text, int $level) : string

Parameters

$text : string: the label of the bookmark
$level : int: the indentation level of the bookmark, 0 is the root level

Return values

string —

that can be understood as a bookmark by the html2pdf converter

getTokenForKeepTogetherEnd()

Creates a token that within html output will end the zone that should not break at a page end


    public
            static    getTokenForKeepTogetherEnd() : string

Return values

string —

the token

getTokenForKeepTogetherStart()

Creates a token that within html output will make sure that following output will not break at a page end The content is instead completely shifted to the next page


    public
            static    getTokenForKeepTogetherStart() : string

Return values

string —

the token

getTokenForNumberOfPages()

Generates a token that will be replaced by the html2pdf converter by the number of all pages in the document


    public
            static    getTokenForNumberOfPages() : int

Return values

int —

the number of all real pages of the document

getTokenForPageNumber()

Returns the token to generate a page number at pdf rendering time for the current page This token can be added as HTML content and will be replaced later by the actual real page number


    public
            static    getTokenForPageNumber() : string

Return values

string —

the token

getTokenForQRCode()


    public
            static    getTokenForQRCode(string $value[, string $style = 'width: 40mm; border: none;' ][, string $ec = 'H' ]) : string

Parameters

$value : string: value to turn into QR-Code
$style : string = 'width: 40mm; border: none;': specifies QRcode size (width: 40mm), colors (background-color and color), the presence or absence of a border (border: none)
$ec : string = 'H': level of error correction: L, M, Q, H (not mandatory, default: H)

Return values

string —

that can be understood by the html2pdf converter

isServiceRunning()

Checks the given service is running or not.


    public
            static    isServiceRunning([int $iService = self::SERVICE_NAME_PDFREACTOR ]) : bool

Parameters

$iService : int = self::SERVICE_NAME_PDFREACTOR: Constant of service from Service name constants in CSSmart.php

Return values

bool —

True if service is running else false

logDataReady()


    public
            static    logDataReady() : mixed

Return values

mixed —

logDocumentReady()


    public
            static    logDocumentReady() : mixed

Return values

mixed —

logEnd()


    public
            static    logEnd(CSSmartDocument $document, mixed $fileFormat, mixed $fileSize[, CSMamFile $file = NULL ]) : mixed

Parameters

$document : CSSmartDocument
$fileFormat : mixed
$fileSize : mixed
$file : CSMamFile = NULL

Return values

mixed —

logFileStored()


    public
            static    logFileStored() : mixed

Return values

mixed —

logRenderingDone()


    public
            static    logRenderingDone() : mixed

Return values

mixed —

logStart()


    public
            static    logStart() : mixed

Return values

mixed —

CSSmart in package PPM SmartDocuments

Tags

Table of Contents

Constants

BARCODE_TYPE_C128_B

Tags

BARCODE_TYPE_C128_C

Tags

BARCODE_TYPE_C39

Tags

BARCODE_TYPE_CODABAR

Tags

BARCODE_TYPE_EAN_13

Tags

BARCODE_TYPE_EAN_8

Tags

BARCODE_TYPE_I25

Tags

BARCODE_TYPE_UPC_A

Tags

BARCODE_TYPE_UPC_E

Tags

DISPLAY_MODE_FULLSCREEN

Tags

DISPLAY_MODE_OUTLINES

Tags

DISPLAY_MODE_THUMBS

Tags

LAYOUT_ONE_COLUMN

Tags

LAYOUT_TWO_COLUMN_LEFT

Tags

LAYOUT_TWO_COLUMN_RIGHT

Tags

LAYOUT_TWO_PAGE_LEFT

Tags

LAYOUT_TWO_PAGE_RIGHT

Tags

LOG_EVENT_DATA_READY

Tags

LOG_EVENT_DOCUMENT_READY

Tags

LOG_EVENT_END

Tags

LOG_EVENT_FILE_STORED

Tags

LOG_EVENT_RENDERING_DONE

Tags

LOG_EVENT_START

Tags

ORIENTATION_LANDSCAPE

Tags

ORIENTATION_PORTRAIT

Tags

PROTECTION_ANNOTATION

Tags

PROTECTION_COPY

Tags

PROTECTION_MODIFY

Tags

PROTECTION_PRINT

Tags

RENDER_FORMAT_HTML

Tags

RENDER_FORMAT_PDF

Tags

RENDER_FORMAT_PDFREACTOR

Tags

RENDER_FORMAT_PORTAL

Tags

RENDER_FORMAT_SMART

Tags

RENDER_FORMAT_XML

Tags

SERVICE_NAME_PDFREACTOR

Tags

ZOOM_DEFAULT

Tags

ZOOM_FULLPAGE

Tags

CSSmart
in package

PPM

SmartDocuments