ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjectMetaDataBlockGUI Class Reference

Metadata block. More...

+ Inheritance diagram for ilObjectMetaDataBlockGUI:
+ Collaboration diagram for ilObjectMetaDataBlockGUI:

Public Member Functions

 __construct (ilAdvancedMDRecord $a_record, $a_decorator_callback=null)
 Constructor. More...
 
 setValues (ilAdvancedMDValues $a_values)
 
executeCommand ()
 execute command More...
 
 fillDataSection ()
 Fill data section. More...
 
- Public Member Functions inherited from ilBlockGUI
 ilBlockGUI ()
 Constructor. More...
 
 addHeaderLink ($a_href, $a_text, $status=true)
 
 getHeaderLinks ()
 
 setData ($a_data)
 Set Data. More...
 
 getData ()
 Get Data. More...
 
 setBigMode ($a_bigmode)
 Set Big Mode. More...
 
 getBigMode ()
 Get Big Mode. More...
 
 setBlockId ($a_block_id=0)
 Set Block Id. More...
 
 getBlockId ()
 Get Block Id. More...
 
 setAvailableDetailLevels ($a_max, $a_min=0)
 Set Available Detail Levels. More...
 
 setCurrentDetailLevel ($a_currentdetaillevel)
 Set Current Detail Level. More...
 
 setGuiObject (&$a_gui_object)
 Set GuiObject. More...
 
 getGuiObject ()
 Get GuiObject. More...
 
 getCurrentDetailLevel ()
 Get Current Detail Level. More...
 
 setTitle ($a_title)
 Set Title. More...
 
 getTitle ()
 Get Title. More...
 
 setImage ($a_image)
 Set Image. More...
 
 getImage ()
 Get Image. 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...
 
 setFooterInfo ($a_footerinfo, $a_hide_and_icon=false)
 Set Footer Info. More...
 
 getFooterInfo ($a_hide_and_icon=false)
 Get Footer Info. 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 ($a_admincommands)
 Set Administration Commmands. More...
 
 getAdminCommands ()
 Get Administration Commmands. More...
 
 setColSpan ($a_colspan)
 Set Columns Span. More...
 
 getColSpan ()
 Get Columns Span. More...
 
 setEnableDetailRow ($a_enabledetailrow)
 Set EnableDetailRow. More...
 
 getEnableDetailRow ()
 Get EnableDetailRow. 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 ()
 
 getDetailParameter ()
 
 getConfigParameter ()
 
 getMoveParameter ()
 
 getRowTemplateName ()
 Get Row Template Name. More...
 
 getRowTemplateDir ()
 Get Row Template Directory. More...
 
 addBlockCommand ($a_href, $a_text, $a_target="", $a_img="", $a_right_aligned=false, $a_checked=false, $a_html="")
 Add Block Command. More...
 
 getBlockCommands ()
 Get Block commands. More...
 
 addHeaderCommand ($a_href, $a_text, $a_as_close=false)
 Add Header Block Command. More...
 
 getHeaderCommands ()
 Get Header Block commands. More...
 
 addFooterLink ($a_text, $a_href="", $a_onclick="", $a_block_id="", $a_top=false, $a_omit_separator=false, $a_checked=false)
 Add a footer text/link. More...
 
 getFooterLinks ()
 Get footer links. More...
 
 clearFooterLinks ()
 Clear footer links. More...
 
 handleDetailLevel ()
 Handle read/write current detail level. More...
 
 getHTML ()
 Handle config status. 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...
 
 fillFooterLinks ($a_top=false, $a_numinfo="")
 Fill footer links. More...
 
 fillDetailRow ()
 Fill Detail Setting Row. More...
 

Static Public Member Functions

static getBlockType ()
 Get block type. More...
 
static isRepositoryObject ()
 Is this a repository object. More...
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 
static getBlockType ()
 
static isRepositoryObject ()
 
static getScreenMode ()
 Get Screen Mode for current command. More...
 

Static Public Attributes

static $block_type = "advmd"
 

Protected Attributes

 $record
 
 $values
 
 $callback
 
- Protected Attributes inherited from ilBlockGUI
 $data = array()
 
 $colspan = 1
 
 $enablenuminfo = true
 
 $detail_min = 0
 
 $detail_max = 0
 
 $bigmode = false
 
 $footer_links = array()
 
 $block_id = 0
 
 $header_commands = array()
 
 $allow_moving = true
 
 $move = array("left" => false, "right" => false, "up" => false, "down" => false)
 
 $enabledetailrow = true
 
 $header_links = array()
 
 $footerinfo = false
 
 $footerinfo_icon = false
 
 $block_commands = array()
 
 $max_count = false
 
 $close_command = false
 
 $image = false
 
 $property = false
 
 $nav_value = ""
 
 $css_row = ""
 
 $dropdown
 

