Skip to content
  • Documentation >
  • Content management >
  • Field Types >
  • Field Type reference >
  • TaxonomyEntryAssignment Field Type

TaxonomyEntryAssignment Field Type

TaxonomyEntryAssignment Field is used to integrate content with the Taxonomy module. It allows you to select tags or categories and assign them to content. This Field Type assigns tags to the content in the data action, so then you can use TaxonomyService on this content item.

Duplicate taxonomy fields

Because tags are assigned per content item, not per Field, you cannot use two Taxonomy Entry Assignment Fields with the same taxonomy type in one content type.

To be able to assign tags to the content, first, you need to add a TaxonomyEntryAssignment Field to the content type definition.

Name Internal name Expected input
TaxonomyEntryAssignment ibexa_taxonomy_entry_assignment array with taxonomyEntries and taxonomy keys

PHP API Field Type

Input expectations

Type Description Example
array array with Ibexa\Contracts\Taxonomy\Value\TaxonomyEntry objects under taxonomy_entries key and Taxonomy identifier under taxonomy key see below

Example using an Ibexa\Taxonomy\FieldType\TaxonomyEntryAssignment\Value object: 

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
$taxonomyEntry1 = $this->taxonomyService->loadEntryByIdentifier('example_entry', 'tags');
$taxonomyEntry2 = $this->taxonomyService->loadEntryByIdentifier('example_entry_2', 'tags');
new \Ibexa\Taxonomy\FieldType\TaxonomyEntryAssignment\Value(
    [
        $taxonomyEntry1,
        $taxonomyEntry2,
        // ...
    ],
    'tags', 
);

Example using array: 

1
2
3
4
[
    'taxonomy_entries' => [$taxonomyEntry, $taxonomyEntry2], // load entries using TaxonomyService
    'taxonomy' => 'tags',
]

Value object

Properties

Property Type Description
taxonomyEntry array of Ibexa\Contracts\Taxonomy\Value\TaxonomyEntry Stores selected taxonomy entry.
taxonomy string Stores the taxonomy identifier, all taxonomyEntries have to be assigned to this taxonomy and the identifier has to match the settings of the Field Type in content type configuration.

Constructor

The constructor accepts taxonomyEntries and taxonomy as described above.

String representation

If the Field has no entries - empty string. If the Field has entries (for example: "Cars and 5 more") - a string displaying the first taxonomy entry and the number of rest of the entries.

Hash format

An array of:

  • taxonomy_entries with numerical IDs of entries.
  • taxonomy string identifier of a taxonomy.

Validation

The Field Type validates if all Taxonomy Entries from the value are assigned to the configured taxonomy.

Settings

Name Type Default value Description
taxonomy string null Taxonomy from which entry is chosen.

Template rendering

The TaxonomyEntryAssignment field is rendered with the ibexa_render_field() Twig function.