lekoala / silverstripe-tabulator

src/TabulatorAddExistingAutocompleter.php

<?php

namespace LeKoala\Tabulator;

use Exception;
use SilverStripe\ORM\DataObject;
use SilverStripe\View\ArrayData;
use SilverStripe\ORM\RelationList;
use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Control\HTTPResponse;
use LeKoala\FormElements\BsAutocompleteField;

/**
 * This component provides a autocomplete field to link element to the grid
 */
class TabulatorAddExistingAutocompleter extends AbstractTabulatorTool
{
    /**
     * @config
     */
    private static array $allowed_actions = [

The private property $allowed_actions is not used, and could be removed.

        'add',
        'autocomplete',
    ];


    protected string $name = 'add_existing';
    protected array $extraFields = [];
    protected array $searchFilters = [];
    protected ?BsAutocompleteField $autocompleteField = null;

    public function forTemplate()
    {
        $grid = $this->tabulatorGrid;
        $singleton = singleton($grid->getModelClass());
        $context = [];
        if ($grid->getList() instanceof RelationList) {
            $record = $grid->getForm()->getRecord();
            if ($record && $record instanceof DataObject) {

$record is always a sub-type of SilverStripe\ORM\DataObject.

                $context['Parent'] = $record;
            }
        }

        if (!$singleton->canCreate(null, $context)) {
            return false;
        }

        if (!$this->buttonName) {
            // provide a default button name, can be changed by calling {@link setButtonName()} on this component
            $this->buttonName = _t('SilverStripe\\Forms\\GridField\\GridField.LinkExisting', "Link Existing");
        }

        $data = new ArrayData([
            'ButtonName' => $this->buttonName,
            'ButtonClasses' => 'btn-outline-secondary font-icon-link',
            'Icon' => $this->isAdmini() ? 'link' : '',
            'AddToLink' => $this->Link('add'),
            'AutocompleteField' => $this->getAutocompleteField(),
        ]);
        return $this->renderWith($this->getViewerTemplates(), $data);

$data of type SilverStripe\View\ArrayData is incompatible with the type array expected by parameter $customFields of SilverStripe\View\ViewableData::renderWith().

    }

    /**
     * Note: this require the field to be bound to a form before being used
     * otherwise calls to Link() will fail
     *
     * @return BsAutocompleteField
     */
    public function getAutocompleteField(): BsAutocompleteField
    {
        if (!$this->autocompleteField) {
            $this->autocompleteField = $this->createAutocompleteField();
        }
        return $this->autocompleteField;
    }

    protected function createAutocompleteField(): BsAutocompleteField
    {
        $grid = $this->tabulatorGrid;

        $field = new BsAutocompleteField('autocomplete', _t('SilverStripe\\Forms\\GridField\\GridField.Find', "Find"));
        $field->setForm($grid->getForm());
        $field->setPlaceholder(_t('SilverStripe\\Forms\\GridField\\GridField.Find', "Find"));
        $field->setAjax(Controller::join_links($grid->Link('tool'), $this->name, 'autocomplete'));
        $field->setAjaxWizard($grid->getModelClass());
        $field->setAjaxFilters($this->searchFilters);
        return $field;
    }

    public function add(HTTPRequest $request): HTTPResponse
    {
        $response = new HTTPResponse();

        try {
            $RecordID = $request->postVar('RecordID');
            if (!$RecordID) {
                throw new Exception("No RecordID");
            }

            $modelClass = $this->tabulatorGrid->getModelClass();
            $record = $modelClass::get_by_id($RecordID);
            if (!$record) {
                throw new Exception("Record not found");
            }

            $this->tabulatorGrid->getDataList()->add($record, $this->extraFields);

The call to SilverStripe\ORM\DataList::add() has too many arguments starting with $this->extraFields.

            $body = json_encode([
                'success' => true,
                'message' => $record->getTitle() . " add to the list",
            ]);
            $response->setBody($body);
            $response->addHeader('Content-Type', 'application/json');
        } catch (Exception $ex) {
            $response->setStatusCode(500);
            $response->setBody($ex->getMessage());
        }

        return $response;
    }

    public function autocomplete(HTTPRequest $request): HTTPResponse
    {
        // delegate to field
        $acField = $this->getAutocompleteField();

        try {
            $response = $acField->autocomplete($request);
        } catch (Exception $ex) {
            $response = new HTTPResponse();
            $response->setStatusCode(500);
            $response->setBody($ex->getMessage());
        }

        return $response;
    }

    public function getSearchFilters(): array
    {
        return $this->searchFilters;
    }

    public function setSearchFilters(array $searchFilters): self
    {
        $this->searchFilters = $searchFilters;
        return $this;
    }

    /**
     * Get the value of extraFields
     */
    public function getExtraFields(): array
    {
        return $this->extraFields;
    }

    /**
     * Set the value of extraParams
     */
    public function setExtraFields(array $extraFields): self
    {
        $this->extraFields = $extraFields;
        return $this;
    }
}