Advanced metadata wiki block. More...

Inheritance diagram for ilWikiAdvMetaDataBlockGUI:

Collaboration diagram for ilWikiAdvMetaDataBlockGUI:

Public Member Functions
	__construct (ilAdvancedMDRecord $a_record)
	Constructor. More...

	setObject ($a_wiki_ref_id, $a_wiki_obj_id, $a_page_id)

&	executeCommand ()
	execute command More...

	getHTML ($a_export=false)
	Get block HTML code. 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	getRecords ($a_wiki_obj_id)

static	isActive ($a_wiki_obj_id)

static	getBlockType ()

static	isRepositoryObject ()

static	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = "wikiadvmd"

static	$st_data

Protected Member Functions
	isHidden ()
	Is block currently hidden? More...

Protected Member Functions inherited from ilBlockGUI
	fillRowColor ($a_placeholder="CSS_ROW")

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

Protected Attributes
	$export = false

	$obj_id

	$ref_id

	$page_id

	$record

	$adv_md_hidden

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

Detailed Description

Advanced metadata wiki 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 ilWikiAdvMetaDataBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilWikiAdvMetaDataBlockGUI::__construct ( ilAdvancedMDRecord $a_record )

Constructor.

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

        {
                global $ilCtrl, $lng;
                
                parent::ilBlockGUI();
                                                
                $this->record = $a_record;              
                
                $this->setTitle($this->record->getTitle());             
                $this->setBlockId("advmdwiki_".$this->record->getRecordId());                           
                $this->setEnableNumInfo(false);
                // $this->setAvailableDetailLevels(3);          
                $this->allow_moving = false;
                
                $lng->loadLanguageModule("wiki");
        }

