class.ilADTSearchBridge.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Services as HttpServices;

abstract class ilADTSearchBridge
{
    public const SQL_STRICT = 1;
    public const SQL_LIKE = 2;
    public const SQL_LIKE_END = 3;
    public const SQL_LIKE_START = 4;
    public const DEFAULT_SEARCH_COLUMN = 'value';

    protected ?ilPropertyFormGUI $form = null;
    protected ?ilTable2GUI $table_gui = null;
    protected array $table_filter_fields = [];
    protected string $id = '';
    protected string $title = '';
    protected string $info = '';

    protected ilLanguage $lng;
    protected ilDBInterface $db;
    protected HttpServices $http;

    public function __construct(ilADTDefinition $a_adt_def)
    {
        global $DIC;
        $this->setDefinition($a_adt_def);

        $this->lng = $DIC->language();
        $this->db = $DIC->database();
        $this->http = $DIC->http();
    }

    abstract protected function isValidADTDefinition(ilADTDefinition $a_adt_def): bool;

    abstract protected function setDefinition(ilADTDefinition $a_adt_def): void;

    abstract public function isNull(): bool;

    public function setForm(ilPropertyFormGUI $a_form): void
    {
        $this->form = $a_form;
    }

    public function getForm(): ?ilPropertyFormGUI
    {
        return $this->form;
    }

    public function setElementId(string $a_value): void
    {
        $this->id = $a_value;
    }

    public function getElementId(): string
    {
        return $this->id;
    }

    public function setTitle(string $a_value): void
    {
        $this->title = trim($a_value);
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function getSearchColumn(): string
    {
        return self::DEFAULT_SEARCH_COLUMN;
    }

    public function setTableGUI(ilTable2GUI $a_table): void
    {
        $this->table_gui = $a_table;
    }

    public function getTableGUI(): ?ilTable2GUI
    {
        return $this->table_gui;
    }

    protected function writeFilter($a_value = null): void
    {
        if (!$this->table_gui instanceof ilTable2GUI) {
            return;
        }
        /*
         * BT 35593: changes in ilFormPropertyGUI::clearFromSession make it necessary
         * to have a flat array for all the filter inputs in the session.
         */
        if ($a_value !== null) {
            ilSession::set(
                "form_" . $this->table_gui->getId() . "_" . $this->getElementId(),
                serialize($a_value)
            );
        } else {
            ilSession::clear(
                "form_" . $this->table_gui->getId() . "_" . $this->getElementId()
            );
        }
    }

    protected function readFilter()
    {
        if (!$this->table_gui instanceof ilTable2GUI) {
            return null;
        }
        /*
         * BT 35593: changes in ilFormPropertyGUI::clearFromSession make it necessary
         * to have a flat array of all the filter inputs in the session.
         */
        $value = ilSession::get(
            "form_" . $this->table_gui->getId() . "_" . $this->getElementId()
        ) ?? '';
        if ($value) {
            return unserialize($value);
        }
        return '';
    }

    abstract public function loadFilter(): void;

    protected function addToParentElement(ilFormPropertyGUI $a_field): void
    {
        if ($this->getForm() instanceof ilPropertyFormGUI) {
            $this->getForm()->addItem($a_field);
        } elseif (
            $this->getTableGUI() instanceof ilTable2GUI &&
            $a_field instanceof ilTableFilterItem
        ) {
            $this->table_filter_fields[$a_field->getFieldId()] = $a_field;
            $this->getTableGUI()->addFilterItem($a_field);
        }
    }

    protected function addToElementId(string $a_add): string
    {
        return $this->getElementId() . "[" . $a_add . "]";
    }

    abstract public function addToForm(): void;

    protected function shouldBeImportedFromPost($a_post): bool
    {
        return true;
    }

    protected function extractPostValues(array $a_post = null)
    {
        $element_id = $this->getElementId();
        $multi = strpos($this->getElementId(), "[");

        // get rid of this case
        if ($a_post === null) {
            $a_post = $this->http->request()->getParsedBody();
            if ($multi !== false) {
                $post = $a_post[substr($element_id, 0, $multi)][substr($element_id, $multi + 1, -1)] ?? null;
            } else {
                $post = $a_post[$element_id] ?? null;
            }
        } elseif ($multi !== false) {
            $post = $a_post[substr($element_id, $multi + 1, -1)] ?? null;
        } else {
            $post = $a_post[$element_id] ?? null;
        }
        return $post;
    }

    abstract public function importFromPost(array $a_post = null): bool;

    abstract public function validate(): bool;


    //
    // DB
    //

    abstract public function getSQLCondition(
        string $a_element_id,
        int $mode = self::SQL_LIKE,
        array $quotedWords = []
    ): string;

    public function isInCondition(ilADT $a_adt): bool
    {
        return false;
    }


    //
    //  import/export
    //

    abstract public function getSerializedValue(): string;

    abstract public function setSerializedValue(string $a_value): void;
}