Contentserv PHP API

CSPms extends CSItemApi
in package

PIM

VALUE_RANGE_TYPE_ID_TAGS


    public
    mixed
    VALUE_RANGE_TYPE_ID_TAGS
    = -41

$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')

$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')

$tableApiClass


    public
        string
    $tableApiClass

$tableRowApiClass


    public
        string
    $tableRowApiClass

__construct()


    public
                __construct([mixed $itemClass = null ]) : mixed

Parameters

$itemClass : mixed = null

Return values

mixed —

createClass()

Creates a new CSPmsField representing a Class at the targeted position


    public
            static    createClass(string $label[, int $targetID = null ]) : CSPmsField

Parameters

$label : string: the label of the new class
$targetID : int = null: ID of the class folder

Return values

CSPmsField —

createField()

Creates a new CSPmsField at the targeted position


    public
            static    createField(string $label[, int $targetID = null ][, int $position = CSITEM_POSITION_CHILD ][, string $type = 'caption' ][, string $typemodule = 'core' ][, bool $loadTypeFromProject = false ][, bool $isConfiguration = false ]) : CSPmsField

Parameters

$label : string: the label of the new field
$targetID : int = null: ID of the targeted field
$position : int = CSITEM_POSITION_CHILD: position relative to the target field
$type : string = 'caption': the type of the field
$typemodule : string = 'core': name of the module the type is defined in
$loadTypeFromProject : bool = false: set this flag if the type is defined in the project
$isConfiguration : bool = false: set this flag to create a configuration

Return values

CSPmsField —

createProduct()

Creates a new CSPmsProduct at the targeted position.


    public
            static    createProduct(string $label[, int $targetID = null ][, int $position = CSITEM_POSITION_CHILD ], int $baseFieldID[, bool $isFolder = false ]) : CSPmsProduct

This is a synonym for the createItem method.

Parameters

$label : string: the label of the new product
$targetID : int = null: ID of the targeted product
$position : int = CSITEM_POSITION_CHILD: position relative to the target product
$baseFieldID : int: the id of the root field of the product
$isFolder : bool = false: set this flag to create a product folder

Return values

CSPmsProduct —

createProductFolder()

Creates a new CSItemApiItem as a folder at the targeted position


    public
            static    createProductFolder(string $label[, int $targetID = null ][, int $position = CSITEM_POSITION_CHILD ], int $baseFieldID) : CSItemApiItem

Parameters

$label : string: the label of the new product folder
$targetID : int = null: ID of the targeted product folder
$position : int = CSITEM_POSITION_CHILD: position relative to the target product folder
$baseFieldID : int: the id of the root field of the product folder

Return values

CSItemApiItem —

createView()

Creates a new CSPmsView at the targeted position


    public
            static    createView(string $label[, int $targetID = null ][, int $position = CSITEM_POSITION_CHILD ], int $baseFieldID[, int $productID = null ][, int $viewType = CSITEM_VIEW_SELF ][, int $iVersion = CSITEM_VIEW_VERSION_NEWEST ]) : CSPmsView

Parameters

$label : string: the label of the new view
$targetID : int = null: ID of the targeted view
$position : int = CSITEM_POSITION_CHILD: position relative to the target view
$baseFieldID : int: the id of the root field of the view
$productID : int = null: the id of the referenced item
$viewType : int = CSITEM_VIEW_SELF: the type of the view which is a CSITEM_VIEW_ constant
$iVersion : int = CSITEM_VIEW_VERSION_NEWEST: Defines the version to use when extending an item. This version can be specified either by using one of the CSITEM_VIEW_VERSION_*-constant or a specific version number.

Return values

CSPmsView —

createViewFromBookmark()

Creates a new View from a CSBookmark


    public
            static    createViewFromBookmark(CSBookmark $bookmark, int $parentID) : CSPmsView

Parameters

$bookmark : CSBookmark: is the CSBookmark to convert to a view
$parentID : int

Return values

CSPmsView —

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)

Return values

CSItemApiField —

Returns an instance of the CSItemApiField object

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.

Return values

CSItemComparator —

the newly created CSItemComparator-object that can be used for further configuration.

getExport()

Loads an existing view for a given ID


    public
            static    getExport([int $ID = null ]) : CSPmsExport

Parameters

$ID : int = null: of the view

Return values

CSPmsExport —

a CSPmsExport object for the given ID

getField()

Loads an existing field for a given ID


    public
            static    getField([int $ID = null ]) : CSPmsField

Parameters

$ID : int = null: of the field

Return values

CSPmsField —

a CSPmsField object for the given ID

getFieldForExternalKey()

Loads an existing CSPmsField.


    public
            static    getFieldForExternalKey(string $sExternalKey) : CSPmsField

Parameters

$sExternalKey : string: the external key of the file

Return values

CSPmsField —

getFields()

Returns an array with CSPmsFields matching the SQL filter condition in the given sort order and limit


    public
            static    getFields([string $filter = '1=1' ][, string $sortorder = '' ][, mixed $limit = '' ]) : array<string|int, CSPmsField>