References $ilCtrl, $lng, ilBlockGUI\setBlockId(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setTitle().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

& ilWikiAdvMetaDataBlockGUI::executeCommand ( )

execute command

Definition at line 89 of file class.ilWikiAdvMetaDataBlockGUI.php.

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

References $cmd, and $ilCtrl.

◆ fillDataSection()

ilWikiAdvMetaDataBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 162 of file class.ilWikiAdvMetaDataBlockGUI.php.

        {               
                global $lng;
                
                $btpl = new ilTemplate("tpl.wiki_advmd_block.html", true, true, "Modules/Wiki");                
                
                // 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');    
                                
                $values = new ilAdvancedMDValues($this->record->getRecordId(), $this->obj_id, "wpg", $this->page_id);
 
                // this correctly binds group and definitions
                $values->read();
 
                $defs = $values->getDefinitions();                                                                      
                foreach($values->getADTGroup()->getElements() as $element_id => $element)                               
                {                                                                                                                                                                                               
                        $btpl->setCurrentBlock("item");
                        $btpl->setVariable("CAPTION", $defs[$element_id]->getTitle());
                        if($element->isNull())
                        {       
                                $value = "-";
                        }
                        else
                        {
                                $value = ilADTFactory::getInstance()->getPresentationBridgeForInstance($element);
 
                                if($element instanceof ilADTLocation)
                                {
                                        $value->setSize("100%", "200px");
                                }
 
                                $value = $value->getHTML();
                        }
                        $btpl->setVariable("VALUE", $value);
                        $btpl->parseCurrentBlock();                                                                             
                }
                
                /*
                if ($this->isHidden())
                {
                        $btpl->setVariable("HIDDEN_INFO", $lng->txt("wiki_adv_md_hidden"));                     
                }
                */
                
                $this->setDataSection($btpl->get());            
                
                ilDatePresentation::setUseRelativeDates($old_dt);
                
                return;         
        }               

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

Here is the call graph for this function:

◆ getBlockType()

static ilWikiAdvMetaDataBlockGUI::getBlockType ( )

static

Get block type.

Returns: string Block type.

Reimplemented from ilBlockGUI.

Definition at line 56 of file class.ilWikiAdvMetaDataBlockGUI.php.

        {
                return self::$block_type;
        }

References $block_type.

◆ getHTML()

ilWikiAdvMetaDataBlockGUI::getHTML ( $a_export = false )

Get block HTML code.

Definition at line 106 of file class.ilWikiAdvMetaDataBlockGUI.php.

        {
                global $ilCtrl, $lng, $ilAccess;
 
                $this->export = $a_export;
                
                $has_write = $ilAccess->checkAccess("write", "", $this->ref_id);
                
                if ($this->isHidden())
                {                       
                        #16029 - hide completely
                        return;                                 
                }
                
                if (!$this->export && $has_write)
                {
                        $this->addBlockCommand(
                                $ilCtrl->getLinkTargetByClass("ilwikipagegui", "editAdvancedMetaData"),
                                $lng->txt("edit"), "_top");
                                                
                        if (!$this->isHidden())
                        {
                                $this->addBlockCommand(
                                        $ilCtrl->getLinkTargetByClass("ilwikipagegui", "hideAdvancedMetaData"),
                                        $lng->txt("hide"), "_top");             
                        }
                        /* #16029 - moved to page actions
                        else
                        {
                                $this->addBlockCommand(
                                        $ilCtrl->getLinkTargetByClass("ilwikipagegui", "unhideAdvancedMetaData"),
                                        $lng->txt("show"), "_top");             
                        }                        
                        */
                }
                
                return parent::getHTML();
        }

References $ilCtrl, $lng, ilBlockGUI\addBlockCommand(), and isHidden().

Here is the call graph for this function:

◆ getRecords()

static ilWikiAdvMetaDataBlockGUI::getRecords ( $a_wiki_obj_id )

static

Definition at line 219 of file class.ilWikiAdvMetaDataBlockGUI.php.

        {
                if(!array_key_exists($a_wiki_obj_id, self::$records))
                {
                        include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');                                         
                        self::$records[$a_wiki_obj_id] = ilAdvancedMDRecord::_getSelectedRecordsByObject("wiki", $a_wiki_obj_id, "wpg");
                }
                return self::$records[$a_wiki_obj_id];
        }

References $records, and ilAdvancedMDRecord\_getSelectedRecordsByObject().

Referenced by isActive(), and ilObjWikiGUI\renderSideBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScreenMode()

static ilWikiAdvMetaDataBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

        {
                return IL_SCREEN_SIDE;
        }

References IL_SCREEN_SIDE.

◆ isActive()

static ilWikiAdvMetaDataBlockGUI::isActive ( $a_wiki_obj_id )

static

Definition at line 229 of file class.ilWikiAdvMetaDataBlockGUI.php.

        {               
                return (bool)sizeof(self::getRecords($a_wiki_obj_id));  
        }

References getRecords().

Referenced by ilWikiFunctionsBlockGUI\fillDataSection(), and ilObjWikiGUI\renderSideBlock().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isHidden()

ilWikiAdvMetaDataBlockGUI::isHidden ( )

protected

Is block currently hidden?

Returns: boolean

Definition at line 150 of file class.ilWikiAdvMetaDataBlockGUI.php.

        {
                if($this->adv_md_hidden === null)
                {
                        $this->adv_md_hidden = ilWikiPage::lookupAdvancedMetadataHidden($this->page_id);
                }
                return $this->adv_md_hidden;
        }

References $adv_md_hidden, and ilWikiPage\lookupAdvancedMetadataHidden().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRepositoryObject()

static ilWikiAdvMetaDataBlockGUI::isRepositoryObject ( )

static

Is this a repository object.

Returns: string Block type.

Reimplemented from ilBlockGUI.

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

        {
                return false;
        }

◆ setObject()

ilWikiAdvMetaDataBlockGUI::setObject	(	$a_wiki_ref_id,
		$a_wiki_obj_id,
		$a_page_id
	)

Definition at line 79 of file class.ilWikiAdvMetaDataBlockGUI.php.

        {
                $this->ref_id = $a_wiki_ref_id;
                $this->obj_id = $a_wiki_obj_id;
                $this->page_id = $a_page_id;
        }

Field Documentation

◆ $adv_md_hidden

ilWikiAdvMetaDataBlockGUI::$adv_md_hidden

protected

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

Referenced by isHidden().

◆ $block_type

ilWikiAdvMetaDataBlockGUI::$block_type = "wikiadvmd"

static

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

Referenced by getBlockType().

◆ $export

ilWikiAdvMetaDataBlockGUI::$export = false

protected

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

◆ $obj_id

ilWikiAdvMetaDataBlockGUI::$obj_id

protected

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

◆ $page_id

ilWikiAdvMetaDataBlockGUI::$page_id

protected

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

◆ $record

ilWikiAdvMetaDataBlockGUI::$record

protected

Definition at line 26 of file class.ilWikiAdvMetaDataBlockGUI.php.

◆ $records

ilWikiAdvMetaDataBlockGUI::$records = array()

staticprotected

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

◆ $ref_id

ilWikiAdvMetaDataBlockGUI::$ref_id

protected

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

◆ $st_data

ilWikiAdvMetaDataBlockGUI::$st_data

static

Definition at line 20 of file class.ilWikiAdvMetaDataBlockGUI.php.

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

Modules/Wiki/classes/class.ilWikiAdvMetaDataBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ fillDataSection()

◆ getBlockType()

◆ getHTML()

◆ getRecords()

◆ getScreenMode()

◆ isActive()

◆ isHidden()

◆ isRepositoryObject()

◆ setObject()

Field Documentation

◆ $adv_md_hidden

◆ $block_type

◆ $export

◆ $obj_id

◆ $page_id

◆ $record

◆ $records

◆ $ref_id

◆ $st_data