class.ilAdvancedMDRecordGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilAdvancedMDRecordGUI
{
    const MODE_EDITOR = 1;
    const MODE_SEARCH = 2;
    const MODE_INFO = 3;
    const MODE_APP_PRESENTATION = 8;

    // glossary
    const MODE_REC_SELECTION = 4;               // record selection (per object)
    const MODE_FILTER = 5;                              // filter (as used e.g. in tables)
    const MODE_TABLE_HEAD = 6;                          // table header (columns)
    const MODE_TABLE_CELLS = 7;                 // table cells
    
    protected $lng;
    
    private $mode;
    private $obj_type;
    private $sub_type;
    private $obj_id;
    private $ref_id = null;
    
    private $form;
    private $search_values = array();
    
    protected $editor_form; // [array]

    // $adv_ref_id - $adv_type - $adv_subtype:
    // Object, that defines the adv md records being used. Default is $this->object, but the
    // context may set another object (e.g. media pool for media objects)
    protected $adv_ref_id = null;
    protected $adv_type = null;
    protected $adv_subtype = null;

    protected $user;


    public function __construct($a_mode, $a_obj_type = '', $a_obj_id = '', $a_sub_type = '', $a_sub_id = '')
    {
        global $DIC;

        $lng = $DIC['lng'];

        $this->user = $DIC->user();
        $this->lng = $lng;
        $this->mode = $a_mode;
        $this->obj_type = $a_obj_type;
        $this->obj_id = $a_obj_id;
        $this->sub_type = $a_sub_type;
        $this->sub_id = $a_sub_id;
        
        if ($a_obj_id) {
            $refs = ilObject::_getAllReferences($a_obj_id);
            $this->ref_id = end($refs);
        }
    }

    public function setAdvMdRecordObject($a_adv_ref_id, $a_adv_type, $a_adv_subtype = "-")
    {
        $this->adv_ref_id = $a_adv_ref_id;
        $this->adv_type = $a_adv_type;
        $this->adv_subtype = $a_adv_subtype;
    }

    public function getAdvMdRecordObject()
    {
        if ($this->adv_type == null) {
            return [$this->ref_id, $this->obj_type, $this->sub_type];
        }
        return [$this->adv_ref_id, $this->adv_type, $this->adv_subtype];
    }


    public function setRefId($a_ref_id)
    {
        $this->ref_id = $a_ref_id;
    }
    
    public function setPropertyForm($form)
    {
        $this->form = $form;
    }
    
    public function setSearchValues($a_values)
    {
        $this->search_values = $a_values;
    }
    
    
    public function setInfoObject($info)
    {
        $this->info = $info;
    }
    
    public function parse()
    {
        switch ($this->mode) {
            case self::MODE_EDITOR:
                return $this->parseEditor();
                
            case self::MODE_SEARCH:
                return $this->parseSearch();
            
            case self::MODE_INFO:
                return $this->parseInfoPage();

            case self::MODE_APP_PRESENTATION:
                return $this->parseAppointmentPresentation();

            case self::MODE_REC_SELECTION:
                return $this->parseRecordSelection();
                
            case self::MODE_FILTER:
                return $this->parseFilter();
                
            case self::MODE_TABLE_HEAD:
                return $this->parseTableHead();

            case self::MODE_TABLE_CELLS:
                return $this->parseTableCells();
                
            default:
                die('Not implemented yet');
        }
    }
        
    
    //
    // editor
    //
    
    protected function parseEditor()
    {
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
        $this->editor_form = array();
        
        foreach ($this->getActiveRecords() as $record_obj) {
            $record_id = $record_obj->getRecordId();
            
            $values = new ilAdvancedMDValues($record_id, $this->obj_id, $this->sub_type, $this->sub_id);
            $values->read();
            $defs = $values->getDefinitions();
            
            // empty record?
            if (!sizeof($defs)) {
                continue;
            }

            $translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($record_obj->getRecordId());
            $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($record_obj->getRecordId());
            
            $adt_group_form = ilADTFactory::getInstance()->getFormBridgeForInstance($values->getADTGroup());
            $adt_group_form->setForm($this->form);

            $adt_group_form->setTitle($translations->getTitleForLanguage($this->user->getLanguage()));
            $adt_group_form->setInfo($translations->getDescriptionForLanguage($this->user->getLanguage()));
            
            foreach ($defs as $def) {
                $element = $adt_group_form->getElement($def->getFieldId());
                $element->setTitle($field_translations->getTitleForLanguage($def->getFieldId(), $this->user->getLanguage()));
                $element->setInfo($field_translations->getDescriptionForLanguage($def->getFieldId(), $this->user->getLanguage()));
                
                // definition may customize ADT form element
                $def->prepareElementForEditor($element);
                
                if ($values->isDisabled($def->getFieldId())) {
                    $element->setDisabled(true);
                }
            }
            
            $adt_group_form->addToForm();
            
            $this->editor_form[$record_id] = array("values" => $values, "form" => $adt_group_form);
        }
    }
    
