Metadata block. More...

Inheritance diagram for ilObjectMetaDataBlockGUI:

Collaboration diagram for ilObjectMetaDataBlockGUI:

Public Member Functions
	__construct (ilAdvancedMDRecord $a_record, $a_decorator_callback=null)
	Constructor. More...

	getBlockType ()

	setValues (ilAdvancedMDValues $a_values)

	executeCommand ()
	execute command More...

	fillDataSection ()
	Fill data section. More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

	setGuiObject (&$a_gui_object)
	Set GuiObject. More...

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. More...

	setOffset ($a_offset)
	Set Offset. More...

	getOffset ()
	Get Offset. More...

	correctOffset ()

	setLimit ($a_limit)
	Set Limit. More...

	getLimit ()
	Get Limit. More...

	setEnableEdit ($a_enableedit)
	Set EnableEdit. More...

	getEnableEdit ()
	Get EnableEdit. More...

	setRepositoryMode ($a_repositorymode)
	Set RepositoryMode. More...

	getRepositoryMode ()
	Get RepositoryMode. More...

	setSubtitle ($a_subtitle)
	Set Subtitle. More...

	getSubtitle ()
	Get Subtitle. More...

	setRefId ($a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()
	Get Ref Id (only used if isRepositoryObject() is true). More...

	setAdminCommands (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. More...

	setEnableNumInfo ($a_enablenuminfo)
	Set Enable Item Number Info. More...

	getEnableNumInfo ()
	Get Enable Item Number Info. More...

	setProperties ($a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty ($a_property)

	setProperty ($a_property, $a_value)

	setRowTemplate ($a_rowtemplatename, $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. More...

	fillHeaderCommands ()
	Fill header commands block. More...

	fillHeaderTitleBlock ()
	Fill header title block (title and. More...

	setDataSection ($a_content)
	Call this from overwritten fillDataSection(), if standard row based data is not used. More...

	fillDataSection ()
	Standard implementation for row based data. More...

	fillRow ($a_set)

	fillFooter ()

	fillPreviousNext ()
	Fill previous/next row. More...

	setPreviousNextLinks ()
	Get previous/next linkbar. More...

	getAsynch ()
	Use this for final get before sending asynchronous output (ajax) per echo to output. More...

	getPaginationViewControl ()
	Fill previous/next row. More...

	getHTMLNew ()
	Get HTML. More...

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = "advmd"

Protected Member Functions
	isRepositoryObject ()

	getLegacyContent ()

Protected Member Functions inherited from ilBlockGUI
	isRepositoryObject ()
	Returns whether block has a corresponding repository object. More...

	initCommands ()
	Init commands. More...

	fillRowColor ($a_placeholder="CSS_ROW")

	preloadData (array $data)
	Can be overwritten in subclasses. More...

	getLegacyContent ()
	Get legacy content. More...

	getViewControls ()
	Get view controls. More...

	getListItemForData (array $data)
	Get list item for data array. More...

	handleNavigation ()
	Handle navigation. More...

	loadData ()
	Load data for current page. More...

	getListItemGroups ()
	Get items. More...

	addRepoCommands ()
	Add repo commands. More...

	getNoItemFoundContent ()
	No item entry. More...

Protected Attributes
	$record

	$values

	$callback

	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

	$move = array("left" => false, "right" => false, "up" => false, "down" => false)

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

Static Protected Attributes
static	$records = array()

Additional Inherited Members
Data Fields inherited from ilBlockGUI
const	PRES_MAIN_LEG = 0

const	PRES_SEC_LEG = 1

const	PRES_SEC_LIST = 2

const	PRES_MAIN_LIST = 3

Detailed Description

Metadata block.

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

Version: $Id$

ilObjectMetaDataBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectMetaDataBlockGUI::__construct	(	ilAdvancedMDRecord	$a_record,
			$a_decorator_callback = `null`
	)

Constructor.

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), ilBlockGUI\setBlockId(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setTitle().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
 
 
         parent::__construct();
                         
         $this->record = $a_record;
         $this->callback = $a_decorator_callback;
 
         $translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->record->getRecordId());
         $this->setTitle($translations->getTitleForLanguage($this->lng->getLangKey()));
         $this->setBlockId("advmd_" . $this->record->getRecordId());
         $this->setEnableNumInfo(false);
         $this->allow_moving = false;
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilObjectMetaDataBlockGUI::executeCommand ( )

execute command

Definition at line 82 of file class.ilObjectMetaDataBlockGUI.php.

References ilBlockGUI\$ctrl.

     {
         $ilCtrl = $this->ctrl;
 
         $next_class = $ilCtrl->getNextClass();
         $cmd = $ilCtrl->getCmd("getHTML");
 
         switch ($next_class) {
             default:
                 return $this->$cmd();
         }
     }

◆ fillDataSection()

ilObjectMetaDataBlockGUI::fillDataSection ( )

Fill data section.

Definition at line 98 of file class.ilObjectMetaDataBlockGUI.php.

References getLegacyContent(), and ilBlockGUI\setDataSection().

     {
         $this->setDataSection($this->getLegacyContent());
     }

Here is the call graph for this function:

◆ getBlockType()

ilObjectMetaDataBlockGUI::getBlockType ( )

Definition at line 53 of file class.ilObjectMetaDataBlockGUI.php.

                                    : string
     {
         return self::$block_type;
     }

◆ getLegacyContent()

ilObjectMetaDataBlockGUI::getLegacyContent ( )

protected

Definition at line 113 of file class.ilObjectMetaDataBlockGUI.php.

References ilADTFactory\getInstance(), ilAdvancedMDFieldTranslations\getInstanceByRecordId(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by fillDataSection().

                                           : string
     {
         $btpl = new ilTemplate("tpl.advmd_block.html", true, true, "Services/Object");
         
         // see ilAdvancedMDRecordGUI::parseInfoPage()
         
         $old_dt = ilDatePresentation::useRelativeDates();
         ilDatePresentation::setUseRelativeDates(false);
         
         include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
         include_once('Services/ADT/classes/class.ilADTFactory.php');
         
         // this correctly binds group and definitions
         $this->values->read();
 
         $defs = $this->values->getDefinitions();
         foreach ($this->values->getADTGroup()->getElements() as $element_id => $element) {
             $field_translations = ilAdvancedMDFieldTranslations::getInstanceByRecordId($defs[$element_id]->getRecordId());
 
             $btpl->setCurrentBlock("item");
             $btpl->setVariable("CAPTION", $field_translations->getTitleForLanguage($element_id, $this->lng->getLangKey()));
             if ($element->isNull()) {
                 $value = "-";
             } else {
                 $value = ilADTFactory::getInstance()->getPresentationBridgeForInstance($element);
 
                 if ($element instanceof ilADTLocation) {
                     $value->setSize("100%", "200px");
                 }
                 
                 if (in_array($element->getType(), array("MultiEnum", "Enum", "Text"))) {
                     $value->setDecoratorCallBack($this->callback);
                 }
 
                 $value = $value->getHTML();
             }
             $btpl->setVariable("VALUE", $value);
             $btpl->parseCurrentBlock();
         }
                     
         $html = $btpl->get();
         
         ilDatePresentation::setUseRelativeDates($old_dt);
         
         return $html;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScreenMode()

static ilObjectMetaDataBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Definition at line 69 of file class.ilObjectMetaDataBlockGUI.php.

References IL_SCREEN_SIDE.

     {
         return IL_SCREEN_SIDE;
     }

◆ isRepositoryObject()

ilObjectMetaDataBlockGUI::isRepositoryObject ( )

protected

Definition at line 61 of file class.ilObjectMetaDataBlockGUI.php.

                                             : bool
     {
         return false;
     }

◆ setValues()

ilObjectMetaDataBlockGUI::setValues ( ilAdvancedMDValues $a_values )

Definition at line 74 of file class.ilObjectMetaDataBlockGUI.php.

     {
         $this->values = $a_values;
     }

Field Documentation

◆ $block_type

ilObjectMetaDataBlockGUI::$block_type = "advmd"

static

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

◆ $callback

ilObjectMetaDataBlockGUI::$callback

protected

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

◆ $new_rendering

ilObjectMetaDataBlockGUI::$new_rendering = true

protected

Definition at line 107 of file class.ilObjectMetaDataBlockGUI.php.

◆ $record

ilObjectMetaDataBlockGUI::$record

protected

Definition at line 21 of file class.ilObjectMetaDataBlockGUI.php.

◆ $records

ilObjectMetaDataBlockGUI::$records = array()

staticprotected

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

◆ $values

ilObjectMetaDataBlockGUI::$values

protected

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

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

Services/Object/classes/class.ilObjectMetaDataBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ fillDataSection()

◆ getBlockType()

◆ getLegacyContent()

◆ getScreenMode()

◆ isRepositoryObject()

◆ setValues()

Field Documentation

◆ $block_type

◆ $callback

◆ $new_rendering

◆ $record

◆ $records

◆ $values