ilAdvancedMDRecordGUI Class Reference

Collaboration diagram for ilAdvancedMDRecordGUI:

Public Member Functions
	__construct ($a_mode, $a_obj_type='', $a_obj_id='', $a_sub_type='', $a_sub_id='')
	Constructor. More...
	setAdvMdRecordObject ($a_adv_ref_id, $a_adv_type, $a_adv_subtype="-")
	Set object, that defines the adv md records being used. More...
	getAdvMdRecordObject ()
	Get adv md record type. More...
	setRefId ($a_ref_id)
	Set ref_id for context. More...
	setPropertyForm ($form)
	set property form object More...
	setSearchValues ($a_values)
	Set values for search form. More...
	setInfoObject ($info)
	get info sections More...
	parse ()
	Get HTML. More...
	importEditFormPostValues ()
	Load edit form values from post. More...
	writeEditForm ($a_obj_id=null, $a_sub_id=null)
	Write edit form values to db. More...
	importSearchForm ()
	Load edit form values from post. More...
	setSearchFormValues (array $a_values)
	parseRecordSelection ($a_sec_head="")
	Parse property form in editor mode. More...
	saveSelection ()
	Save selection per object. More...
	setTableGUI ($a_val)
	Set table. More...
	getTableGUI ()
	Get table. More...
	setRowData ($a_val)
	Set row data. More...
	getRowData ()
	Get row data. More...
	importFilter ()
	Import filter (post) values. More...
	getFilterElements ($a_only_non_empty=true)
	Get SQL conditions for current filter value(s) More...

Data Fields
const	MODE_EDITOR = 1
const	MODE_SEARCH = 2
const	MODE_INFO = 3
const	MODE_APP_PRESENTATION = 8
const	MODE_REC_SELECTION = 4
const	MODE_FILTER = 5
const	MODE_TABLE_HEAD = 6
const	MODE_TABLE_CELLS = 7

Protected Member Functions
	parseEditor ()
	Parse property form in editor mode. More...
	parseDuration ($u_start, $u_end)
	parse hours and minutes from duration More...
	getActiveRecords ()

Protected Attributes
	$lng
	$editor_form
	$adv_ref_id = null
	$adv_type = null
	$adv_subtype = null
	$user

Private Member Functions
	parseSearch ()
	Parse search. More...
	parseInfoPage ()
	Presentation for info page. More...
	parseAppointmentPresentation ()
	Presentation for calendar agenda list. More...
	handleECSDefinitions ($a_definition)
	handle ecs definitions More...
	showECSStart ($def)
	Show special form for ecs start. More...
	parseFilter ()
	Parse property for filter (table) More...
	parseTableHead ()
	Parse property for table head. More...
	parseTableCells ()
	Parse table cells. More...

Private Attributes
	$mode
	$obj_type
	$sub_type
	$obj_id
	$ref_id = null
	$form
	$search_values = array()

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

@ilCtrl_Calls

Definition at line 14 of file class.ilAdvancedMDRecordGUI.php.

Constructor & Destructor Documentation

__construct()

ilAdvancedMDRecordGUI::__construct	(		$a_mode,
			$a_obj_type = '',
			$a_obj_id = '',
			$a_sub_type = '',
			$a_sub_id = ''
	)

Constructor.

@access public

Parameters

int	mode either MODE_EDITOR or MODE_SEARCH
int	obj_type

Definition at line 70 of file class.ilAdvancedMDRecordGUI.php.

    {
        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);
        }
    }

References $DIC, $lng, ilObject\_getAllReferences(), and user().

Here is the call graph for this function:

Member Function Documentation

getActiveRecords()

ilAdvancedMDRecordGUI::getActiveRecords ( )

protected

Definition at line 715 of file class.ilAdvancedMDRecordGUI.php.

    {
        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);
    }

References $adv_ref_id, $adv_subtype, $adv_type, ilAdvancedMDRecord\_getSelectedRecordsByObject(), and getAdvMdRecordObject().

Referenced by parseEditor(), parseFilter(), parseSearch(), parseTableCells(), and parseTableHead().

Here is the call graph for this function:

Here is the caller graph for this function:

getAdvMdRecordObject()

