Edit on GitHub

Object Data Types

The entire list of data types is indicated below:

Text Datatypes

Name Description
input text input field
textarea textarea
wysiwyg text area with formatting options through a WYSIWYG editor
password password field

Number Datatypes

Name Description
numeric spinner field for number input
slider number input with slider widget (min - max slider)
quantity value number input with an additional unit. available units can be configured centrally.

Date Datatypes

Name Description
date calendar date selector
date & time calendar date selector + combo box for time
time combo box for time

Select Datatypes

Name Description
select combo box
user combo box to select from all existing pimcore users (available since build 716)

In the user settings the object dependencies of each user are shown in the second tab panel.
All objects which reference the selected user are listed in a grid view.

If one needs to find out which objects hold a reference to a specific user, the Pimcore\\Tool\\Admin::getObjectsReferencingUser($userId) method can be used to find all referencing objects.
country combo box with predefined country list from Zend_Locale
language combo box with predefined language list from Zend_Locale
multiselect combo box with multiple select
countries combo box with multiple select and predefined country list from Zend_Locale
languages combo box with multiple select and combo box with multiple select and predefined language list from Zend_Locale

Relation Datatypes

Name Description
href reference to a pimcore document, object or asset
objects collection of pimcore object references
multihrefmedatadata collection of references to pimcore documents, objects, assets with additional metadata on the relation
objectsmetadata collection of pimcore object references with additional metadata on the relation
nonownerobjects object relations which are owned by a different object
multihref collection of references to pimcore documents, objects, assets

Structured Datatypes

Name Description
block repeatable block of attributes within an object
classificationstore advanced store for classification systems like ETIM, ecl@ss, etc.
table table input
structuredtable table with predefined rows and columns
fieldcollections A collection of fields that can be added to the object
objectbricks Bricks of attributes, that can be added to objects
localizedfields Set of attributes that can be translated
keyvalue simple key/value pairs

Geographic Datatypes

Name Description
geopoint google maps widget to find longitude/latitude
geobounds google maps widget to define geographical bounds
geopolygon google maps widget to define a geographical area

Other Datatypes

Name Description
image drop area & preview for a pimcore image asset
externalimage relation to an image that is not stored in pimcore
imageadvanced drop area & preview for a pimcore image asset with additional features for markers, hotspots, cropping
video drop area & preview for a pimcore video asset
checkbox checkbox
link link selector with link target
calculatedvalue datatype for calculated values - calculation can be defined with a php class

CRM Datatypes

Name Description
firstname typed input field for firstname
lastname typed input field for lastname
email typed input field for email including validation
gender typed and prefilled select for gender
newsletteractive typed checkbox if newsletter is active
newsletterconfirmed typed checkbox if newsletter is confirmed
persona typed selectbox for personas defined within Pimcore
personas typed selectbox with multiselect for personas defined within Pimcore

General Aspects

All data types are wrapped in an object derived from Pimcore\Model\Object\Class\Data. These data type objects provide getters and setters and they define the Description in the frontend. Data type objects are displayed in the first column of the table above. The second column indicates the underlying data type class and the third column outlines the Description used in pimcore to fill in, edit and display data objects.

Besides the name, which is the name of the object's property and the title, which is shown in the GUI, an object field has the general configuration options listed below. The title can be translated for different system languages. Please see the article about Translations to find out how to add object field translations.

  • mandatory: Makes the field mandatory and does not allow saving the object when it is empty
  • not editable: Does not allow a change of this field's value in pimcore backend (data change can only be done programmatically)
  • invisible: The field is not visible in pimcore
  • visible in grid view: Determines if the field's data column is shown in the object grid view, or hidden (meaning it has to be activated manually)
  • visible in search result: Determines if the field's data column is shown in the search results grid, or hidden (meaning it has to be activated manually)
  • indexed: puts an index on this column in the database Moreover, each data field can have a tooltip, which is shown when the mouse hovers over the input field.

Data Field Settings Data Field Settings

The layout settings allow to apply custom CSS to any object field.

Data Field Settings

WARNING
Please note that renaming a field means the loss of data from the field in all objects using this class.

See sub-pages of this page for detail documentation of different data types.