Contentserv PHP API

Item

Packages

Plugins
CSItemComparator
CSItemExporter

Interfaces, Classes and Traits

_CSItemValueHandler
Defines an abstract class with the necessary methods for the CSItemValueGetter & CSItemValueSetter classes
CSItemApi
CSItemApiField
Defines a field that a item or view may have
CSItemApiHistory
Defines API method of Item Action History in the ItemModell
CSItemApiItem
Defines API method of Items in the Item Model
CSItemApiItemMultiValueSetter
This class is designed to update multiple values for multiple Items.
CSItemApiRating
Defines API method of ratings in the ItemModell
CSItemApiReference
Defines a reference between two items
CSItemApiReferenceList
Defines a list of references on a item to an attribute (field/configuration)
CSItemApiTable
Defines an inner table on a item
CSItemApiTableHistory
Defines API method of Item Action History in the ItemModell
CSItemApiTableRow
Defines a row in an inner table on a item
CSItemApiTableVersionHelper
Defines a helper table API to store all modified (changed, added and deleted) rows for an item configuration.
CSItemApiView
Defines a view (collection or structure) on a item
CSItemException
Represents an Item exception and takes care of the error handling in the Item APIs
CSItemMedium
A medium object to store various options from a medium type
CSItemSearchFilter
CSItemValueGetter
Defines an abstract class with the necessary methods for the CSItemValueGetter & CSItemValueSetter classes
CSItemValueSetter
Defines setter for Item values in the Item Model
CSItemValuesGetter
Defines an abstract class with the necessary methods for the CSItemValueGetter & CSItemValueSetter classes
CSItemValuesSetter
Defines an abstract class with the necessary methods for the CSItemValueGetter & CSItemValueSetter classes
CSItem
CSDeleteAbandonedAttributeValuesScript
The base of all ActiveScript plugins To be included, it must be placed in a plugins/script subfolder with a file name ending with Script.php.

Table of Contents

CS_SORT_CASE_STRING_ASC  = 2
Sort the values in an ascending casesensitive string order
CS_SORT_CASE_STRING_DESC  = 3
Sort the values in a descending casesensitive string order
CS_SORT_DATE_ASC  = 8
Sort the values in an ascending date order
CS_SORT_DATE_DESC  = 9
Sort the values in a descending date order
CS_SORT_DATETIME_ASC  = 12
Sort the values in an ascending date-time order
CS_SORT_DATETIME_DESC  = 13
Sort the values in a descending date-time order
CS_SORT_DEFAULT_ASC  = 6
Sort the values in an ascending caseinsensitive string order, if the values are string or in ascending numerical order, if the values are numbers
CS_SORT_DEFAULT_DESC  = 7
Sort the values in an descending caseinsensitive string order, if the values are string or in descending numerical order, if the values are numbers
CS_SORT_FORMATTED_ASC  = 10
Formats the values and orders them in an ascending case insensitive ascending order
CS_SORT_FORMATTED_DESC  = 11
Formats the values and orders them in an ascending case insensitive descending order
CS_SORT_NUMERICAL_ASC  = 4
Sort the values in an ascending numerical order
CS_SORT_NUMERICAL_DESC  = 5
Sort the values in a descending numerical order
CS_SORT_STRING_ASC  = 0
Sort the values in an ascending caseinsensitive string order
CS_SORT_STRING_DESC  = 1
Sort the values in a descending caseinsensitive string order
CSITEM_MEDIUM_COMPARATOR  = \CSItemMedium::COMPARATOR
Returns the values as comparator compatible strings
CSITEM_MEDIUM_EDITOR  = \CSItemMedium::EDITOR
Returns the values compatible for editor
CSITEM_MEDIUM_HTML  = \CSItemMedium::DEFAULT
Returns the values as translation compatible strings
CSITEM_MEDIUM_MASSEDITOR  = \CSItemMedium::MASSEDITOR
Returns the values compatible for masseditor
CSITEM_MEDIUM_PORTAL  = \CSItemMedium::TEXT
Returns the values as portal compatible strings
CSITEM_MEDIUM_TEXT  = \CSItemMedium::TEXT
Returns the values from search index
CSITEM_MEDIUM_TMS  = \CSItemMedium::TRANSLATIONMANAGER
Returns the values as translation compatible strings
CSITEM_POSITION_AFTER  = 2
Defines a location as sibbling after
CSITEM_POSITION_BEFORE  = 1
Defines a location as sibbling before
CSITEM_POSITION_CHILD  = 4
Defines a location as child after
CSITEM_VALUES_ARRAY  = 2
Returns the value as array with all parameter
CSITEM_VALUES_COMPARATOR  = 5
Returns the values as formatted for CSItemComparator
CSITEM_VALUES_CSV  = 4
Returns the values as csv compatible strings
CSITEM_VALUES_FORMATTED  = 1
Returns the formatted value
CSITEM_VALUES_UNFORMATTED  = 0
Returns the value as it is stored in the database
CSITEM_VIEW_CHILDREN  = 2
Defines a view to the products children
CSITEM_VIEW_SELF  = 0
Defines a view to the product itself
CSITEM_VIEW_SELF_AND_CHILDREN  = 1
Defines a view to the product and all it's children
CSITEM_VIEW_VERSION_CURRENT  = -1
Defines the version to use when extending an item. In this case current version is used.
CSITEM_VIEW_VERSION_NEWEST  = 0
Defines the version to use when extending an item. In this case always the newest version is used.
MEDIUM_UNFORMATTED_TEXT  = 17
Returns the values without html tags

