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.

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This Field Type represents a hyperlink. It is formed by the combination of a link and the respective text.

NameInternal nameExpected input
Urlezurlstring

Description

This Field Type makes possible to store and retrieve a url. It is formed by the combination of a link and the respective text.

PHP API Field Type

Input expectations

TypeExample
string
"http://www.ez.no", "eZ Systems"

Value object

Properties

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

PropertyTypeDescription
$linkstringThis property will be used to store the link provided to the value of this Field Type.
$textstringThis property will be used to store the text to represent the stored link provided to the value of this Field Type.
Code Block
languagephp
titleValue object content example
$url->link = "http://www.ez.no";
$url->text = "eZ Systems";
Constructor

The Url\Value constructor will initialize a new Value object with the value provided. It expects two comma-separated strings, corresponding to the link and text.

Code Block
languagephp
titleConstructor example
// Instantiates an Url Value object
$UrlValue = new Url\Value( "http://www.ez.no", "eZ Systems" );

Validation

This Field Type does not perform validation.

Settings

This Field Type does not have settings.