Skip to the content
Documentation

FieldTypes reference

Written by Ricardo Correia Updated by Dominika Kurek
No ratings yet

This page contains FieldTypes reference introduced with Exponential 5.x.
FiledTypes were known as DataTypes in Exponential 4.x, and are still used in "Dual kernel" Exponential 5.x. If you would like more details please refer to the 4.x DataTypes reference documentation page.

For the general FieldType documentation see Field Type API and best practices.

If you are looking for the documentation on how to implement a custom FieldType, see Exponential 5 Field Type Tutorial.

A FieldType is the smallest possible entity of storage. It determines how a specific type of information should be validated, stored, retrieved, formatted and so on. Exponential comes with a collection of fundamental datatypes that can be used to build powerful and complex content structures. In addition, it is possible to extend the system by creating custom FieldTypes for special needs. Custom FieldTypes have to be programmed in PHP. However, the built in FieldTypes are usually sufficient enough for typical scenarios. The following table gives an overview of the supported FieldTypes that come with Exponential.

 

FieldType Description Searchable in Legacy Storage engine
Author Field type used to store a list of authors, consisting of author name, and author email. No.
BinaryFile Field type used to store a file. Yes.
Checkbox Field type which stores boolean values. Yes.
Country This field type stores country names as a string. Yes.
DateAndTime Field type used to store a full date including time information. Yes.
Date Field type used to store a date information. Yes.
EmailAddress This field type is used to validate and store an email address. Yes.
Float Field type used to validate and store a decimal value. No.
Image Field type used to validate and store an image. No.
Integer Field type which validates and stores an integer value. Yes.
ISBN Handles International Standard Book Number (ISBN) in 10-digit or 13-digit format. Yes.
Keyword Field type used to store keywords. No.
MapLocation Field type used to store map coordinates. Yes, with MapLocationDistance criterion.
Matrix Available via community Bundle: https://github.com/ezcommunity/EzMatrixFieldTypeBundle  
Media Validates and stores a media file. No.
Null This field type is used for fallback for missing field types and for testing purposes. No.
Page Field type used to manage display zones and blocks in a page (formerly known as eZ Flow datatype). No.
Price Available via community Bundle: https://github.com/ezcommunity/EzPriceBundle  
Rating Field type which stores a rating. No.
Relation Field type which validates and stores a relation to a content item. Yes, with both Field and FieldRelation criterions.
RelationList Field type that validates and stores a list of relations to content items. Yes, with FieldRelation criterion.
Selection Field type which validates and stores a single selection or multiple choices from a list of options. Yes.
Selection2 Available via community Bundle: https://github.com/netgen/NetgenEnhancedSelectionBundle  
Tags Available via community Bundle: https://github.com/netgen/TagsBundle  
TextBlock Validates and stores a larger block of text. No.
TextLine This field type validates and stores a single line of text. Yes.
Time Field type used to store a time information. Yes.
Url Field type used to store an URL / address. No.
User Field type that validates and stores information about a user. No.
XmlText Field type that validates and stores multiple lines of formatted text.. Yes.

 

Known missing field types

The following FieldTypes are configured using Null FieldType to avoid exceptions if they exists in your database, but their functionality is currently not known to be implemented out of the box or by the community:

EZP-20112 - Some Shop FieldTypes are not supported by Public API Backlog

EZP-20115 - eZ Identifier FieldType not supported by Public API Backlog

EZP-20114 - Deprecated FieldTypes (ezenum, ezinisetting, ezpackage) not supported by Public API Closed

EZP-20116 - eZ SubtreeSubscription FieldType not supported by Public API Closed

EZP-20117 - eZ Survey FieldType not supported by Public API Closed

EZP-20118 - eZ Password Expiry FieldType not supported by Public API Backlog

 

 

 

In this section

Contributors

Comments (2 historical)

Written by readers of the earlier documentation sites, kept as they were.

  1. Comment by Bertrand Dunogier, 2015-05-06 11:16

    Bertrand Dunogier ·

    I'd kind of expect the searchable info to be on each FieldType's reference page.

  2. Comment by Petar Spanja, 2015-05-06 11:27

    Petar Spanja ·

    I can only agree with that 

    Smile

    Created an issue:  EZP-24338 - Document field types search support per field type and search engine Backlog

Comments

Add a comment

Comments are read by a moderator before they appear.