Static Protected Attributes

static $records = array()
 

Additional Inherited Members

- Protected Member Functions inherited from ilBlockGUI
 fillRowColor ($a_placeholder="CSS_ROW")
 
 preloadData (array $data)
 Can be overwritten in subclasses. More...
 

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$

@ilCtrl_IsCalledBy 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.

31 {
32 parent::ilBlockGUI();
33
34 $this->record = $a_record;
35 $this->callback = $a_decorator_callback;
36
37 $this->setTitle($this->record->getTitle());
38 $this->setBlockId("advmd_".$this->record->getRecordId());
39 $this->setEnableNumInfo(false);
40 // $this->setAvailableDetailLevels(3);
41 $this->allow_moving = false;
42 }
setTitle($a_title)
Set Title.
setBlockId($a_block_id=0)
Set Block Id.
setEnableNumInfo($a_enablenuminfo)
Set Enable Item Number Info.

References 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 80 of file class.ilObjectMetaDataBlockGUI.php.

81 {
82 global $ilCtrl;
83
84 $next_class = $ilCtrl->getNextClass();
85 $cmd = $ilCtrl->getCmd("getHTML");
86
87 switch ($next_class)
88 {
89 default:
90 return $this->$cmd();
91 }
92 }
global $ilCtrl
Definition: ilias.php:18
$cmd
Definition: sahs_server.php:35

References $cmd, and $ilCtrl.

◆ fillDataSection()

ilObjectMetaDataBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

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

98 {
99 global $lng;
100
101 $btpl = new ilTemplate("tpl.advmd_block.html", true, true, "Services/Object");
102
103 // see ilAdvancedMDRecordGUI::parseInfoPage()
104
107
108 include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
109 include_once('Services/ADT/classes/class.ilADTFactory.php');
110
111 // this correctly binds group and definitions
112 $this->values->read();
113
114 $defs = $this->values->getDefinitions();
115 foreach($this->values->getADTGroup()->getElements() as $element_id => $element)
116 {
117 $btpl->setCurrentBlock("item");
118 $btpl->setVariable("CAPTION", $defs[$element_id]->getTitle());
119 if($element->isNull())
120 {
121 $value = "-";
122 }
123 else
124 {
125 $value = ilADTFactory::getInstance()->getPresentationBridgeForInstance($element);
126
127 if($element instanceof ilADTLocation)
128 {
129 $value->setSize("100%", "200px");
130 }
131
132 if(in_array($element->getType(), array("MultiEnum", "Enum", "Text")))
133 {
134 $value->setDecoratorCallBack($this->callback);
135 }
136
137 $value = $value->getHTML();
138 }
139 $btpl->setVariable("VALUE", $value);
140 $btpl->parseCurrentBlock();
141 }
142
143 $this->setDataSection($btpl->get());
144
146
147 return;
148 }
static getInstance()
Get singleton.
setDataSection($a_content)
Call this from overwritten fillDataSection(), if standard row based data is not used.
getTitle()
Get Title.
static setUseRelativeDates($a_status)
set use relative dates
static useRelativeDates()
check if relative dates are used
special template class to simplify handling of ITX/PEAR
global $lng
Definition: privfeed.php:40

References $lng, ilADTFactory\getInstance(), ilBlockGUI\getTitle(), ilBlockGUI\setDataSection(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

+ Here is the call graph for this function:

◆ getBlockType()

static ilObjectMetaDataBlockGUI::getBlockType ( )
static

Get block type.

Returns
string Block type.

Reimplemented from ilBlockGUI.

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

References $block_type.

◆ getScreenMode()

static ilObjectMetaDataBlockGUI::getScreenMode ( )
static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

68 {
69 return IL_SCREEN_SIDE;
70 }
const IL_SCREEN_SIDE

References IL_SCREEN_SIDE.

◆ isRepositoryObject()

static ilObjectMetaDataBlockGUI::isRepositoryObject ( )
static

Is this a repository object.

Returns
string Block type.

Reimplemented from ilBlockGUI.

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

60 {
61 return false;
62 }

◆ setValues()

ilObjectMetaDataBlockGUI::setValues ( ilAdvancedMDValues  $a_values)

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

73 {
74 $this->values = $a_values;
75 }

Field Documentation

◆ $block_type

ilObjectMetaDataBlockGUI::$block_type = "advmd"
static

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

Referenced by getBlockType().

◆ $callback

ilObjectMetaDataBlockGUI::$callback
protected

Definition at line 23 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: