Contentserv PHP API

CSSmartPreset
in package

Represents a Smart Preset that configures a Smart Document To create a new CSSmartPreset use @see CSSmart::createPreset()

Tags
since

CS14.0

access

public

Table of Contents

DOWNLOAD_TYPE_ACTIVE  = 1
DOWNLOAD_TYPE_DEFAULT  = 0
DOWNLOAD_TYPE_INACTIVE  = 2
FIELD_DOWNLOAD  = 'Download'
PDF_CONFORMANCE  = 'PDFConformance'
$aUsedMamIDs  : mixed
__construct()  : CSSmartPreset
The constructor should not be called by anyone directly, use factory methods of CSSmart
addGeneralFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the general preset fields to the editor
addOutputFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the output preset fields to the editor
addPdfFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the pdf preset fields to the editor
addTemplateFieldsToEditor()  : mixed
This method can be used by CSGuiEditors to add the template specific preset fields to the editor
addUsedMamFileIds()  : mixed
Sets the Mam Ids in the array
createDefaultPreset()  : mixed
Creates a default Preset for the given template name
createDefaultPresets()  : void
Method that will be called at update data model to make sure that for each template there's at least one preset - disable the presets if not required
getColorspace()  : string
Gets the color space defined by this preset
getContext()  : array<string|int, mixed>
Loads the context records from the context ids and class stored with this CSSmartPreset
getContextAsApiItems()  : array<string|int, CSItemApiItem>
This method retrieves naturally the selected items by a context like list selection or tree node
getContextClass()  : string
Retrieves the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The context class defines the type of these objects.
getContextIDs()  : string
Retrieves the context IDs of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The ContextIDs are the IDs of these objects separated by commas.
getContextIDsAsArray()  : array<string|int, mixed>
Returns the context ids of the preset as an array
getContextInstance()  : Record|Item|null
Returns an (empty) instance of the context object
getCSSLink()  : string
It is possible to provide CSSLinks with a CSSmartPreset that should be added at the end of the CSS processing chain and overwrite other standard settings
getDescription()  : string
Gets the description attribute.
getDownloadType()  : string
Returns the download type defined by this preset.
getDpi()  : int
Gets the Dots per Inch defined by this preset
getEditorPaneGeneralTitle()  : string
Returns the general pane title.
getExportUrl()  : string
Generates the URL to open when exporting this preset
getFormat()  : string
Gets the requested format like pdf, html or smart
getID()  : int
Gets the ID of the Preset as stored in the DB
getLabel()  : string
Gets the Label attribute.
getLanguage()  : int
Gets the Language ID selected for this preset
getLanguageAsObject()  : CSLanguage
Gets the Language as Object selected for this preset
getLanguageID()  : int
Each Preset also defines a language to use
getLanguageShortName()  : string
Each Preset also defines a language to use
getMamReferencesID()  : bool
Defines if the exported document with this preset should be stored in the Mam
getMarksAndBleeds()  : string
Gets the MarksAndBleeds defined by this preset
getName()  : string
Returns the name value of the current smart preset.
getPdfAdminPassword()  : string
Returns the PDF Admin Password
getPdfAllowsAnnotation()  : bool
Returns true if the user is allowed to annotate the PDF
getPdfAllowsCopying()  : bool
Returns true if the user is allowed to copy the content of the PDF
getPdfAllowsModification()  : bool
Returns true if the user is allowed to modify the content of the PDF
getPdfAllowsPrinting()  : bool
Returns true if the user is allowed to print the PDF
getPdfAuthor()  : string
Returns the PDF Author
getPdfConformance()  : string
Gets the PDF conformance of the Preset
getPdfKeywords()  : string
Returns the PDF Keywords
getPdfSubject()  : string
Returns the PDF Subject
getPdfTitle()  : string
Returns the PDF Title
getPdfUserPassword()  : string
Returns the PDF User Password
getPdfVersion()  : float
Gets the PDF verion of the Preset
getPimReferencesID()  : bool
Defines if the exported document with this preset should be stored in the Pim
getRecord()  : Smartpreset
Returns the internal CONTENTSERV Record object for this preset api object
getSaveDocuments()  : bool
Defines if the exported document with this preset should be stored in the MAM
getSaveToFolderID()  : int
Defines to which base folder Smart Documents should be exported
getSaveToSubFolder()  : string
Defines to which sub folder and file name Smart Documents should be exported relative to the SaveFoFolderID Setting
getSplitDocuments()  : bool
Tells if the separate documents is checked and returns the value as 1
getTemplate()  : string
Gets the Template Short Name of the Preset
getTemplatePlugin()  : CSSmartTemplatePlugin
Gets the Smart Template Plugin of the Preset
getUsedMamFileIds()  : array<string|int, mixed>
Gets the array of used mam files .
getUserAccess()  : int
Gets the UserAccess attribute.
getUserAccessFormatted()  : string
Gets the UserAccess type in a human readable format
getUserAccessIDs()  : string
Gets the UserIDs attribute.
getValue()  : string
Returns a value from the inner record object
getWatermark()  : string
Returns the watermark file name within the folder smart/gui/images/watermark to be used If the name is "custom" then the MAMFile in the WatermarkID should be used
getWatermarkID()  : int
Returns the MamID of a Watermark Image that should be added to all pages
isAvailableForCurrentUser()  : bool
Check if the current user is allowed to use the REST service.
isDisabled()  : bool
Tells if the preset has the "Disabled" checkbox set in the preset configuration
IsDownloadActivated()  : bool|string
Returns a boolean whether the preset has activated the download.
isPDFFormat()  : bool
Checks if the current format is a PDF format.
isPdfReactorFormat()  : bool
Checks if the current format is a PDF reactor format.
loadFromRequest()  : void
Overwrites a given CSSmartPreset object with settings from the current HTTP GET or POST parameters This method can be used to load a preset on the fly from a request
render()  : mixed
Renders the Preset according to all its settings
setColorspace()  : mixed
Sets the colorspace
setContextClass()  : void
Sets the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The context class defines the type of these objects separated by commas.
setContextIDs()  : void
Sets the ContextIDs field of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The ContextIDs are the IDs of these objects separated by commas.
setCSSLink()  : void
It is possible to provide CSSLinks with a CSSmartPreset that should be added at the end of the CSS processing chain and overwrite other standard settings
setDescription()  : void
Set the Description attribute.
setDisabled()  : void
Disables or enables a preset
setDownloadType()  : mixed
Sets the download type for this preset.
setDpi()  : void
Sets the Dots per Inch defined by this preset
setFormat()  : void
Sets the requested file format like pdf, html or smart
setLabel()  : void
Set the Label attribute.
setLanguage()  : mixed
Overwrites the language ID set with this CSSmartPreset
setMamReferencesID()  : int
Defines to the attribute where to set the MAM References.
setMarksAndBleeds()  : mixed
Sets the MarksAndBleeds
setName()  : mixed
Sets the name for the current smart preset.
setPdfAdminPassword()  : mixed
Sets the PDF User Password
setPdfAllowsAnnotation()  : mixed
Sets the PDF right to annotate the content in this pdf
setPdfAllowsCopying()  : mixed
Sets the PDF right to copy content out of this document
setPdfAllowsModification()  : mixed
Sets the PDF right to modify content in this pdf
setPdfAllowsPrinting()  : mixed
Sets the PDF right to print this document
setPdfAuthor()  : mixed
Sets the PDF Author
setPdfConformance()  : void
Sets the PDF conformance of the Preset
setPdfKeywords()  : mixed
Sets the PDF Keywords
setPdfSubject()  : mixed
Sets the PDF Subject
setPdfTitle()  : mixed
Sets the PDF Title
setPdfUserPassword()  : mixed
Sets the PDF User Password
setPdfVersion()  : void
Sets the PDF version of the Preset
setPimReferencesID()  : int
Defines to the attribute where to set the PIM References.
setSaveDocuments()  : void
Defines if the exported document with this preset should be stored in the MAM
setSaveToFolderID()  : mixed
Defines to which base folder Smart Documents should be exported
setSaveToSubFolderID()  : string
Defines to which sub folder and file name Smart Documents should be exported relative to the SaveFoFolderID Setting
setSplitDocuments()  : void
Allows whether separate documents should be generated for each context id
setTemplate()  : void
Sets the Template Short Name of the Preset
setUserAccess()  : void
Set the UserAccess attribute.
setValue()  : void
Sets a value to the the inner record object
setWatermark()  : void
Sets the watermark file name within the folder smart/gui/images/watermark to be used If the name is "custom" then the MAMFile in the WatermarkID should be used
setWatermarkID()  : void
Sets the MamFileID of a Watermark Image that should be added to all pages
store()  : void
Stores the inner record with the current preset data to the database

Constants

DOWNLOAD_TYPE_ACTIVE

public mixed DOWNLOAD_TYPE_ACTIVE = 1
Tags

DOWNLOAD_TYPE_DEFAULT

public mixed DOWNLOAD_TYPE_DEFAULT = 0
Tags

DOWNLOAD_TYPE_INACTIVE

public mixed DOWNLOAD_TYPE_INACTIVE = 2
Tags

FIELD_DOWNLOAD

public mixed FIELD_DOWNLOAD = 'Download'
Tags

PDF_CONFORMANCE

public mixed PDF_CONFORMANCE = 'PDFConformance'
Tags

Properties

Methods

__construct()

The constructor should not be called by anyone directly, use factory methods of CSSmart

public __construct([int $SmartpresetID = NULL ]) : CSSmartPreset
Parameters
$SmartpresetID : int = NULL

the ID of the preset

Tags
access

internal

Return values
CSSmartPreset —

addGeneralFieldsToEditor()

This method can be used by CSGuiEditors to add the general preset fields to the editor

public static addGeneralFieldsToEditor(CSGuiEditor $editor, CSSmartPreset $preset) : mixed
Parameters
$editor : CSGuiEditor

the CSGuiEditor or descendant

$preset : CSSmartPreset

the preset to pre-fill the editor

Tags
access

public

Return values
mixed —

addOutputFieldsToEditor()

This method can be used by CSGuiEditors to add the output preset fields to the editor

public static addOutputFieldsToEditor(CSGuiEditor $editor[, CSSmartPreset $preset = NULL ]) : mixed
Parameters
$editor : CSGuiEditor

the CSGuiEditor or descendant

$preset : CSSmartPreset = NULL

the preset to pre-fill the editor

Tags
access

public

Return values
mixed —

addPdfFieldsToEditor()

This method can be used by CSGuiEditors to add the pdf preset fields to the editor

public static addPdfFieldsToEditor(CSGuiEditor $editor[, CSSmartPreset $preset = NULL ]) : mixed
Parameters
$editor : CSGuiEditor

the CSGuiEditor or descendant

$preset : CSSmartPreset = NULL

the preset to pre-fill the editor

Tags
access

public

Return values
mixed —

addTemplateFieldsToEditor()

This method can be used by CSGuiEditors to add the template specific preset fields to the editor

public static addTemplateFieldsToEditor(CSGuiEditor $editor[, CSSmartPreset $preset = NULL ]) : mixed
Parameters
$editor : CSGuiEditor

the CSGuiEditor or descendant

$preset : CSSmartPreset = NULL

the preset to pre-fill the editor

Tags
access

public

Return values
mixed —

addUsedMamFileIds()

Sets the Mam Ids in the array

public addUsedMamFileIds(int $iMamID) : mixed
Parameters
$iMamID : int

the Mam id.

Tags
access

public

Return values
mixed —

createDefaultPreset()

Creates a default Preset for the given template name

public static createDefaultPreset(string $template[, mixed $format = 'pdf' ]) : mixed
Parameters
$template : string

the template name

$format : mixed = 'pdf'
Tags
access

public

@return
Return values
mixed —

createDefaultPresets()

Method that will be called at update data model to make sure that for each template there's at least one preset - disable the presets if not required

public static createDefaultPresets() : void
Tags
Return values
void —

getColorspace()

Gets the color space defined by this preset

public getColorspace() : string
Tags
access

public

Return values
string —

the color space like rgb or cmyk

getContext()

Loads the context records from the context ids and class stored with this CSSmartPreset

public getContext() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed> —

of context records

getContextAsApiItems()

This method retrieves naturally the selected items by a context like list selection or tree node

public getContextAsApiItems([bool $recursive = TRUE ][, bool $includeFolders = FALSE ]) : array<string|int, CSItemApiItem>
Parameters
$recursive : bool = TRUE

if true and only one folder is selected also all recursive children are returned

$includeFolders : bool = FALSE

if true then also the folders within the children are included

Tags
access

public

Return values
array<string|int, CSItemApiItem> —

array of CSApiItems selected

getContextClass()

Retrieves the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The context class defines the type of these objects.

public getContextClass() : string
Tags
access

public

Return values
string —

getContextIDs()

Retrieves the context IDs of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The ContextIDs are the IDs of these objects separated by commas.

public getContextIDs() : string
Tags
access

public

Return values
string —

getContextIDsAsArray()

Returns the context ids of the preset as an array

public getContextIDsAsArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

getContextInstance()

Returns an (empty) instance of the context object

public getContextInstance([string $sId = null ]) : Record|Item|null
Parameters
$sId : string = null

A possible ID which will be loaded on CS::getRecord

Tags
Return values
Record|Item|null —

Returns the record instance or null if ContextClass is not defined.

getCSSLink()

It is possible to provide CSSLinks with a CSSmartPreset that should be added at the end of the CSS processing chain and overwrite other standard settings

public getCSSLink() : string
Tags
access

public

Return values
string —

the CSS Link

getDescription()

Gets the description attribute.

public getDescription() : string
Tags
access

public

Return values
string —

the description attribute

getDownloadType()

Returns the download type defined by this preset.

public getDownloadType() : string
Tags
Return values
string —

type of the download

getDpi()

Gets the Dots per Inch defined by this preset

public getDpi() : int
Tags
access

public

Return values
int —

the dpi

getEditorPaneGeneralTitle()

Returns the general pane title.

public static getEditorPaneGeneralTitle() : string
Tags
Return values
string —

getExportUrl()

Generates the URL to open when exporting this preset

public getExportUrl([mixed $sContextIDs = NULL ][, array<string|int, string> $asOtherParams = array() ][, string $sBase = 'external' ]) : string
Parameters
$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()

Tags
Return values
string —

a HTTP URL that would generate the required document

getFormat()

Gets the requested format like pdf, html or smart

public getFormat() : string
Tags
access

public

Return values
string —

the format

getID()

Gets the ID of the Preset as stored in the DB

public getID() : int
Tags
access

public

Return values
int —

the ID

getLabel()

Gets the Label attribute.

public getLabel() : string
Tags
access

public

Return values
string —

the label attribute

getLanguage()

Gets the Language ID selected for this preset

public getLanguage() : int
Tags
access

public

Return values
int —

the language ID

getLanguageAsObject()

Gets the Language as Object selected for this preset

public getLanguageAsObject() : CSLanguage
Tags
access

public

Return values
CSLanguage —

the language object

getLanguageID()

Each Preset also defines a language to use

public getLanguageID() : int
Tags
access

public

Return values
int —

the LanguageID for this preset

getLanguageShortName()

Each Preset also defines a language to use

public getLanguageShortName() : string
Tags
access

public

Return values
string —

the short name of the language to use for this preset

getMamReferencesID()

Defines if the exported document with this preset should be stored in the Mam

public getMamReferencesID() : bool
Tags
access

public

Return values
bool —

true if Mam Refernces should be stored

getMarksAndBleeds()

Gets the MarksAndBleeds defined by this preset

public getMarksAndBleeds() : string
Tags
access

public

Return values
string —

options selected from the drop down

getName()

Returns the name value of the current smart preset.

public getName() : string
Tags
Return values
string —

with the name value of the current smart preset.

getPdfAdminPassword()

Returns the PDF Admin Password

public getPdfAdminPassword() : string
Tags
access

public

Return values
string —

the admin password

getPdfAllowsAnnotation()

Returns true if the user is allowed to annotate the PDF

public getPdfAllowsAnnotation() : bool
Tags
access

public

Return values
bool —

true if annotation is allowed

getPdfAllowsCopying()

Returns true if the user is allowed to copy the content of the PDF

public getPdfAllowsCopying() : bool
Tags
access

public

Return values
bool —

true if copying is allowed

getPdfAllowsModification()

Returns true if the user is allowed to modify the content of the PDF

public getPdfAllowsModification() : bool
Tags
access

public

Return values
bool —

true if modification is allowed

getPdfAllowsPrinting()

Returns true if the user is allowed to print the PDF

public getPdfAllowsPrinting() : bool
Tags
access

public

Return values
bool —

true if printing is allowed

getPdfAuthor()

Returns the PDF Author

public getPdfAuthor() : string
Tags
access

public

Return values
string —

the PDF Author

getPdfConformance()

Gets the PDF conformance of the Preset

public getPdfConformance() : string
Tags
access

public

Return values
string —

conformance set for preset.

getPdfKeywords()

Returns the PDF Keywords

public getPdfKeywords() : string
Tags
access

public

Return values
string —

the PDF Keywords

getPdfSubject()

Returns the PDF Subject

public getPdfSubject() : string
Tags
access

public

Return values
string —

the PDF Subject

getPdfTitle()

Returns the PDF Title

public getPdfTitle() : string
Tags
access

public

Return values
string —

the PDF Title

getPdfUserPassword()

Returns the PDF User Password

public getPdfUserPassword() : string
Tags
access

public

Return values
string —

the user password

getPdfVersion()

Gets the PDF verion of the Preset

public getPdfVersion() : float
Tags
access

public

Return values
float —

getPimReferencesID()

Defines if the exported document with this preset should be stored in the Pim

public getPimReferencesID() : bool
Tags
access

public

Return values
bool —

true if Pim Refernces should be stored

getRecord()

Returns the internal CONTENTSERV Record object for this preset api object

public getRecord() : Smartpreset
Tags
access

public

Return values
Smartpreset —

getSaveDocuments()

Defines if the exported document with this preset should be stored in the MAM

public getSaveDocuments() : bool
Tags
access

public

Return values
bool —

true if documents should be stored

getSaveToFolderID()

Defines to which base folder Smart Documents should be exported

public getSaveToFolderID() : int
Tags
access

public

Return values
int —

the MAM ID of the folder where or within exported document should be stored

getSaveToSubFolder()

Defines to which sub folder and file name Smart Documents should be exported relative to the SaveFoFolderID Setting

public getSaveToSubFolder() : string
Tags
access

public

Return values
string —

a pattern or real file name relative to the SaveToFolder

getSplitDocuments()

Tells if the separate documents is checked and returns the value as 1

public getSplitDocuments() : bool
Tags
access

public

Return values
bool —

TRUE if the checkbox is checked

getTemplate()

Gets the Template Short Name of the Preset

public getTemplate() : string
Tags
access

public

Return values
string —

the template short name

getUsedMamFileIds()

Gets the array of used mam files .

public getUsedMamFileIds() : array<string|int, mixed>
Tags
access

public

Return values
array<string|int, mixed> —

of Mam ids.

getUserAccess()

Gets the UserAccess attribute.

public getUserAccess() : int
Tags
access

public

Return values
int —

UserAccess attribute

getUserAccessFormatted()

Gets the UserAccess type in a human readable format

public getUserAccessFormatted() : string
Tags
access

public

Return values
string —

UserAccess

getUserAccessIDs()

Gets the UserIDs attribute.

public getUserAccessIDs() : string
Tags
access

public

Return values
string —

UserIDs attribute

getValue()

Returns a value from the inner record object

public getValue(string $name[, mixed $default = '' ]) : string
Parameters
$name : string

the name of the value that should be returned

$default : mixed = ''
Tags
access

public

Return values
string —

getWatermark()

Returns the watermark file name within the folder smart/gui/images/watermark to be used If the name is "custom" then the MAMFile in the WatermarkID should be used

public getWatermark() : string
Tags
access

public

Return values
string —

the file name of the of the Watermark Image within the watermark folder

getWatermarkID()

Returns the MamID of a Watermark Image that should be added to all pages

public getWatermarkID() : int
Tags
access

public

Return values
int —

the MamFileID of the Watermark Image

isAvailableForCurrentUser()

Check if the current user is allowed to use the REST service.

public isAvailableForCurrentUser() : bool

First, this method checks the value of the field UserAccess UserAccess==0, means all users but Anonymous have access to the service UserAccess==1, means all users including Anonymous have access to the service UserAccess==2, means only Users with UserIDs mentioned in the choser have access to the service

Tags
access

public

Return values
bool —

current user allowed to use the REST service

isDisabled()

Tells if the preset has the "Disabled" checkbox set in the preset configuration

public isDisabled() : bool
Tags
access

public

Return values
bool —

TRUE if the preset is disabled

IsDownloadActivated()

Returns a boolean whether the preset has activated the download.

public IsDownloadActivated() : bool|string
Tags
Return values
bool|string —

isPDFFormat()

Checks if the current format is a PDF format.

public isPDFFormat() : bool
Tags
Return values
bool —

isPdfReactorFormat()

Checks if the current format is a PDF reactor format.

public isPdfReactorFormat() : bool
Tags
Return values
bool —

loadFromRequest()

Overwrites a given CSSmartPreset object with settings from the current HTTP GET or POST parameters This method can be used to load a preset on the fly from a request

public loadFromRequest() : void
Tags
access

public

Return values
void —

render()

Renders the Preset according to all its settings

public render([bool $stream = TRUE ]) : mixed
Parameters
$stream : bool = TRUE

if set to TRUE the file content is directly returned, otherwise a file ID is returned

Tags
access

public

Return values
mixed —

depending on the preset format settings and the stream parameter

setColorspace()

Sets the colorspace

public setColorspace(string $colorspace) : mixed
Parameters
$colorspace : string

like rgb or cmyk

Tags
access

public

Return values
mixed —

setContextClass()

Sets the context class of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The context class defines the type of these objects separated by commas.

public setContextClass(string $class) : void
Parameters
$class : string

the class of the context objects

Tags
access

public

Return values
void —

setContextIDs()

Sets the ContextIDs field of the preset Each Preset can be used within a context. Normally this would be for example the product from which the Smart Export was triggered. The ContextIDs are the IDs of these objects separated by commas.

public setContextIDs(string $IDs) : void
Parameters
$IDs : string

the comma separated IDs of the context objects

Tags
access

public

Return values
void —

setCSSLink()

It is possible to provide CSSLinks with a CSSmartPreset that should be added at the end of the CSS processing chain and overwrite other standard settings

public setCSSLink(mixed $cssLink) : void
Parameters
$cssLink : mixed
Tags
access

public

Return values
void —

setDescription()

Set the Description attribute.

public setDescription(string $description) : void
Parameters
$description : string

the description value

Tags
access

public

Return values
void —

setDisabled()

Disables or enables a preset

public setDisabled([bool $disabled = TRUE ]) : void
Parameters
$disabled : bool = TRUE

if TRUE the preset will not be usable

Tags
access

public

Return values
void —

setDownloadType()

Sets the download type for this preset.

public setDownloadType([int $iType = self::DOWNLOAD_TYPE_DEFAULT ]) : mixed

Available types:

  • CSSmartPreset::DOWNLOAD_TYPE_DEFAULT
  • CSSmartPreset::DOWNLOAD_TYPE_ACTIVE
  • CSSmartPreset::DOWNLOAD_TYPE_INACTIVE
Parameters
$iType : int = self::DOWNLOAD_TYPE_DEFAULT
Tags
Return values
mixed —

setDpi()

Sets the Dots per Inch defined by this preset

public setDpi(int $dpi) : void
Parameters
$dpi : int

the the DPI

Tags
access

public

Return values
void —

setFormat()

Sets the requested file format like pdf, html or smart

public setFormat(string $format) : void
Parameters
$format : string

the format

Tags
access

public

Return values
void —

setLabel()

Set the Label attribute.

public setLabel(string $sLabelField) : void
Parameters
$sLabelField : string

Label value

Tags
access

public

Return values
void —

setLanguage()

Overwrites the language ID set with this CSSmartPreset

public setLanguage(CSLanguage|Language|string|int $mLanguageID) : mixed
Parameters
$mLanguageID : CSLanguage|Language|string|int

The language which should be set in the smart preset.

The language can be defined as ID, short name or as language object.

Tags
access

public

Return values
mixed —

setMamReferencesID()

Defines to the attribute where to set the MAM References.

public setMamReferencesID(mixed $saveMamReferences) : int
Parameters
$saveMamReferences : mixed
Tags
access

public

Return values
int —

the Attribute ID of the attribute where the MAM references to be stored

setMarksAndBleeds()

Sets the MarksAndBleeds

public setMarksAndBleeds(string $sMarksAndBleeds) : mixed
Parameters
$sMarksAndBleeds : string

options selected from the drop down

Tags
access

public

Return values
mixed —

setName()

Sets the name for the current smart preset.

public setName(string $sName) : mixed
Parameters
$sName : string

The target smart preset name.

Tags
Return values
mixed —

setPdfAdminPassword()

Sets the PDF User Password

public setPdfAdminPassword(string $password) : mixed
Parameters
$password : string

the PDF User Password

Tags
access

public

Return values
mixed —

setPdfAllowsAnnotation()

Sets the PDF right to annotate the content in this pdf

public setPdfAllowsAnnotation(bool $boolean) : mixed
Parameters
$boolean : bool

true if the user should be able to annotate the content of the PDF

Tags
access

public

Return values
mixed —

setPdfAllowsCopying()

Sets the PDF right to copy content out of this document

public setPdfAllowsCopying(bool $boolean) : mixed
Parameters
$boolean : bool

true if the content should be possible to copy

Tags
access

public

Return values
mixed —

setPdfAllowsModification()

Sets the PDF right to modify content in this pdf

public setPdfAllowsModification(bool $boolean) : mixed
Parameters
$boolean : bool

true if the user should be able to modify the content of the PDF

Tags
access

public

Return values
mixed —

setPdfAllowsPrinting()

Sets the PDF right to print this document

public setPdfAllowsPrinting(bool $boolean) : mixed
Parameters
$boolean : bool

true if this document should be printable

Tags
access

public

Return values
mixed —

setPdfAuthor()

Sets the PDF Author

public setPdfAuthor(string $author) : mixed
Parameters
$author : string

the PDF Author

Tags
access

public

Return values
mixed —

setPdfConformance()

Sets the PDF conformance of the Preset

public setPdfConformance(string $conformance) : void
Parameters
$conformance : string

the conformance like PDF or PDFUA1

Tags
access

public

Return values
void —

setPdfKeywords()

Sets the PDF Keywords

public setPdfKeywords(string $keywords) : mixed
Parameters
$keywords : string

the PDF Keywords

Tags
access

public

Return values
mixed —

setPdfSubject()

Sets the PDF Subject

public setPdfSubject(string $subject) : mixed
Parameters
$subject : string

the PDF Subject

Tags
access

public

Return values
mixed —

setPdfTitle()

Sets the PDF Title

public setPdfTitle(string $title) : mixed
Parameters
$title : string

the PDF Title

Tags
access

public

Return values
mixed —

setPdfUserPassword()

Sets the PDF User Password

public setPdfUserPassword(string $password) : mixed
Parameters
$password : string

the PDF User Password

Tags
access

public

Return values
mixed —

setPdfVersion()

Sets the PDF version of the Preset

public setPdfVersion(string $version) : void
Parameters
$version : string

the version like 1.7

Tags
access

public

Return values
void —

setPimReferencesID()

Defines to the attribute where to set the PIM References.

public setPimReferencesID(mixed $savePimReferences) : int
Parameters
$savePimReferences : mixed
Tags
access

public

Return values
int —

the Attribute ID of the attribute where the pim references to be stored

setSaveDocuments()

Defines if the exported document with this preset should be stored in the MAM

public setSaveDocuments(bool $save) : void
Parameters
$save : bool

true if documents should be stored

Tags
access

public

Return values
void —

setSaveToFolderID()

Defines to which base folder Smart Documents should be exported

public setSaveToFolderID(int $saveToFolderID) : mixed
Parameters
$saveToFolderID : int

the MAM ID of the folder where or within exported document should be stored

Tags
access

public

Return values
mixed —

setSaveToSubFolderID()

Defines to which sub folder and file name Smart Documents should be exported relative to the SaveFoFolderID Setting

public setSaveToSubFolderID(string $saveToSubFolder) : string
Parameters
$saveToSubFolder : string
Tags
access

public

Return values
string —

a pattern or real file name relative to the SaveToFolder

setSplitDocuments()

Allows whether separate documents should be generated for each context id

public setSplitDocuments(bool $boolean) : void
Parameters
$boolean : bool

if true it will set SplitDocuments for each context id

Tags
access

public

Return values
void —

setTemplate()

Sets the Template Short Name of the Preset

public setTemplate(string $template) : void
Parameters
$template : string

the template short name like "Datasheet"

Tags
access

public

Return values
void —

setUserAccess()

Set the UserAccess attribute.

public setUserAccess(int $userAccess) : void
Parameters
$userAccess : int

UserAccess value

Tags
access

public

Return values
void —

setValue()

Sets a value to the the inner record object

public setValue(string $name, string $value) : void
Parameters
$name : string

the name of the value that should be set

$value : string

the value that should be set

Tags
access

public

Return values
void —

setWatermark()

Sets the watermark file name within the folder smart/gui/images/watermark to be used If the name is "custom" then the MAMFile in the WatermarkID should be used

public setWatermark(string $watermark) : void
Parameters
$watermark : string

the name of the file within the watermark folder to be used

Tags
access

public

Return values
void —

setWatermarkID()

Sets the MamFileID of a Watermark Image that should be added to all pages

public setWatermarkID(int $MamFileID) : void
Parameters
$MamFileID : int

the ID of the MamFile to be used as Watermark

Tags
access

public

Return values
void —

store()

Stores the inner record with the current preset data to the database

public store() : void
Tags
access

public

Return values
void — 

        

        
    




    

    

                

    

        

            
Search results