Metadata block. More...

Inheritance diagram for ilObjectMetaDataBlockGUI:

Collaboration diagram for ilObjectMetaDataBlockGUI:

Public Member Functions
	__construct (ilAdvancedMDRecord $record, ?array $decorator_callback=null)
	Takes as an optional second input an array consisting of the object that the method that should be called back to belongs to, and a string with the name of the method. More...

	getBlockType ()

	setValues (ilAdvancedMDValues $a_values)

	executeCommand ()
	execute command More...

Public Member Functions inherited from ilBlockGUI
	__construct ()

	getBlockType ()

	setData (array $a_data)

	getData ()

	setPresentation (int $type)

	getPresentation ()

	setBlockId (string $a_block_id="0")

	getBlockId ()

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

	getGuiObject ()

	setTitle (string $a_title)

	getTitle ()

	setOffset (int $a_offset)

	getOffset ()

	checkOffset (int $offset)

	setLimit (int $a_limit)

	getLimit ()

	setEnableEdit (bool $a_enableedit)

	getEnableEdit ()

	setRepositoryMode (bool $a_repositorymode)

	getRepositoryMode ()

	setSubtitle (string $a_subtitle)

	getSubtitle ()

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

	getRefId ()

	setAdminCommands (bool $a_admincommands)

	getAdminCommands ()

	setEnableNumInfo (bool $a_enablenuminfo)

	getEnableNumInfo ()

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

	getProperty (string $a_property)

	setProperty (string $a_property, string $a_value)

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

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()

	getRowTemplateDir ()

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="", ?RoundTrip $modal=null)

	getBlockCommands ()

	getHTML ()

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

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

	getViewControlsForPanel ()

	sortObject ()

	addSortOption (string $option, string $label, bool $active)

	setSortTarget (string $target)

	addPresentation (string $label, string $target, bool $active)

	getNoItemFoundContent ()

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

static	getScreenMode ()

Static Public Attributes
static string	$block_type = "advmd"

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

	getLegacyContent ()
	Get legacy content. Returns string More...

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

	specialCharsAsEntities (string $string)

	initCommands ()

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

	getLegacyContent ()
	Get legacy content. 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...

	getActionsForPanel ()

	send (string $output)
	Send. More...

Protected Attributes
ilAdvancedMDRecord	$record

ilAdvancedMDValues	$values

array	$callback

Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer

Factory	$factory

object	$gui_object

ILIAS Container Block StandardGUIRequest	$request

ILIAS Container Block BlockManager	$block_manager

bool	$repositorymode = false

ILIAS DI UIServices	$ui

array	$data = array()

bool	$enablenuminfo = true

array	$footer_links = array()

string	$block_id = "0"

bool	$allow_moving = true

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

array	$block_commands = array()

int	$max_count = 0

bool	$close_command = false

bool	$image = false

array	$property = []

string	$nav_value = ""

string	$css_row = ""

string	$title = ""

bool	$admincommands = false

array	$dropdown

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilObjUser	$user

ilCtrl	$ctrl

ilAccessHandler	$access

ilLanguage	$lng

ilObjectDefinition	$obj_def

int	$presentation

int	$requested_ref_id

Static Protected Attributes
static array	$records = []

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

const	PRES_MAIN_TILE = 4

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 @ilCtrl_IsCalledBy ilObjectMetaDataBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilObjectMetaDataBlockGUI::__construct	(	ilAdvancedMDRecord	$record,
		?array	$decorator_callback = `null`
	)

Takes as an optional second input an array consisting of the object that the method that should be called back to belongs to, and a string with the name of the method.

Parameters

ilAdvancedMDRecord	$record
	null\|array{0	ilObject, 1: string} $decorator_callback

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
 
 
        parent::__construct();
 
        $this->record = $record;
        $this->callback = $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;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilObjectMetaDataBlockGUI::executeCommand ( )

execute command

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

                                    : void
    {
        $this->ctrl->getNextClass();
        $cmd = $this->ctrl->getCmd("getHTML");
        $this->$cmd();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getBlockType()

ilObjectMetaDataBlockGUI::getBlockType ( )

Reimplemented from ilBlockGUI.

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

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getLegacyContent()

ilObjectMetaDataBlockGUI::getLegacyContent ( )

protected

Get legacy content.

Returns: string

Reimplemented from ilBlockGUI.

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

                                         : string
    {
        $btpl = new ilTemplate("tpl.advmd_block.html", true, true, "components/ILIAS/ILIASObject");
 
        // see ilAdvancedMDRecordGUI::parseInfoPage()
 
        $old_dt = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
 
        // 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 (in_array($element->getType(), ["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;
    }

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

Here is the call graph for this function:

◆ getScreenMode()

static ilObjectMetaDataBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

                                          : string
    {
        return IL_SCREEN_SIDE;
    }

References IL_SCREEN_SIDE.

◆ isRepositoryObject()

ilObjectMetaDataBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

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

                                           : bool
    {
        return false;
    }

◆ setValues()

ilObjectMetaDataBlockGUI::setValues ( ilAdvancedMDValues $a_values )

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

                                                           : void
    {
        $this->values = $a_values;
    }

Field Documentation

◆ $block_type

string ilObjectMetaDataBlockGUI::$block_type = "advmd"

static

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

Referenced by getBlockType().

◆ $callback

array ilObjectMetaDataBlockGUI::$callback

protected

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

◆ $record

ilAdvancedMDRecord ilObjectMetaDataBlockGUI::$record

protected

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

Referenced by __construct().

◆ $records

array ilObjectMetaDataBlockGUI::$records = []

staticprotected

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

◆ $values

ilAdvancedMDValues ilObjectMetaDataBlockGUI::$values

protected

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

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

components/ILIAS/ILIASObject/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()

◆ getBlockType()

◆ getLegacyContent()

◆ getScreenMode()

◆ isRepositoryObject()

◆ setValues()

Field Documentation

◆ $block_type

◆ $callback

◆ $record

◆ $records

◆ $values