General

  eZ Systems Website
  Technical documentation
  Editor documentation

This Documentation contains:
 
Technical documentation:



⚠ WARNING ! This documentation is deprecated !

Please go to the current Technical Documentation

Skip to end of metadata
Go to start of metadata

To complete the implementation, we must register our Field Type with Symfony by creating a service for it.

Services are by default declared by bundles in Resources/config/services.yml.

Using a dedicated file for the Field Type services

In order to be closer to the kernel best practices, we could declare our Field Type services in a custom fieldtypes.yml file.

All we have to do is instruct the bundle to actually load this file in addition to services.yml (or instead of services.yml!). This is done in the extension definition file, DependencyInjection/EzSystemsTweetFieldTypeExtension.php, in the load() method.

Inside this file, find this line:

This is where our bundle tells Symfony that when parameters are loaded, services.yml should be loaded from Resources/config/ (defined above). Either replace the line, or add a new one with:

 

Like most API components, Field Types use the Symfony 2 service tag mechanism.

The principle is quite simple: a service can be assigned one or several tags, with specific parameters. When the dependency injection container is compiled into a PHP file, tags are read by CompilerPass implementations that add extra handling for tagged services. Each service tagged as ezpublish.fieldType is added to a registry using the alias argument as its unique identifier (ezstring, ezxmltext, etc.).  Each Field Type must also inherit from the abstract ezpublish.fieldType service. This ensures that the initialization steps shared by all Field Types are executed.

Here is the service definition for our Tweet type:

 

Resources/config/services.yml


We take care of namespacing our Field Type with our vendor and bundle name to limit the risk of naming conflicts.