ilAdvancedMDRecordGUI::getAdvMdRecordObject

(

)

Get adv md record type.

Returns

array adv type

Definition at line 108 of file class.ilAdvancedMDRecordGUI.php.

    {
        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];
    }

References $adv_ref_id, $adv_subtype, $adv_type, $obj_type, $ref_id, and $sub_type.

Referenced by getActiveRecords().

Here is the caller graph for this function:

getFilterElements()

ilAdvancedMDRecordGUI::getFilterElements

(

$a_only_non_empty = true

)

Get SQL conditions for current filter value(s)

Returns

array

Definition at line 777 of file class.ilAdvancedMDRecordGUI.php.

    {
        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;
    }

References $res.

Referenced by ilTable2GUI\isAdvMDFilter().

Here is the caller graph for this function:

getRowData()

ilAdvancedMDRecordGUI::getRowData

(

)

Get row data.

Returns

array assoc array of row data (containing md record data)

Definition at line 710 of file class.ilAdvancedMDRecordGUI.php.

    {
        return $this->row_data;
    }

Referenced by parseTableCells().

Here is the caller graph for this function:

getTableGUI()

ilAdvancedMDRecordGUI::getTableGUI

(

)

Get table.

Returns

object table gui class

Definition at line 690 of file class.ilAdvancedMDRecordGUI.php.

    {
        return $this->table_gui;
    }

handleECSDefinitions()

ilAdvancedMDRecordGUI::handleECSDefinitions (   $a_definition )

private

handle ecs definitions

@access private

Parameters

object

ilAdvMDFieldDefinition

Returns

Definition at line 498 of file class.ilAdvancedMDRecordGUI.php.

    {
        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;
    }

References ilECSServerSettings\getInstance().

Referenced by parseTableCells(), and parseTableHead().

Here is the call graph for this function:

Here is the caller graph for this function:

importEditFormPostValues()

ilAdvancedMDRecordGUI::importEditFormPostValues

(

)

Load edit form values from post.

Returns

bool

Definition at line 260 of file class.ilAdvancedMDRecordGUI.php.

    {
        // #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;
    }

References $valid.

Referenced by ilObjSessionGUI\saveObject(), and ilObjSessionGUI\updateObject().

Here is the caller graph for this function:

importFilter()

ilAdvancedMDRecordGUI::importFilter

(

)

Import filter (post) values.

Definition at line 761 of file class.ilAdvancedMDRecordGUI.php.

    {
        if (!is_array($this->adt_search)) {
            return;
        }
        
        foreach ($this->adt_search as $element) {
            $element->importFromPost();
        }
    }

importSearchForm()

ilAdvancedMDRecordGUI::importSearchForm

(

)

Load edit form values from post.

Returns

array

Definition at line 373 of file class.ilAdvancedMDRecordGUI.php.

    {
        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;
        }
    }

References $res, and $valid.

parse()

ilAdvancedMDRecordGUI::parse

(

)

Get HTML.

@access public

Parameters

Definition at line 170 of file class.ilAdvancedMDRecordGUI.php.

    {
        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');
        }
    }

References MODE_APP_PRESENTATION, MODE_EDITOR, MODE_FILTER, MODE_INFO, MODE_REC_SELECTION, MODE_SEARCH, MODE_TABLE_CELLS, MODE_TABLE_HEAD, parseAppointmentPresentation(), parseEditor(), parseFilter(), parseInfoPage(), parseRecordSelection(), parseSearch(), parseTableCells(), and parseTableHead().

Here is the call graph for this function:

parseAppointmentPresentation()

ilAdvancedMDRecordGUI::parseAppointmentPresentation ( )

private

Presentation for calendar agenda list.

Returns

void

Definition at line 439 of file class.ilAdvancedMDRecordGUI.php.

    {
        $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;
    }

References ilAdvancedMDSubstitution\_getInstanceByObjectType(), ilADTFactory\getInstance(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), ilAdvancedMDFieldDefinition\getInstancesByObjType(), ilAdvancedMDValues\getInstancesForObjectId(), and user().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parseDuration()

ilAdvancedMDRecordGUI::parseDuration (   $u_start,   $u_end  )

protected

parse hours and minutes from duration