Constants

CS_SORT_CASE_STRING_ASC

Sort the values in an ascending casesensitive string order

public mixed CS_SORT_CASE_STRING_ASC = 2
Tags
access

public

CS_SORT_CASE_STRING_DESC

Sort the values in a descending casesensitive string order

public mixed CS_SORT_CASE_STRING_DESC = 3
Tags
access

public

CS_SORT_DATE_ASC

Sort the values in an ascending date order

public mixed CS_SORT_DATE_ASC = 8
Tags
access

public

CS_SORT_DATE_DESC

Sort the values in a descending date order

public mixed CS_SORT_DATE_DESC = 9
Tags
access

public

CS_SORT_DATETIME_ASC

Sort the values in an ascending date-time order

public mixed CS_SORT_DATETIME_ASC = 12
Tags
access

public

CS_SORT_DATETIME_DESC

Sort the values in a descending date-time order

public mixed CS_SORT_DATETIME_DESC = 13
Tags
access

public

CS_SORT_DEFAULT_ASC

Sort the values in an ascending caseinsensitive string order, if the values are string or in ascending numerical order, if the values are numbers

public mixed CS_SORT_DEFAULT_ASC = 6
Tags
access

public

CS_SORT_DEFAULT_DESC

Sort the values in an descending caseinsensitive string order, if the values are string or in descending numerical order, if the values are numbers

public mixed CS_SORT_DEFAULT_DESC = 7
Tags
access

public

CS_SORT_FORMATTED_ASC

Formats the values and orders them in an ascending case insensitive ascending order

public mixed CS_SORT_FORMATTED_ASC = 10
Tags
access

public

CS_SORT_FORMATTED_DESC

Formats the values and orders them in an ascending case insensitive descending order

public mixed CS_SORT_FORMATTED_DESC = 11
Tags
access

public

CS_SORT_NUMERICAL_ASC

Sort the values in an ascending numerical order

public mixed CS_SORT_NUMERICAL_ASC = 4
Tags
access

public

CS_SORT_NUMERICAL_DESC

Sort the values in a descending numerical order

public mixed CS_SORT_NUMERICAL_DESC = 5
Tags
access

public

CS_SORT_STRING_ASC

Sort the values in an ascending caseinsensitive string order

public mixed CS_SORT_STRING_ASC = 0
Tags
access

public

CS_SORT_STRING_DESC

Sort the values in a descending caseinsensitive string order

public mixed CS_SORT_STRING_DESC = 1
Tags
access

public

CSITEM_MEDIUM_COMPARATOR

Returns the values as comparator compatible strings

public mixed CSITEM_MEDIUM_COMPARATOR = \CSItemMedium::COMPARATOR
Tags
access

public

deprecated

