elbformat/field-helper-bundle

Provides helpers to extract and set structured data from and to ibexa content fields

v2.0.0 2024-03-12 07:20 UTC

Requires

• php: >=8.1
• ext-dom: *
• ibexa/oss: ^4.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.3
• netgen/tagsbundle: ^4.0
• phpunit/phpunit: ^9.5
• vimeo/psalm: ^4.13

MIT

• Hannes Giesenow
• Ronny Gericke

• ezplatform
• ibexa

README

Elbformat Field Helper Bundle for ibexa DXP

This bundle provides helpers to extract and set structured data from and to ibexa content fields.

What are "Field helpers"?

Field helpers are intended to easily and safely access fields from content objects in a typed manner. With this you can make your project safe for static code analysis without adding too much boilerplate code everywhere. Especially for importer scripts, that create content, there is an update method which helps you to track changes. With thism, you can speed up the update process by not publishing it, when no change was made at all.

Quick usage

Install bundle via composer

$ composer require elbformat/field-helper-bundle

Use like this

public function getFields(RegistryInterface $fieldHelperRegistry, Content $content) {
    $myText = $fieldHelperRegistry->getTextFieldHelper()->getString($content, 'text_field');
    $linkObject = $fieldHelperRegistry->getLinkFieldHelper()->getLink($content, 'my_url');
    $linkUrl = $linkObj->getUrl();
    $linkText = $linkObj->getText();
}

Further topics

• Installation
• Changelog
• How to use the field helpers
• List of supported fields and their helpers
• Extending existing helpers
• Writing your own helpers
• Running tests locally