youwe/pimcore-href-typeahead

Allows typeahead functionality in href

v10.0.0 2024-01-09 14:39 UTC

Requires

• pimcore/pimcore: ^10.5

MIT

• Joris Ros
• Manea Eugen
• Youwe

README

Adds typeahead functionality to href fields using a modified default search functionality

I temporary made documents and assets read only field in field configurator to prevent users to select assets as a valid link at static/js/pimcore/object/classes/data/hrefTypeahead.js, but i didn't want to remove it because maybe we will add functionality to support assets and document Also i added validation to prevent users to select more then one class

Install

composer require youwe/pimcore-href-typeahead

Usage

The HrefTypeahead field will be available to use in your model classes, it's similar to href, but has typeahead functionality.

Configuration

When using the HrefAutocomplete in your model, you can use the "show_trigger" option by checking the checkbox. This will display a little dropdown icon, so you can click this instead of typing in the box.

Files

static/js/pimcore/object/classes/data/hrefTypeahead.js

An exact copy of default href

static/js/pimcore/object/tags/hrefTypeahead.js

An exact copy of default href, with the change that textbox is now a combo with autocomplete provided by SearchController::findAction

models/Pimcore/Model/Object/ClassDefinition/Data/HrefTypeahead.php

An exact copy of default href

HrefTypeahead/controllers/SearchController.php

A controller containing autocomplete source

Events

When you want to add some extra filters to the search done by the href typeahead, you can use a listener. An example:

Listener config (ie. in src/AppBundle/Resources/config/services.yml):

AppBundle\EventListener\HreftypeaheadSearchListener:
    tags:
        - { name: kernel.event_listener, event: hreftypeahead.search, method: onSearch }

Listener code (ie. in AppBundle\EventListener\HreftypeaheadSearchListener):

class HreftypeaheadSearchListener
{

    /* @var HreftypeaheadSearchEvent */
    protected $e;

    public function __construct()
    {
    }

    public function onSearch(HreftypeaheadSearchEvent $e)
    {
        $this->e = $e;

        $e->addCondition('(0 = 0)');   // just an example

    }
    
    ......

Limitations

• It only supports one object linked in href