class.ilDclBaseFieldRepresentation.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

abstract class ilDclBaseFieldRepresentation
{
    protected $field;
    protected $lng;
    protected $ctrl;


    public function __construct(ilDclBaseFieldModel $field)
    {
        global $DIC;
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $this->field = $field;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
    }


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


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


    public function passThroughFilter(ilDclBaseRecordModel $record, $filter)
    {
        $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($value, $link = true)
    {
        return $value;
    }


    public function getInputField(ilPropertyFormGUI $form, $record_id = 0)
    {
        return null;
    }


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


    protected function getFilterInputFieldValue(/*ilPropertyFormGUI*/
        $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($form, ilObjDataCollection $dcl, $mode = "create")
    {
        $opt = $this->buildFieldCreationInput($dcl, $mode);

        if ($mode != 'create' && $this->getField()->getDatatypeId() == ilDclDatatype::INPUTFORMAT_PLUGIN) {
            $new_plugin_title = $opt->getTitle();
            $plugin_name = ilDclFieldFactory::getPluginNameFromFieldModel($this->getField());
            if ($plugin_name !== "DclBase") {
                $new_plugin_title .= ': ' . $plugin_name;
            }
            $opt->setTitle($new_plugin_title);
        }

        $form->addOption($opt);
    }


    protected function buildFieldCreationInput(ilObjDataCollection $dcl, $mode = 'create')
    {
        $opt = new ilRadioOption($this->lng->txt('dcl_' . $this->getField()->getDatatype()->getTitle()), $this->getField()->getDatatypeId());
        $opt->setInfo($this->lng->txt('dcl_' . $this->getField()->getDatatype()->getTitle() . '_desc'));

        return $opt;
    }


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


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