Global navigation

   Documentation Center
   eZ Studio & eZ Platform
     User Manual
     Technical Manual
     Glossary
   eZ Publish 4.x / legacy

 
eZ Publish (5.x)

eZ Publish 5.x | For eZ Platform & eZ Studio topics see Technical manual and User manual, for eZ Publish 4.x and Legacy topics see eZ Publish legacy

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: add horizonal rules

This field type represents keywords.

NameInternal nameExpected input
Keywordezkeywordstring[]|string

Table of contents:

Table of Contents
minLevel2

Description


This FieldType stores single or several keywords as comma separated keywords as a string or array of string keywords.

Input expectations


TypeExample
string
"documentation"
string

"php, eZ Publish, html5"

string[]array( "eZ Systems", "Enterprise", "User Experience Management" )

Value object


Properties

The Value class of this field type contains the following properties:

PropertyTypeDescription
$valuestring[]|stringThis property will be used to store multiple comma separated keywords, or single keywords, provided as a string.
Code Block
languagephp
titleValue object content example
$keyword->value = "php, css3, html5, eZ Publish"

Constructor

The Keyword\Value constructor will initialize a new Value object with the value provided. It expects a string.

Code Block
languagephp
titleConstructor example
// Instantiates a Keyword Value object
$keywordValue = new Keyword\Value( "php5, css3, html5, solr, memcached" );