General

  eZ Systems Website
  Editor documentation


  Developer documentation

  Back to the top

The documentation is moving!

We're moving our developer docs to Github and a new site.
The migration is still in progress, so please contact us in #documentation-contrib on eZ Community Slack if you have any questions or feedback.

This space will not be updated from now on except for critical fixes.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This page contains a reference of Field Types used in eZ Platform.

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

If you are looking for the documentation on how to implement a custom Field Type, see the Creating a Tweet Field Type tutorial.

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

 

FieldTypeDescriptionSearchable in Legacy Storage engine
AuthorStores a list of authors, each consisting of author name and author email.No
BinaryFileStores a file.Yes
CheckboxStores a boolean value.Yes
CountryStores country names as a string.Yes
DateAndTimeStores a full date including time information.Yes
DateStores date information.Yes
EmailAddressValidates and stores an email address.Yes
FloatValidates and stores a decimal value.No
ImageValidates and stores an image.No
IntegerValidates and stores an integer value.Yes
ISBNHandles International Standard Book Number (ISBN) in 10-digit or 13-digit format.Yes
KeywordStores keywords.No
MapLocationStores map coordinates.Yes, with MapLocationDistance criterion
MediaValidates and stores a media file.No
NullUsed as fallback for missing Field Types and for testing purposes.No
RatingStores a rating.No
RelationValidates and stores a relation to a Content item.Yes, with both Field and FieldRelation criterions
RelationListValidates and stores a list of relations to Content items.Yes, with FieldRelation criterion
RichText Field TypeValidates and stores structured rich text, and exposes it in several formats.Yes
SelectionValidates and stores a single selection or multiple choices from a list of options.Yes
TextBlockValidates and stores a larger block of text.No
TextLineValidates and stores a single line of text.Yes
TimeStores time information.Yes
UrlStores a URL / address.No
UserValidates and stores information about a user.No
XmlText Validates and stores multiple lines of formatted text.Yes

 

Known missing Field Types

The following Field Types are configured using Null Field Type 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

 

  • No labels