@access protected

Parameters

return

Definition at line 609 of file class.ilAdvancedMDRecordGUI.php.

    {
        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);
    }

Referenced by showECSStart().

Here is the caller graph for this function:

parseEditor()

ilAdvancedMDRecordGUI::parseEditor ( )

protected

Parse property form in editor mode.

Definition at line 210 of file class.ilAdvancedMDRecordGUI.php.

    {
        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);
        }
    }

References getActiveRecords(), ilADTFactory\getInstance(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), and ilAdvancedMDRecordTranslations\getInstanceByRecordId().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parseFilter()

ilAdvancedMDRecordGUI::parseFilter ( )

private

Parse property for filter (table)

@access private

Definition at line 728 of file class.ilAdvancedMDRecordGUI.php.

    {
        $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();
            }
        }
    }

References getActiveRecords(), ilADTFactory\getInstance(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), and ilAdvancedMDFieldDefinition\getInstancesByRecordId().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parseInfoPage()

ilAdvancedMDRecordGUI::parseInfoPage ( )

private

Presentation for info page.

Returns

void

Definition at line 407 of file class.ilAdvancedMDRecordGUI.php.

    {
        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()
                    );
                }
            }
        }
    }

References ilADTFactory\getInstance(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), ilAdvancedMDValues\getInstancesForObjectId(), info(), and user().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parseRecordSelection()

ilAdvancedMDRecordGUI::parseRecordSelection

(

$a_sec_head = ""

)

Parse property form in editor mode.

@access private

Definition at line 631 of file class.ilAdvancedMDRecordGUI.php.

    {
        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);
        }
    }

References $DIC, $ilUser, $section, ilAdvancedMDRecord\_getActivatedRecordsByObjectType(), and ilAdvancedMDRecord\getObjRecSelection().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parseSearch()

ilAdvancedMDRecordGUI::parseSearch ( )

private

Parse search.

Definition at line 320 of file class.ilAdvancedMDRecordGUI.php.

    {
        // 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);
            }
        }
    }

References $section, getActiveRecords(), ilADTFactory\getInstance(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), and ilAdvancedMDFieldDefinition\getInstancesByRecordId().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parseTableCells()

ilAdvancedMDRecordGUI::parseTableCells ( )

private

Parse table cells.

Definition at line 827 of file class.ilAdvancedMDRecordGUI.php.

    {
        $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;
    }

References $data, $res, getActiveRecords(), ilAdvancedMDFieldDefinition\getInstancesByRecordId(), getRowData(), and handleECSDefinitions().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

parseTableHead()

ilAdvancedMDRecordGUI::parseTableHead ( )

private

Parse property for table head.

Definition at line 802 of file class.ilAdvancedMDRecordGUI.php.

    {
        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()
                );
            }
        }
    }

References getActiveRecords(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), ilAdvancedMDFieldDefinition\getInstancesByRecordId(), and handleECSDefinitions().

Referenced by parse().

Here is the call graph for this function:

Here is the caller graph for this function:

saveSelection()

ilAdvancedMDRecordGUI::saveSelection

(

)

Save selection per object.

Parameters

return

Definition at line 668 of file class.ilAdvancedMDRecordGUI.php.

    {
        $sel = ilUtil::stripSlashesArray($_POST["amet_use_rec"]);
        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
        ilAdvancedMDRecord::saveObjRecSelection($this->obj_id, $this->sub_type, $sel);
    }

References $_POST, ilAdvancedMDRecord\saveObjRecSelection(), and ilUtil\stripSlashesArray().

Here is the call graph for this function:

setAdvMdRecordObject()

ilAdvancedMDRecordGUI::setAdvMdRecordObject	(		$a_adv_ref_id,
			$a_adv_type,
			$a_adv_subtype = "-"
	)

Set 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)

Parameters

string

$a_val

adv type

Definition at line 96 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->adv_ref_id = $a_adv_ref_id;
        $this->adv_type = $a_adv_type;
        $this->adv_subtype = $a_adv_subtype;
    }

setInfoObject()

ilAdvancedMDRecordGUI::setInfoObject

(

$info

)

get info sections

@access public

Parameters

object

instance of ilInfoScreenGUI