    public function importEditFormPostValues()
    {
        // #13774
        if (!is_array($this->editor_form)) {
            return false;
        }
        
        $valid = true;
        
        foreach ($this->editor_form as $item) {
            $item["form"]->importFromPost();
            if (!$item["form"]->validate()) {
                $valid = false;
            }
        }
        
        return $valid;
    }
    
    public function writeEditForm($a_obj_id = null, $a_sub_id = null)
    {
        if (!sizeof($this->editor_form)) {
            return false;
        }
        
        // switch ids?
        if ($a_obj_id) {
            $this->obj_id = $a_obj_id;
        }
        if ($a_sub_id) {
            $this->sub_id = $a_sub_id;
        }
        
        foreach ($this->editor_form as $item) {
            if ($a_obj_id || $a_sub_id) {
                // switch active record to updated primary keys, e.g. after creation
                $item["values"]->setActiveRecordPrimary($this->obj_id, $this->sub_type, $this->sub_id);
            }
                    
            $item["values"]->write();
        }
        
        return true;
    }
    
    
    //
    // search
    //
    
    private function parseSearch()
    {
        // this is NOT used for the global search, see ilLuceneAdvancedSearchFields::getFormElement()
        // (so searchable flag is NOT relevant)
        //
        // current usage: wiki page element "[amd] page list"
        
        $this->lng->loadLanguageModule('search');
                
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        
        $this->search_form = array();
        foreach ($this->getActiveRecords() as $record) {
            $fields = ilAdvancedMDFieldDefinition::getInstancesByRecordId($record->getRecordId(), true);
            
            // empty record?
            if (!sizeof($fields)) {
                continue;
            }

            $record_translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($record->getRecordId());
            $section = new ilFormSectionHeaderGUI();
            $section->setTitle($record_translations->getTitleForLanguage($this->user->getLanguage()));
            $section->setInfo($record_translations->getDescriptionForLanguage($this->user->getLanguage()));
            $this->form->addItem($section);
            
            foreach ($fields as $field) {
                $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($record->getRecordId());

                $field_form = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($field->getADTDefinition(), true, false);
                $field_form->setForm($this->form);
                $field_form->setElementId("advmd[" . $field->getFieldId() . "]");
                $field_form->setTitle($field_translations->getTitleForLanguage($field->getFieldId(), $this->user->getLanguage()));
                
                if (is_array($this->search_form_values) &&
                    isset($this->search_form_values[$field->getFieldId()])) {
                    $field->setSearchValueSerialized($field_form, $this->search_form_values[$field->getFieldId()]);
                }
                
                $field->prepareElementForSearch($field_form);
                
                $field_form->addToForm();
                
                $this->search_form[$field->getFieldId()] = array("def" => $field, "value" => $field_form);
            }
        }
    }
    
    public function importSearchForm()
    {
        if (!sizeof($this->search_form)) {
            return false;
        }
        
        $valid = true;
        $res = array();
        
        foreach ($this->search_form as $field_id => $item) {
            $item["value"]->importFromPost();
            if (!$item["value"]->validate()) {
                $valid = false;
            }
            $value = $item["def"]->getSearchValueSerialized($item["value"]);
            if ($value !== null) {
                $res[$field_id] = $value;
            }
        }
        
        if ($valid) {
            return $res;
        }
    }
    
    public function setSearchFormValues(array $a_values)
    {
        $this->search_form_values = $a_values;
    }
    