Deprecated since CS21.6, use CSItemMedium::COMPARATOR instead.

CSITEM_MEDIUM_EDITOR

Returns the values compatible for editor

public mixed CSITEM_MEDIUM_EDITOR = \CSItemMedium::EDITOR
Tags
access

public

deprecated

Deprecated since CS21.6, use CSItemMedium::EDITOR instead.

CSITEM_MEDIUM_HTML

Returns the values as translation compatible strings

public mixed CSITEM_MEDIUM_HTML = \CSItemMedium::DEFAULT
Tags
access

public

deprecated

Deprecated since CS21.6, use CSItemMedium::HTML instead.

CSITEM_MEDIUM_MASSEDITOR

Returns the values compatible for masseditor

public mixed CSITEM_MEDIUM_MASSEDITOR = \CSItemMedium::MASSEDITOR
Tags
access

public

deprecated

Deprecated since CS21.6, use CSItemMedium::MASSEDITOR instead.

CSITEM_MEDIUM_PORTAL

Returns the values as portal compatible strings

public mixed CSITEM_MEDIUM_PORTAL = \CSItemMedium::TEXT
Tags
access

public

deprecated

Deprecated since CS21.6, use CSItemMedium::TEXT instead.

CSITEM_MEDIUM_TEXT

Returns the values from search index

public mixed CSITEM_MEDIUM_TEXT = \CSItemMedium::TEXT
Tags
access

public

deprecated

Deprecated since CS21.6, use CSItemMedium::TEXT instead.

CSITEM_MEDIUM_TMS

Returns the values as translation compatible strings

public mixed CSITEM_MEDIUM_TMS = \CSItemMedium::TRANSLATIONMANAGER
Tags
access

public

deprecated

Deprecated since CS21.6, use CSItemMedium::TRANSLATIONMANAGER instead.

CSITEM_POSITION_AFTER

Defines a location as sibbling after

public mixed CSITEM_POSITION_AFTER = 2
Tags
access

public

CSITEM_POSITION_BEFORE

Defines a location as sibbling before

public mixed CSITEM_POSITION_BEFORE = 1
Tags
access

public

CSITEM_POSITION_CHILD

Defines a location as child after

public mixed CSITEM_POSITION_CHILD = 4
Tags
access

public

CSITEM_VALUES_ARRAY

Returns the value as array with all parameter

public mixed CSITEM_VALUES_ARRAY = 2
Tags
access

public

CSITEM_VALUES_COMPARATOR

Returns the values as formatted for CSItemComparator

public mixed CSITEM_VALUES_COMPARATOR = 5
Tags
access

public

CSITEM_VALUES_CSV

Returns the values as csv compatible strings

public mixed CSITEM_VALUES_CSV = 4
Tags
access

public

CSITEM_VALUES_FORMATTED

Returns the formatted value

public mixed CSITEM_VALUES_FORMATTED = 1
Tags
access

public

CSITEM_VALUES_UNFORMATTED

Returns the value as it is stored in the database

public mixed CSITEM_VALUES_UNFORMATTED = 0
Tags
access

public

CSITEM_VIEW_CHILDREN

Defines a view to the products children

public mixed CSITEM_VIEW_CHILDREN = 2
Tags
access

public

CSITEM_VIEW_SELF

Defines a view to the product itself

public mixed CSITEM_VIEW_SELF = 0
Tags
access

public

CSITEM_VIEW_SELF_AND_CHILDREN

Defines a view to the product and all it's children

public mixed CSITEM_VIEW_SELF_AND_CHILDREN = 1
Tags
access

public

CSITEM_VIEW_VERSION_CURRENT

Defines the version to use when extending an item. In this case current version is used.

public mixed CSITEM_VIEW_VERSION_CURRENT = -1
Tags
access

public

CSITEM_VIEW_VERSION_NEWEST

Defines the version to use when extending an item. In this case always the newest version is used.

public mixed CSITEM_VIEW_VERSION_NEWEST = 0
Tags
access

public

MEDIUM_UNFORMATTED_TEXT

Returns the values without html tags

public mixed MEDIUM_UNFORMATTED_TEXT = 17
Tags
access

public

Search results