Collaboration diagram for ilObjectMetaDataGUI:

Public Member Functions
	__construct (ilObject $a_object=null, $a_sub_type=null, $a_sub_id=null)
	Construct. More...

	executeCommand ()

	addMDObserver ($a_class, $a_method, $a_section)

	getTab ($a_base_class=null)

	getBlockHTML (array $a_cmds=null, $a_callback=null)

	getKeyValueList ()

Protected Member Functions
	getLOMType ()

	isAdvMDAvailable ()

	isLOMAvailable ()

	hasAdvancedMDSettings ()

	hasActiveRecords ()

	canEdit ()

	setSubTabs ($a_active)

	initEditForm ()

	edit (ilPropertyFormGUI $a_form=null)

	update ()

Protected Attributes
	$object

	$obj_id

	$obj_type

	$sub_type

	$sub_id

	$md_observers

Detailed Description

Class ilObjectMetaDataGUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

@ilCtrl_Calls ilObjectMetaDataGUI: ilMDEditorGUI, ilAdvancedMDSettingsGUI

Definition at line 12 of file class.ilObjectMetaDataGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjectMetaDataGUI::__construct	(	ilObject	$a_object = `null`,
			$a_sub_type = `null`,
			$a_sub_id = `null`
	)

Construct.

Parameters

ilObject	$a_object
string	$a_sub_type

Returns: self

Definition at line 28 of file class.ilObjectMetaDataGUI.php.

        {
                global $lng;
                
                if($a_object)
                {
                        $this->object = $a_object;
                        $this->obj_id = $a_object->getId();
                        $this->obj_type = $a_object->getType();
                }
                $this->sub_type = $a_sub_type;
                $this->sub_id = $a_sub_id;
                
                if(!$this->sub_type)
                {
                        $this->sub_type = "-";
                }
                
                $lng->loadLanguageModule("meta");
        }

References $lng.

Member Function Documentation

◆ addMDObserver()

ilObjectMetaDataGUI::addMDObserver	(	$a_class,
		$a_method,
		$a_section
	)

Definition at line 93 of file class.ilObjectMetaDataGUI.php.

        {
                $this->md_observers[] = array(
                        "class" => $a_class,
                        "method" => $a_method,
                        "section" => $a_section                         
                );
        }

◆ canEdit()

ilObjectMetaDataGUI::canEdit ( )

protected

Definition at line 174 of file class.ilObjectMetaDataGUI.php.

        {
                if($this->hasActiveRecords() &&
                        $this->obj_id)
                {
                        if($this->sub_type == "-" ||
                                $this->sub_id)
                        {
                                return true;
                        }
                }
                return false;
        }

References hasActiveRecords().

Referenced by getTab(), and setSubTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edit()

ilObjectMetaDataGUI::edit ( ilPropertyFormGUI $a_form = null )

protected

Definition at line 289 of file class.ilObjectMetaDataGUI.php.

        {
                global $tpl;
                
                if(!$a_form)
                {
                        $a_form = $this->initEditForm();
                }
                
                $tpl->setContent($a_form->getHTML());           
        }

References $tpl, and initEditForm().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjectMetaDataGUI::executeCommand ( )

Definition at line 49 of file class.ilObjectMetaDataGUI.php.

        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("edit");
                
                switch($next_class)
                {                       
                        case 'ilmdeditorgui':                                                                           
                                $this->setSubTabs("lom");                                       
                                include_once 'Services/MetaData/classes/class.ilMDEditorGUI.php';
                                $md_gui = new ilMDEditorGUI((int)$this->obj_id, (int)$this->sub_id, $this->getLOMType());       
                                // custom observers?
                                if(is_array($this->md_observers))
                                {
                                        foreach($this->md_observers as $observer)
                                        {
                                                $md_gui->addObserver($observer["class"], $observer["method"], $observer["section"]);
                                        }
                                }
                                // "default" repository object observer
                                else if(!$this->sub_id && 
                                        $this->object)
                                {
                                        $md_gui->addObserver($this->object, 'MDUpdateListener', 'General');
                                }
                                $ilCtrl->forwardCommand($md_gui);                               
                                break;
                                
                        case 'iladvancedmdsettingsgui': 
                                $this->setSubTabs("advmddef");  
                                include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDSettingsGUI.php';
                                $advmdgui = new ilAdvancedMDSettingsGUI($this->obj_id, $this->obj_type, $this->sub_type);                               
                                $ilCtrl->forwardCommand($advmdgui);                                                     
                                break;                          
                        
                        default:
                                $this->setSubTabs("advmd");     
                                $this->$cmd();
                                break;
                }
        }       