    private function parseInfoPage()
    {
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
        include_once('Services/ADT/classes/class.ilADTFactory.php');
                                
        foreach (ilAdvancedMDValues::getInstancesForObjectId($this->obj_id, $this->obj_type, $this->sub_type, $this->sub_id) as $record_id => $a_values) {
            // this correctly binds group and definitions
            $a_values->read();

            $record_translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($record_id);
            $this->info->addSection($record_translations->getTitleForLanguage($this->user->getLanguage()));
        
            $defs = $a_values->getDefinitions();
            foreach ($a_values->getADTGroup()->getElements() as $element_id => $element) {
                if (!$element->isNull()) {
                    $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($record_id);
                    $title = $field_translations->getTitleForLanguage($element_id, $this->user->getLanguage());

                    $this->info->addProperty(
                        $title,
                        ilADTFactory::getInstance()->getPresentationBridgeForInstance($element)->getHTML()
                    );
                }
            }
        }
    }

    private function parseAppointmentPresentation()
    {
        $sub = ilAdvancedMDSubstitution::_getInstanceByObjectType($this->obj_type);

        $definitions = ilAdvancedMDFieldDefinition::getInstancesByObjType($this->obj_type);
        $definitions = $sub->sortDefinitions($definitions);

        $positions = array();
        foreach ($definitions as $position => $value) {
            $positions[$value->getFieldId()] = $position;
        }

        $array_elements = array();
        foreach (ilAdvancedMDValues::getInstancesForObjectId($this->obj_id, $this->obj_type, $this->sub_type, $this->sub_id) as $record_id => $a_values) {
            // this correctly binds group and definitions
            $a_values->read();

            $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($record_id);

            $defs = $a_values->getDefinitions();
            foreach ($a_values->getADTGroup()->getElements() as $element_id => $element) {
                if (!$element->isNull()) {
                    $presentation_bridge = ilADTFactory::getInstance()->getPresentationBridgeForInstance($element);
                    #21615
                    if (get_class($element) == 'ilADTLocation') {
                        $presentation_bridge->setSize("100%", "200px");
                        #22638
                        $presentation_value = $presentation_bridge->getHTML();
                        $presentation_value .= "<script>ilInitMaps();</script>";
                    } elseif (get_class($element) == 'ilADTExternalLink' || get_class($element) == 'ilADTInternalLink') {
                        #22638
                        $presentation_value = $presentation_bridge->getHTML();
                    } else {
                        $presentation_value = strip_tags($presentation_bridge->getHTML());
                    }
                    $array_elements[$positions[$element_id]] =
                        [
                            "title" => $field_translations->getTitleForLanguage($element_id, $this->user->getLanguage()),
                            "value" => $presentation_value
                        ];
                }
            }
        }

        // already sorted by record positions
        return $array_elements;
    }

    //
    // :TODO: ECS
    //
    
    private function handleECSDefinitions($a_definition)
    {
        include_once('./Services/WebServices/ECS/classes/class.ilECSDataMappingSettings.php');
        include_once('./Services/WebServices/ECS/classes/class.ilECSServerSettings.php');

        if (ilECSServerSettings::getInstance()->activeServerExists() or
            ($this->obj_type != 'crs' and $this->obj_type != 'rcrs')
        ) {
            return false;
        }
        return false;
    }
    
    private function showECSStart($def)
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        $this->lng->loadLanguageModule('ecs');
        
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValue.php');
        $value_start = ilAdvancedMDValue::_getInstance($this->obj_id, $def->getFieldId());
        
        $unixtime = $value_start->getValue() ? $value_start->getValue() : mktime(8, 0, 0, date('m'), date('d'), date('Y'));
        
        $time = new ilDateTimeInputGUI($this->lng->txt('ecs_event_appointment'), 'md[' . $def->getFieldId() . ']');
        $time->setShowTime(true);
        $time->setDate(new ilDateTime($unixtime, IL_CAL_UNIX));
        /*
        $time->enableDateActivation($this->lng->txt('enabled'),
            'md_activated['.$def->getFieldId().']',
            $value_start->getValue() ? true : false);
        */
        $time->setDisabled($value_start->isDisabled());
        