Definition at line 158 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->info = $info;
    }

References info().

Here is the call graph for this function:

setPropertyForm()

ilAdvancedMDRecordGUI::setPropertyForm

(

$form

)

set property form object

@access public

Parameters

Definition at line 134 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->form = $form;
    }

References $form.

setRefId()

ilAdvancedMDRecordGUI::setRefId

(

$a_ref_id

)

Set ref_id for context.

In case of object creations this is the reference id of the parent container.

Parameters

int

ref_id

Definition at line 122 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->ref_id = $a_ref_id;
    }

setRowData()

ilAdvancedMDRecordGUI::setRowData

(

$a_val

)

Set row data.

Parameters

array

$a_val

assoc array of row data (containing md record data)

Definition at line 700 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->row_data = $a_val;
    }

setSearchFormValues()

ilAdvancedMDRecordGUI::setSearchFormValues

(

array

$a_values

)

Definition at line 398 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->search_form_values = $a_values;
    }

setSearchValues()

ilAdvancedMDRecordGUI::setSearchValues

(

$a_values

)

Set values for search form.

@access public

Definition at line 145 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->search_values = $a_values;
    }

setTableGUI()

ilAdvancedMDRecordGUI::setTableGUI

(

$a_val

)

Set table.

Parameters

object

$a_val

table gui class

Definition at line 680 of file class.ilAdvancedMDRecordGUI.php.

    {
        $this->table_gui = $a_val;
    }

showECSStart()

ilAdvancedMDRecordGUI::showECSStart (   $def )

private

Show special form for ecs start.

@access private

Parameters

object

ilAdvMDFieldDefinition

Definition at line 517 of file class.ilAdvancedMDRecordGUI.php.

    {
        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);
    }

References $DIC, $ilUser, ilECSDataMappingSettings\_getInstance(), ilAdvancedMDFieldDefinition\getInstance(), IL_CAL_UNIX, parseDuration(), ilAdvancedMDFieldDefinition\TYPE_SELECT, and ilAdvancedMDFieldDefinition\TYPE_TEXT.

Here is the call graph for this function:

writeEditForm()

ilAdvancedMDRecordGUI::writeEditForm	(		$a_obj_id = null,
			$a_sub_id = null
	)

Write edit form values to db.

Parameters

int	$a_obj_id
int	$a_sub_id

Returns

bool

Definition at line 286 of file class.ilAdvancedMDRecordGUI.php.

    {
        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;
    }

Field Documentation

$adv_ref_id

ilAdvancedMDRecordGUI::$adv_ref_id = null

protected

Definition at line 46 of file class.ilAdvancedMDRecordGUI.php.

Referenced by getActiveRecords(), and getAdvMdRecordObject().

$adv_subtype

ilAdvancedMDRecordGUI::$adv_subtype = null

protected

Definition at line 54 of file class.ilAdvancedMDRecordGUI.php.

Referenced by getActiveRecords(), and getAdvMdRecordObject().

$adv_type

ilAdvancedMDRecordGUI::$adv_type = null

protected

Definition at line 50 of file class.ilAdvancedMDRecordGUI.php.

Referenced by getActiveRecords(), and getAdvMdRecordObject().

$editor_form

ilAdvancedMDRecordGUI::$editor_form

protected

Definition at line 38 of file class.ilAdvancedMDRecordGUI.php.

$form

ilAdvancedMDRecordGUI::$form

private

Definition at line 35 of file class.ilAdvancedMDRecordGUI.php.

Referenced by setPropertyForm().

$lng

ilAdvancedMDRecordGUI::$lng

protected

Definition at line 27 of file class.ilAdvancedMDRecordGUI.php.

Referenced by __construct().

$mode

ilAdvancedMDRecordGUI::$mode

private

Definition at line 29 of file class.ilAdvancedMDRecordGUI.php.

$obj_id

ilAdvancedMDRecordGUI::$obj_id

private

Definition at line 32 of file class.ilAdvancedMDRecordGUI.php.

$obj_type

ilAdvancedMDRecordGUI::$obj_type

private

Definition at line 30 of file class.ilAdvancedMDRecordGUI.php.

Referenced by getAdvMdRecordObject().

$ref_id