Parameters

$filter : string = '1=1': SQL Filter condition
$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 CSPmsField should be returned

Return values

array<string|int, CSPmsField> —

either an array with the CSPmsFields or the first CSPmsField, if limit is set to 1

getInstance()


    public
            static    getInstance(mixed $apiName[, mixed $itemClass = null ]) : mixed

Parameters

$apiName : mixed
$itemClass : mixed = null

Return values

mixed —

getProduct()

Loads an existing CSPmsProduct.


    public
            static    getProduct([int $ID = null ]) : CSPmsProduct

This is a synonym for the getItem method.

Parameters

$ID : int = null: of the item

Return values

CSPmsProduct —

getProductForExternalKey()

Loads an existing CSPmsProduct.


    public
            static    getProductForExternalKey(string $externalKey) : CSPmsProduct

Parameters

$externalKey : string: the external key of the file

Return values

CSPmsProduct —

getProducts()

Returns an array with CSPmsProducts matching the SQL filter condition in the given sort order and limit.


    public
            static    getProducts([string $sFilter = '1=1' ][, string $sSortOrder = '' ][, mixed $mLimit = '' ][, bool $bIgnoreRights = false ]) : array<string|int, CSPmsProduct>|CSPmsProduct

This is a synonym for the getItems method and therefore all special syntax described there can be used.

Parameters

$sFilter : string = '1=1': SQL Filter condition
$sSortOrder : string = '': SQL Sort Order
$mLimit : mixed = '': either a string which is a SQL limit condition or the integer 1, if only the first matching CSPmsProduct should be returned
$bIgnoreRights : bool = false: whether the user rights should be ignored. If not only those views are returned the user may view.

Return values

array<string|int, CSPmsProduct>|CSPmsProduct —

Either an array with the CSPmsProducts or the first CSPmsProduct, if limit is set to 1

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

Return values

mixed —

either an array with the CSItemApiFields or the first CSItemApiField, if limit is set to 1

getSearchableFields()

Returns an array with CSPmsFields 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
                getSearchableFields([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

Return values

mixed —

either an array with the CSItemApiFields or the first CSItemApiField, if limit is set to 1

getValueGetter()

Returns a new CSItemValueGetter object


    public
            static    getValueGetter(mixed $mName) : CSItemValueGetter

Parameters

$mName : mixed: The name of the attribute to retrieve

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

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.

Return values

CSItemValuesGetter —

getValuesSetter()

Returns a new CSItemValuesSetter object


    public
            static    getValuesSetter() : CSItemValuesSetter

Return values

CSItemValuesSetter —

getView()

Loads an existing view for a given ID


    public
            static    getView([int $ID = null ]) : CSPmsView

Parameters

$ID : int = null: of the view

Return values

CSPmsView —

a CSPmsView object for the given ID

getViewForExternalKey()

Loads an existing CSPmsView.


    public
            static    getViewForExternalKey(string $sExternalKey) : CSPmsView

Parameters

$sExternalKey : string: the external key of the view

Return values

CSPmsView —

getViews()

Returns an array with CSPmsViews matching the SQL filter condition in the given sort order and limit.


    public
            static    getViews([string $filter = '1=1' ][, string $sortorder = '' ][, mixed $limit = '' ][, bool $ignoreRights = false ]) : array<string|int, CSPmsView>|CSPmsView

This is a synonym for the getViews method and therefore all special syntax described there can be used.

Parameters

$filter : string = '1=1': SQL Filter condition, where there are only simple filter conditions like ID or ParentID are allowed.
$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 CSPmsView should be returned
$ignoreRights : bool = false: whether the user rights should be ignored. If not only those views are returned the user may view.

Return values

array<string|int, CSPmsView>|CSPmsView —

either an array with the CSPmsViews or the first CSPmsView, if limit is set to 1

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

Return values

mixed —

CSPms extends CSItemApi in package PIM

Tags

Table of Contents

Constants

VALUE_RANGE_TYPE_ID_TAGS

Tags

Properties

$ENUM_SORTALGOS_FORMATTED

Tags

$ENUM_SORTTYPES_DESC

Tags

$tableApiClass

Tags

$tableRowApiClass

Tags

Methods

__construct()

Parameters

Tags

Return values

createClass()

Parameters

Tags

Return values

createField()

Parameters

Tags

Return values

createProduct()

Parameters

Tags

Return values

createProductFolder()

Parameters

Tags

Return values

createView()

Parameters

Tags

Return values

createViewFromBookmark()

Parameters

Tags

Return values

getApiFieldForExternalKey()

Parameters

Tags

Return values

getComparator()

Parameters

Tags

Return values

getExport()

Parameters

Tags

Return values

getField()

Parameters

Tags

Return values

getFieldForExternalKey()

Parameters

Tags

Return values

getFields()

Parameters

Tags

Return values

getInstance()

Parameters

Tags

Return values

getProduct()

Parameters

Tags

Return values

getProductForExternalKey()

Parameters

Tags

Return values

CSPms extends CSItemApi
in package

PIM