Message-ID: <571656567.4160.1485858043752.JavaMail.confluence@ip-10-127-227-164> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_4159_1758939679.1485858043751" ------=_Part_4159_1758939679.1485858043751 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html Settings schema and allowed validators

Settings schema and allowed validators

=20
=20
=20
=20

Internal Field Type conventions and best practices

FieldType->$settingsSchema and FieldType->$allowedValidators are i= ntentionally left free-form, to give broadest freedom to Field Type develop= ers. However, for internal Field Types (aka those delivered with eZ Platfor= m), a common standard should be established as best practice. The purpose o= f this page is to collect and unify this standard.

Settings schem= a

The general format of the settings schema of a Field Type is a hashmap o= f setting names, assigned to their type and default value, e.g.:

array(
    'myFancySetting' =3D> array(
        'type' =3D>=
; 'int',
        'default' =3D> 23,
    ),
    'myOtherFancySet=
ting' =3D> array(
        'type' =3D> 'string',
        'defaul=
t' =3D> 'Sindelfingen',
    ),
);

The type should be either a valid PHP type shortcut (TB discussed) or on= e of the following special types:

  • Hash (a simple hash map)
  • Choice (an enumeration)
  • <<<YOUR TYPE HERE>>>

 

=20
=20
=20
=20

 

=20
=20
=20
------=_Part_4159_1758939679.1485858043751--