ilAdvancedMDRecordGUI::$ref_id = null

private

Definition at line 33 of file class.ilAdvancedMDRecordGUI.php.

Referenced by getAdvMdRecordObject().

$search_values

ilAdvancedMDRecordGUI::$search_values = array()

private

Definition at line 36 of file class.ilAdvancedMDRecordGUI.php.

$sub_type

ilAdvancedMDRecordGUI::$sub_type

private

Definition at line 31 of file class.ilAdvancedMDRecordGUI.php.

Referenced by getAdvMdRecordObject().

$user

ilAdvancedMDRecordGUI::$user

protected

Definition at line 59 of file class.ilAdvancedMDRecordGUI.php.

MODE_APP_PRESENTATION

const ilAdvancedMDRecordGUI::MODE_APP_PRESENTATION = 8

Definition at line 19 of file class.ilAdvancedMDRecordGUI.php.

Referenced by ilAppointmentPresentationGUI\addMetaData(), and parse().

MODE_EDITOR

const ilAdvancedMDRecordGUI::MODE_EDITOR = 1

Definition at line 16 of file class.ilAdvancedMDRecordGUI.php.

Referenced by ilObjOrgUnitGUI\editAdvancedSettings(), ilObjStudyProgrammeGUI\editAdvancedSettings(), ilObjOrgUnitGUI\executeCommand(), ilObjStudyProgrammeGUI\executeCommand(), ilGlossaryTermGUI\getEditTermForm(), ilWikiPageGUI\initAdvancedMetaDataForm(), ilObjectMetaDataGUI\initEditForm(), ilRemoteObjectBaseGUI\initEditForm(), ilObjCategoryGUI\initExtendedSettings(), ilBookingObjectGUI\initForm(), ilObjSessionGUI\initForm(), ilObjCourseGUI\initInfoEditor(), parse(), ilObjOrgUnitGUI\updateAdvancedSettings(), ilObjStudyProgrammeGUI\updateAdvancedSettings(), and ilRemoteObjectBaseGUI\updateObject().

MODE_FILTER

const ilAdvancedMDRecordGUI::MODE_FILTER = 5

Definition at line 23 of file class.ilAdvancedMDRecordGUI.php.

Referenced by ilPresentationListTableGUI\__construct(), ilMediaPoolTableGUI\__construct(), ilBookingObjectsTableGUI\getItems(), ilBookingReservationsTableGUI\getItems(), and parse().

MODE_INFO

const ilAdvancedMDRecordGUI::MODE_INFO = 3

Definition at line 18 of file class.ilAdvancedMDRecordGUI.php.

Referenced by ilObjIndividualAssessmentGUI\buildInfoScreen(), ilObjOrgUnitGUI\executeCommand(), ilObjStudyProgrammeGUI\fillInfoScreen(), ilObjCategoryGUI\infoScreen(), ilObjCourseGUI\infoScreen(), ilObjGroupGUI\infoScreen(), ilObjSessionGUI\infoScreen(), ilRemoteObjectBaseGUI\infoScreen(), and parse().

MODE_REC_SELECTION

const ilAdvancedMDRecordGUI::MODE_REC_SELECTION = 4

Definition at line 22 of file class.ilAdvancedMDRecordGUI.php.

Referenced by parse().

MODE_SEARCH

const ilAdvancedMDRecordGUI::MODE_SEARCH = 2

Definition at line 17 of file class.ilAdvancedMDRecordGUI.php.

Referenced by ilAdvancedSearchGUI\initAdvancedMetaDataForm(), ilPCAMDPageListGUI\initForm(), and parse().

MODE_TABLE_CELLS

const ilAdvancedMDRecordGUI::MODE_TABLE_CELLS = 7

Definition at line 25 of file class.ilAdvancedMDRecordGUI.php.

Referenced by ilMediaPoolTableGUI\fillRow(), and parse().

MODE_TABLE_HEAD

const ilAdvancedMDRecordGUI::MODE_TABLE_HEAD = 6

Definition at line 24 of file class.ilAdvancedMDRecordGUI.php.

Referenced by ilMediaPoolTableGUI\__construct(), and parse().

---

The documentation for this class was generated from the following file:

• Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php