        $mapping = ilECSDataMappingSettings::_getInstance();
        if ($field_id = $mapping->getMappingByECSName(0, 'end')) {
            $value_end = ilAdvancedMDValue::_getInstance($this->obj_id, $field_id);
            
            list($hours, $minutes) = $this->parseDuration($value_start->getValue(), $value_end->getValue());
            
            $duration = new ilDurationInputGUI($this->lng->txt('ecs_duration'), 'ecs_duration');
            $duration->setHours($hours);
            $duration->setMinutes($minutes);
            #$duration->setInfo($this->lng->txt('ecs_duration_info'));
            $duration->setShowHours(true);
            $duration->setShowMinutes(true);
            $time->addSubItem($duration);
        }

        if ($field_id = $mapping->getMappingByECSName(0, 'cycle')) {
            $value = ilAdvancedMDValue::_getInstance($this->obj_id, $field_id);
            $cycle_def = ilAdvancedMDFieldDefinition::getInstance($field_id);
            switch ($cycle_def->getFieldType()) {
                case ilAdvancedMDFieldDefinition::TYPE_TEXT:
                    $text = new ilTextInputGUI($cycle_def->getTitle(), 'md[' . $cycle_def->getFieldId() . ']');
                    $text->setValue($value->getValue());
                    $text->setSize(20);
                    $text->setMaxLength(512);
                    $text->setDisabled($value->isDisabled());
                    $time->addSubItem($text);
                    break;
                    
                case ilAdvancedMDFieldDefinition::TYPE_SELECT:
                    $select = new ilSelectInputGUI($cycle_def->getTitle(), 'md[' . $cycle_def->getFieldId() . ']');
                    $select->setOptions($cycle_def->getFieldValuesForSelect());
                    $select->setValue($value->getValue());
                    $select->setDisabled($value->isDisabled());
                    $time->addSubItem($select);
                    break;
            }
        }
        if ($field_id = $mapping->getMappingByECSName(0, 'room')) {
            $value = ilAdvancedMDValue::_getInstance($this->obj_id, $field_id);
            $room_def = ilAdvancedMDFieldDefinition::getInstance($field_id);
            switch ($room_def->getFieldType()) {
                case ilAdvancedMDFieldDefinition::TYPE_TEXT:
                    $text = new ilTextInputGUI($room_def->getTitle(), 'md[' . $room_def->getFieldId() . ']');
                    $text->setValue($value->getValue());
                    $text->setSize(20);
                    $text->setMaxLength(512);
                    $text->setDisabled($value->isDisabled());
                    $time->addSubItem($text);
                    break;
                    
                case ilAdvancedMDFieldDefinition::TYPE_SELECT:
                    $select = new ilSelectInputGUI($room_def->getTitle(), 'md[' . $room_def->getFieldId() . ']');
                    $select->setOptions($cycle_def->getFieldValuesForSelect());
                    $select->setValue($value->getValue());
                    $select->setDisabled($value->isDisabled());
                    $time->addSubItem($select);
                    break;
            }
        }
        $this->form->addItem($time);
    }

    protected function parseDuration($u_start, $u_end)
    {
        if ($u_start >= $u_end) {
            return array(0,0);
        }
        $diff = $u_end - $u_start;
        $hours = (int) ($diff / (60 * 60));
        $min = (int) (($diff % 3600) / 60);
        return array($hours,$min);
    }

        
    //
    // glossary
    //
    
    public function parseRecordSelection($a_sec_head = "")
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
        $first = true;
        foreach (ilAdvancedMDRecord::_getActivatedRecordsByObjectType($this->obj_type, $this->sub_type) as $record_obj) {
            $selected = ilAdvancedMDRecord::getObjRecSelection($this->obj_id, $this->sub_type);
            if ($first) {
                $first = false;
                $section = new ilFormSectionHeaderGUI();
                $sec_tit = ($a_sec_head == "")
                    ? $this->lng->txt("meta_adv_records")
                    : $a_sec_head;
                $section->setTitle($sec_tit);
                $this->form->addItem($section);
            }
            
            // checkbox for each active record
            $cb = new ilCheckboxInputGUI($record_obj->getTitle(), "amet_use_rec[]");
            $cb->setInfo($record_obj->getDescription());
            $cb->setValue($record_obj->getRecordId());
            if (in_array($record_obj->getRecordId(), $selected)) {
                $cb->setChecked(true);
            }
            $this->form->addItem($cb);
        }
    }
    
    public function saveSelection()
    {
        $sel = ilUtil::stripSlashesArray($_POST["amet_use_rec"]);
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
        ilAdvancedMDRecord::saveObjRecSelection($this->obj_id, $this->sub_type, $sel);
    }

    public function setTableGUI($a_val)
    {
        $this->table_gui = $a_val;
    }
    
    public function getTableGUI()
    {
        return $this->table_gui;
    }
    
    public function setRowData($a_val)
    {
        $this->row_data = $a_val;
    }
    
    public function getRowData()
    {
        return $this->row_data;
    }
        
    protected function getActiveRecords()
    {
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
        list($adv_ref_id, $adv_type, $adv_subtype) = $this->getAdvMdRecordObject();
        return ilAdvancedMDRecord::_getSelectedRecordsByObject($adv_type, $adv_ref_id, $adv_subtype);
    }
    
    private function parseFilter()
    {
        $this->adt_search = array();
        
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        foreach ($this->getActiveRecords() as $record_obj) {
            $record_id = $record_obj->getRecordId();

            $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($record_id);

            $defs = ilAdvancedMDFieldDefinition::getInstancesByRecordId($record_id);
            foreach ($defs as $def) {
                // some input GUIs do NOT support filter rendering yet
                if (!$def->isFilterSupported()) {
                    continue;
                }
                
                $this->adt_search[$def->getFieldId()] = ilADTFactory::getInstance()->getSearchBridgeForDefinitionInstance($def->getADTDefinition(), true, false);
                $this->adt_search[$def->getFieldId()]->setTableGUI($this->table_gui);
                $this->adt_search[$def->getFieldId()]->setTitle(
                    $field_translations->getTitleForLanguage($def->getFieldId(), $this->user->getLanguage())
                );
                $this->adt_search[$def->getFieldId()]->setElementId('md_' . $def->getFieldId());
                
                $this->adt_search[$def->getFieldId()]->loadFilter();
                $this->adt_search[$def->getFieldId()]->addToForm();
            }
        }
    }
    
    public function importFilter()
    {
        if (!is_array($this->adt_search)) {
            return;
        }
        
        foreach ($this->adt_search as $element) {
            $element->importFromPost();
        }
    }
    
    public function getFilterElements($a_only_non_empty = true)
    {
        if (!is_array($this->adt_search)) {
            return;
        }
        
        $res = array();
        
        foreach ($this->adt_search as $def_id => $element) {
            if (!$element->isNull() ||
                !(bool) $a_only_non_empty) {
                $res[$def_id] = $element;
            }
        }
        return $res;
    }
    
    
    //
    // :TODO: OBSOLETE?  not used in glossary
    //
    
    private function parseTableHead()
    {
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        foreach ($this->getActiveRecords() as $record_obj) {
            $record_id = $record_obj->getRecordId();

            $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($record_id);

            $defs = ilAdvancedMDFieldDefinition::getInstancesByRecordId($record_id);
            foreach ($defs as $def) {
                if ($this->handleECSDefinitions($def)) {
                    continue;
                }
                
                $this->table_gui->addColumn(
                    $field_translations->getTitleForLanguage($def->getFieldId(), $this->user->getLanguage()),
                    'md_' . $def->getFieldId()
                );
            }
        }
    }

    private function parseTableCells()
    {
        $data = $this->getRowData();
        $html = "";

        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
        foreach ($this->getActiveRecords() as $record_obj) {
            $record_id = $record_obj->getRecordId();

            $defs = ilAdvancedMDFieldDefinition::getInstancesByRecordId($record_id);
            foreach ($defs as $def) {
                if ($this->handleECSDefinitions($def)) {
                    continue;
                }

                $res = '';
                $res_raw = $data['md_' . $def->getFieldId()] ?? null;
                $res_presentation = $data['md_' . $def->getFieldId() . '_presentation'] ?? null;
                if ($res_raw) {
                    $res = $res_raw;
                }
                if (
                    $res_presentation instanceof ilADTPresentationBridge &&
                    !($res_presentation instanceof ilADTLocationPresentationBridge)
                ) {
                    $res = $res_presentation->getHTML();
                }
                
                $html .= "<td class='std'>" . $res . "</td>";
            }
        }
        return $html;
    }
}