General

  eZ Systems Website
  Editor documentation


  Developer documentation

  Back to the top

Skip to end of metadata
Go to start of metadata

This Field Type represents a block of unformatted text.

NameInternal nameExpected input type
TextBlockeztextstring

Description

The Field Type handles a block of multiple lines of unformatted text. It is capable of handling up to 16,777,216 characters.

PHP API Field Type

Input expectations

Type
Example
string
"This is a block of unformatted text"

Value object

Properties

The Value class of this Field Type contains the following properties:

Property
Type
Description
$textstringThis property will be used for the text content.
String representation

A TextBlock's string representation is the the $text property's value, as a string.

Constructor

The constructor for this value object will initialize a new Value object with the value provided. It accepts a string as argument and will import it to the $text attribute.

Validation

This Field Type does not perform any special validation of the input value.

Settings

Settings contain only one option:

NameTypeDefault valueDescription
textRowsinteger10Number of rows for the editing control in the administration interface.