class.ilDclBaseFieldRepresentation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilDclBaseFieldRepresentation
{
    protected ilDclBaseFieldModel $field;
    protected ilLanguage $lng;
    protected ilCtrl $ctrl;
    protected ilObjUser $user;
    protected ILIAS\HTTP\Services $http;
    protected ILIAS\Refinery\Factory $refinery;

    protected ilComponentRepository $component_repository;
    protected ilComponentFactory $component_factory;

    public function __construct(ilDclBaseFieldModel $field)
    {
        global $DIC;

        $this->field = $field;
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->http = $DIC->http();
        $this->user = $DIC->user();
        $this->refinery = $DIC->refinery();
        $this->component_repository = $DIC["component.repository"];
        $this->component_factory = $DIC["component.factory"];
    }

    public function addFilterInputFieldToTable(ilTable2GUI $table)
    {
        return null;
    }

    protected function setupFilterInputField(?ilTableFilterItem $input): void
    {
        if ($input != null) {
            $input->setTitle($this->getField()->getTitle());
        }
    }

    public function passThroughFilter(ilDclBaseRecordModel $record, $filter): bool
    {
        $value = $record->getRecordFieldValue($this->getField()->getId());
        $pass = true;

        if (($this->getField()->getId() == "owner" || $this->getField()->getId() == "last_edit_by") && $filter) {
            $pass = false;
            $user = new ilObjUser($value);
            if (strpos($user->getFullname(), $filter) !== false) {
                $pass = true;
            }
        }

        return $pass;
    }

    public function parseSortingValue(string $value, bool $link = true): mixed
    {
        return $value;
    }

    public function getInputField(ilPropertyFormGUI $form, ?int $record_id = null): ?ilFormPropertyGUI
    {
        return null;
    }

    protected function setupInputField(ilFormPropertyGUI $input, ilDclBaseFieldModel $field): void
    {
        $input->setInfo($field->getDescription() . ($input->getInfo() ? '<br>' . $input->getInfo() : ''));
    }

    protected function getFilterInputFieldValue(
        ilTableFilterItem $input
    ) {
        $value = $input->getValue();
        if (is_array($value)) {
            if ($value['from'] || $value['to']) {
                return $value;
            }
        } else {
            if ($value != '') {
                return $value;
            }
        }

        return null;
    }

    public function addFieldCreationForm(
        ilSubEnabledFormPropertyGUI $form,
        ilObjDataCollection $dcl,
        string $mode = "create"
    ): void {
        $opt = $this->buildFieldCreationInput($dcl, $mode);
        if ($opt !== null) {
            $form->addOption($opt);
        }
    }

    protected function buildFieldCreationInput(ilObjDataCollection $dcl, string $mode = 'create'): ?ilRadioOption
    {
        $opt = null;
        if ($this->getField()->getDatatypeId() !== null) {
            $title = $this->field->getPresentationTitle();
            $info = $this->field->getPresentationDescription();
            $opt = new ilRadioOption($title, (string) $this->getField()->getDatatypeId());
            $opt->setInfo($info);
        }

        return $opt;
    }

    public function getPropertyInputFieldId(string $property): string
    {
        return "prop_" . $property;
    }

    public function getField(): ilDclBaseFieldModel
    {
        return $this->field;
    }
}