References $cmd, $ilCtrl, getLOMType(), and setSubTabs().

Here is the call graph for this function:

◆ getBlockHTML()

ilObjectMetaDataGUI::getBlockHTML	(	array	$a_cmds = `null`,
			$a_callback = `null`
	)

Definition at line 332 of file class.ilObjectMetaDataGUI.php.

        {
                global $lng;
                
                $html = "";
                
                include_once "Services/Object/classes/class.ilObjectMetaDataBlockGUI.php";      
                include_once "Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php";
                include_once "Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php";
                foreach(ilAdvancedMDRecord::_getSelectedRecordsByObject($this->obj_type, $this->obj_id, $this->sub_type) as $record)                    
                {                               
                        $block = new ilObjectMetaDataBlockGUI($record, $a_callback);
                        $block->setValues(new ilAdvancedMDValues($record->getRecordId(), $this->obj_id, $this->sub_type, $this->sub_id));                       
                        if($a_cmds)
                        {
                                foreach($a_cmds as $caption => $url)
                                {
                                        $block->addBlockCommand($url, $lng->txt($caption), "_top");             
                                }
                        }
                        $html.= $block->getHTML();
                }               
                
                return $html;
        }

References $html, $lng, $url, and ilAdvancedMDRecord\_getSelectedRecordsByObject().

Here is the call graph for this function:

◆ getKeyValueList()

ilObjectMetaDataGUI::getKeyValueList ( )

Definition at line 364 of file class.ilObjectMetaDataGUI.php.

        {
                $html = "";
                $sep = "";
 
                $old_dt = ilDatePresentation::useRelativeDates();
                ilDatePresentation::setUseRelativeDates(false);
 
                include_once "Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php";
                include_once "Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php";
                foreach(ilAdvancedMDRecord::_getSelectedRecordsByObject($this->obj_type, $this->obj_id, $this->sub_type) as $record)
                {
                        $vals = new ilAdvancedMDValues($record->getRecordId(), $this->obj_id, $this->sub_type, $this->sub_id);
 
 
                        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                        include_once('Services/ADT/classes/class.ilADTFactory.php');
 
                        // this correctly binds group and definitions
                        $vals->read();
 
                        $defs = $vals->getDefinitions();
                        foreach ($vals->getADTGroup()->getElements() as $element_id => $element)
                        {
                                if($element instanceof ilADTLocation)
                                {
                                        continue;
                                }
 
                                $html.= $sep.$defs[$element_id]->getTitle().": ";
 
                                if($element->isNull())
                                {
                                        $value = "-";
                                }
                                else
                                {
                                        $value = ilADTFactory::getInstance()->getPresentationBridgeForInstance($element);
 
                                        $value = $value->getHTML();
                                }
                                $html.= $value;
                                $sep = ",&nbsp;&nbsp;&nbsp; ";
                        }
 
                }
 
                ilDatePresentation::setUseRelativeDates($old_dt);
 
                return $html;
        }

References $html, ilAdvancedMDRecord\_getSelectedRecordsByObject(), ilADTFactory\getInstance(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Here is the call graph for this function:

◆ getLOMType()

ilObjectMetaDataGUI::getLOMType ( )

protected

Definition at line 102 of file class.ilObjectMetaDataGUI.php.

        {
                if($this->sub_type != "-" &&
                        $this->sub_id)
                {
                        return $this->sub_type;
                }
                else
                {
                        return $this->obj_type;
                }
        }

References $obj_type, and $sub_type.

Referenced by executeCommand(), and isLOMAvailable().

Here is the caller graph for this function:

◆ getTab()

ilObjectMetaDataGUI::getTab ( $a_base_class = null )

Definition at line 188 of file class.ilObjectMetaDataGUI.php.

        {
                global $ilCtrl;
                
                if(!$a_base_class)
                {
                        $path = array();
                }
                else
                {
                        $path = array($a_base_class);
                }
                $path[] = "ilobjectmetadatagui";
                
                $link = null;
                if($this->isLOMAvailable())
                {
                        $path[] = "ilmdeditorgui";
                        $link = $ilCtrl->getLinkTargetByClass($path, "listSection");
                }
                else if($this->isAdvMDAvailable())
                {       
                        if($this->canEdit())
                        {
                                $link = $ilCtrl->getLinkTarget($this, "edit");
                        }
                        else if($this->hasAdvancedMDSettings())
                        {
                                $path[] = "iladvancedmdsettingsgui";
                                $link = $ilCtrl->getLinkTargetByClass($path, "showRecords");
                        }       
                }               
                return $link;
        }

References $ilCtrl, $path, canEdit(), hasAdvancedMDSettings(), isAdvMDAvailable(), and isLOMAvailable().

Here is the call graph for this function:

◆ hasActiveRecords()

ilObjectMetaDataGUI::hasActiveRecords ( )

protected

Definition at line 168 of file class.ilObjectMetaDataGUI.php.

        {
                include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
                return (bool)sizeof(ilAdvancedMDRecord::_getSelectedRecordsByObject($this->obj_type, $this->obj_id, $this->sub_type));
        }

References ilAdvancedMDRecord\_getSelectedRecordsByObject().

Referenced by canEdit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAdvancedMDSettings()

ilObjectMetaDataGUI::hasAdvancedMDSettings ( )

protected

Definition at line 152 of file class.ilObjectMetaDataGUI.php.

        {                                       
                if($this->sub_id)
                {
                        return false;
                }
                
                include_once 'Services/Container/classes/class.ilContainer.php';
                include_once 'Services/Object/classes/class.ilObjectServiceSettingsGUI.php';
                
                return ilContainer::_lookupContainerSetting(
                        $this->obj_id,
                        ilObjectServiceSettingsGUI::CUSTOM_METADATA,
                        false); 
        }               

References ilContainer\_lookupContainerSetting(), and ilObjectServiceSettingsGUI\CUSTOM_METADATA.

Referenced by getTab(), and setSubTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEditForm()

ilObjectMetaDataGUI::initEditForm ( )

protected

Definition at line 264 of file class.ilObjectMetaDataGUI.php.

        {
                global $ilCtrl, $lng;
                
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $form->setFormAction($ilCtrl->getFormAction($this, "update"));                          
                $form->setTitle($lng->txt("meta_tab_advmd"));
                
                include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecordGUI.php');
                $this->record_gui = new ilAdvancedMDRecordGUI(
                        ilAdvancedMDRecordGUI::MODE_EDITOR, 
                        $this->obj_type, 
                        $this->obj_id, 
                        $this->sub_type, 
                        $this->sub_id
                );
                $this->record_gui->setPropertyForm($form);
                $this->record_gui->parse();
                
                $form->addCommandButton("update", $lng->txt("save"));
                
                return $form;
        }

References $ilCtrl, $lng, and ilAdvancedMDRecordGUI\MODE_EDITOR.

Referenced by edit(), and update().

Here is the caller graph for this function:

◆ isAdvMDAvailable()

ilObjectMetaDataGUI::isAdvMDAvailable ( )

protected

Definition at line 115 of file class.ilObjectMetaDataGUI.php.

        {
                include_once 'Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php';
                foreach(ilAdvancedMDRecord::_getAssignableObjectTypes(false) as $item)
                {                       
                        if($item["obj_type"] == $this->obj_type)
                        {
                                return ((!$item["sub_type"] && $this->sub_type == "-") ||
                                        ($item["sub_type"] == $this->sub_type));
                        }
                }
                return false;
        }

References ilAdvancedMDRecord\_getAssignableObjectTypes().

Referenced by getTab(), and setSubTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLOMAvailable()

ilObjectMetaDataGUI::isLOMAvailable ( )

protected

Definition at line 129 of file class.ilObjectMetaDataGUI.php.

        {                                               
                $type = $this->getLOMType();
                if($type == $this->sub_type)
                {
                        $type = $this->obj_type.":".$type;
                }
                
                return (($this->obj_id || !$this->obj_type) &&
                        in_array($type, array(
                                "crs", 
                                "file", 
                                "glo", "glo:gdf", 
                                "svy", "spl", 
                                "tst", "qpl", 
                                ":mob", 
                                "webr", 
                                "htlm", 
                                "lm", "lm:st", "lm:pg",
                                "sahs", "sahs:sco", "sahs:page"
                )));
        }

References getLOMType().

Referenced by getTab(), and setSubTabs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubTabs()

ilObjectMetaDataGUI::setSubTabs ( $a_active )

protected

Definition at line 223 of file class.ilObjectMetaDataGUI.php.

        {
                global $ilTabs, $lng, $ilCtrl;
                                
                if($this->isLOMAvailable())
                {
                        $ilTabs->addSubTab("lom",                       
                                $lng->txt("meta_tab_lom"),
                                $ilCtrl->getLinkTargetByClass("ilmdeditorgui", "listSection")
                        );
                }
                
                if($this->isAdvMDAvailable())
                {               
                        if($this->canEdit())
                        {
                                $ilTabs->addSubTab("advmd",
                                        $lng->txt("meta_tab_advmd"),
                                        $ilCtrl->getLinkTarget($this, "edit"));
                        }
 
                        if($this->hasAdvancedMDSettings())
                        {
                                $ilTabs->addSubTab("advmddef",
                                        $lng->txt("meta_tab_advmd_def"),
                                        $ilCtrl->getLinkTargetByClass("iladvancedmdsettingsgui", "showRecords"));
                                                                
                                $ilTabs->addSubTab("md_adv_file_list",
                                        $lng->txt("md_adv_file_list"),
                                        $ilCtrl->getLinkTargetByClass("iladvancedmdsettingsgui", "showFiles"));
                        }                               
                }
                
                $ilTabs->activateSubTab($a_active);
        }

References $ilCtrl, $lng, canEdit(), hasAdvancedMDSettings(), isAdvMDAvailable(), and isLOMAvailable().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjectMetaDataGUI::update ( )

protected

Definition at line 301 of file class.ilObjectMetaDataGUI.php.

        {
                global $lng, $ilCtrl;
                
                $form = $this->initEditForm();
                if($form->checkInput() &&
                        $this->record_gui->importEditFormPostValues())
                {
                        $this->record_gui->writeEditForm();
                        
                        // Update ECS content
                        if($this->obj_type == "crs")
                        {
                                include_once "Modules/Course/classes/class.ilECSCourseSettings.php";
                                $ecs = new ilECSCourseSettings($this->object);
                                $ecs->handleContentUpdate();
                        }
                        
                        ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                        $ilCtrl->redirect($this, "edit");
                }
                
                $form->setValuesByPost();
                $this->edit($form);
        }

References $ilCtrl, $lng, edit(), initEditForm(), and ilUtil\sendSuccess().

Here is the call graph for this function:

Field Documentation

◆ $md_observers

ilObjectMetaDataGUI::$md_observers

protected

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

◆ $obj_id

ilObjectMetaDataGUI::$obj_id

protected

Definition at line 15 of file class.ilObjectMetaDataGUI.php.

◆ $obj_type

ilObjectMetaDataGUI::$obj_type

protected

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

Referenced by getLOMType().

◆ $object

ilObjectMetaDataGUI::$object

protected

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

◆ $sub_id

ilObjectMetaDataGUI::$sub_id

protected

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

◆ $sub_type

ilObjectMetaDataGUI::$sub_type

protected

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

Referenced by getLOMType().

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

Services/Object/classes/class.ilObjectMetaDataGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addMDObserver()

◆ canEdit()

◆ edit()

◆ executeCommand()

◆ getBlockHTML()

◆ getKeyValueList()

◆ getLOMType()

◆ getTab()

◆ hasActiveRecords()

◆ hasAdvancedMDSettings()

◆ initEditForm()

◆ isAdvMDAvailable()

◆ isLOMAvailable()

◆ setSubTabs()

◆ update()

Field Documentation

◆ $md_observers

◆ $obj_id

◆ $obj_type

◆ $object

◆ $sub_id

◆ $sub_type