BlockGUI class for Personal Desktop Notes block. More...

Inheritance diagram for ilPDNotesBlockGUI:

Collaboration diagram for ilPDNotesBlockGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	getBlockType ()

	executeCommand ()
	execute command More...

	getHTML ()

	fillDataSection ()
	Fill data section. More...

	getListRowData ()
	Get list data. More...

	fillRow ($a_set)
	get flat bookmark list for personal desktop More...

	getOverview ()
	Get overview. More...

	showNote ()
	show single note More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	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	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 = "pdnotes"

Protected Member Functions
	isRepositoryObject ()

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

	fillRowColor ($a_placeholder="CSS_ROW")

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

Protected Attributes
	$note_gui = null

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

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

Detailed Description

BlockGUI class for Personal Desktop Notes block.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

ilPDNotesBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDNotesBlockGUI::__construct ( )

Constructor.

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

References $DIC, ilBlockGUI\$lng, ilBlockGUI\setAvailableDetailLevels(), ilBlockGUI\setLimit(), ilBlockGUI\setTitle(), and user().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $lng = $DIC->language();
 
         parent::__construct();
         
         $this->setLimit(5);
         $this->setTitle($lng->txt("notes"));
         $this->setAvailableDetailLevels(3);
     }

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPDNotesBlockGUI::executeCommand ( )

execute command

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

References ilBlockGUI\$ctrl, and $ilCtrl.

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

◆ fillDataSection()

ilPDNotesBlockGUI::fillDataSection ( )

Fill data section.

Definition at line 96 of file class.ilPDNotesBlockGUI.php.

References $ilUser, ilBlockGUI\$user, ilNote\_getLastNotesOfUser(), ilBlockGUI\getCurrentDetailLevel(), getListRowData(), getOverview(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableDetailRow(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setRowTemplate().

     {
         $ilUser = $this->user;
         
         include_once("Services/Notes/classes/class.ilNote.php");
         $this->notes = ilNote::_getLastNotesOfUser();
 
         if ($this->getCurrentDetailLevel() > 1 && count($this->notes) > 0) {
             $this->setRowTemplate("tpl.pd_notes_overview.html", "Services/Notes");
             $this->getListRowData();
             //$this->setColSpan(2);
             parent::fillDataSection();
         } else {
             $this->setEnableNumInfo(false);
             if (count($this->notes) == 0) {
                 $this->setEnableDetailRow(false);
             }
             $this->setDataSection($this->getOverview());
         }
     }

Here is the call graph for this function:

◆ fillRow()

ilPDNotesBlockGUI::fillRow ( $a_set )

get flat bookmark list for personal desktop

Definition at line 184 of file class.ilPDNotesBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, ilBlockGUI\$user, ilDatePresentation\formatDate(), ilBlockGUI\getCurrentDetailLevel(), IL_CAL_DATETIME, and IL_NOTE_PRIVATE.

     {
         $ilUser = $this->user;
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         
         include_once("Services/Notes/classes/class.ilNoteGUI.php");
         if (!is_object($this->note_gui)) {
             $this->note_gui = new ilNoteGUI(0, 0, "");
             $this->note_gui->enableTargets();
         }
 
         $this->tpl->setVariable("VAL_SUBJECT", $a_set["subject"]);
 
         // link subject to show note function
         $ilCtrl->setParameter($this, "rel_obj", $a_set["rep_obj_id"]);
         $ilCtrl->setParameter($this, "note_id", $a_set["id"]);
         $ilCtrl->setParameter($this, "note_type", IL_NOTE_PRIVATE);
         $this->tpl->setVariable(
             "HREF_SHOW_NOTE",
             $ilCtrl->getLinkTarget($this, "showNote")
         );
         $this->tpl->setVariable("IMG_NOTE", $a_set["img"]);
         $this->tpl->setVariable("ALT_NOTE", $a_set["alt"]);
         $ilCtrl->clearParameters($this);
         
         // details
         if ($this->getCurrentDetailLevel() > 2) {
             $this->tpl->setCurrentBlock("details");
             if (substr($a_set["text"], 0, 40) != substr($a_set["text"], 0, 40)) {
                 $this->tpl->setVariable("NOTE_TEXT", $a_set["text"]);
             }
             $this->tpl->setVariable(
                 "VAL_DATE",
                 ilDatePresentation::formatDate(new ilDateTime($a_set["date"], IL_CAL_DATETIME))
             );
             $this->tpl->parseCurrentBlock();
                 
             // target objects
             $note = new ilNote($a_set["id"]);
             $this->tpl->setVariable(
                 "TARGET_OBJECTS",
                 $this->note_gui->renderTargets($note)
             );
 
             // edit button
             $this->tpl->setCurrentBlock("edit_note");
             $this->tpl->setVariable("TXT_EDIT_NOTE", $lng->txt("edit"));
             $ilCtrl->setParameterByClass("ilnotegui", "rel_obj", $a_set["rep_obj_id"]);
             $ilCtrl->setParameterByClass("ilnotegui", "note_id", $a_set["id"]);
             $ilCtrl->setParameterByClass("ilnotegui", "note_type", IL_NOTE_PRIVATE);
             $this->tpl->setVariable(
                 "LINK_EDIT_NOTE",
                 $ilCtrl->getLinkTargetByClass(array("ilpersonaldesktopgui", "ilpdnotesgui", "ilnotegui"), "editNoteForm")
                 . "#note_edit"
             );
             $this->tpl->parseCurrentBlock();
         }
         $ilCtrl->clearParametersByClass("ilnotegui");
     }

Here is the call graph for this function:

◆ getBlockType()

ilPDNotesBlockGUI::getBlockType ( )

Definition at line 42 of file class.ilPDNotesBlockGUI.php.

                                    : string
     {
         return self::$block_type;
     }

◆ getHTML()

ilPDNotesBlockGUI::getHTML ( )

Definition at line 84 of file class.ilPDNotesBlockGUI.php.

References ilBlockGUI\getCurrentDetailLevel().

     {
         if ($this->getCurrentDetailLevel() == 0) {
             return "";
         } else {
             return parent::getHTML();
         }
     }

Here is the call graph for this function:

◆ getListRowData()

ilPDNotesBlockGUI::getListRowData ( )

Get list data.

Definition at line 121 of file class.ilPDNotesBlockGUI.php.

References ilBlockGUI\$ctrl, ilBlockGUI\$data, $ilCtrl, $ilUser, $img, ilBlockGUI\$lng, $target, $title, ilBlockGUI\$user, ilUtil\getImagePath(), IL_NOTE_CONTRA, IL_NOTE_IMPORTANT, IL_NOTE_PRO, IL_NOTE_QUESTION, IL_NOTE_UNLABELED, ilBlockGUI\setData(), and ilUtil\shortenText().

Referenced by fillDataSection().

     {
         $ilUser = $this->user;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $data = array();
         
         foreach ($this->notes as $note) {
             switch ($note->getLabel()) {
                 case IL_NOTE_UNLABELED:
                     $img = ilUtil::getImagePath("note_unlabeled.svg");
                     $alt = $lng->txt("note");
                     break;
                     
                 case IL_NOTE_IMPORTANT:
                     $img = ilUtil::getImagePath("note_unlabeled.svg");
                     $alt = $lng->txt("note") . ", " . $lng->txt("important");
                     break;
                     
                 case IL_NOTE_QUESTION:
                     $img = ilUtil::getImagePath("note_unlabeled.svg");
                     $alt = $lng->txt("note") . ", " . $lng->txt("question");
                     break;
                     
                 case IL_NOTE_PRO:
                     $img = ilUtil::getImagePath("note_unlabeled.svg");
                     $alt = $lng->txt("note") . ", " . $lng->txt("pro");
                     break;
                     
                 case IL_NOTE_CONTRA:
                     $img = ilUtil::getImagePath("note_unlabeled.svg");
                     $alt = $lng->txt("note") . ", " . $lng->txt("contra");
                     break;
             }
 
             // details
             $target = $note->getObject();
             
             // new notes do not have subject anymore
             $title = $note->getSubject();
             if (!$title) {
                 $title = ilUtil::shortenText($note->getText(), 75, true, true);
             }
 
             $data[] = array(
                 "subject" => $title,
                 "img" => $img,
                 "alt" => $alt,
                 "text" => ilUtil::shortenText($note->getText(), 150, true, true),
                 "date" => $note->getCreationDate(),
                 "id" => $note->getId(),
                 "obj_type" => $target["obj_type"],
                 "obj_id" => $target["obj_id"],
                 "rep_obj_id" => $target["rep_obj_id"]);
         }
         
         $this->setData($data);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOverview()

ilPDNotesBlockGUI::getOverview ( )

Get overview.

Definition at line 248 of file class.ilPDNotesBlockGUI.php.

References ilBlockGUI\$ctrl, $ilCtrl, $ilUser, ilBlockGUI\$lng, and ilBlockGUI\$user.

Referenced by fillDataSection().

     {
         $ilUser = $this->user;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
                 
         return '<div class="small">' . ((int) count($this->notes)) . " " . $lng->txt("notes") . "</div>";
     }

Here is the caller graph for this function:

◆ getScreenMode()

static ilPDNotesBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Definition at line 58 of file class.ilPDNotesBlockGUI.php.

References $_GET, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

     {
         switch ($_GET["cmd"]) {
             case "showNote":
                 return IL_SCREEN_CENTER;
                 break;
                 
             default:
                 return IL_SCREEN_SIDE;
                 break;
         }
     }

◆ isRepositoryObject()

ilPDNotesBlockGUI::isRepositoryObject ( )

protected

Definition at line 50 of file class.ilPDNotesBlockGUI.php.

                                             : bool
     {
         return false;
     }

◆ showNote()

ilPDNotesBlockGUI::showNote ( )

show single note

Definition at line 260 of file class.ilPDNotesBlockGUI.php.

References $_GET, ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, and $note_gui.

     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
         
         include_once("./Services/Notes/classes/class.ilNoteGUI.php");
         $note_gui = new ilNoteGUI();
         $note_gui->enableTargets();
         include_once("./Services/PersonalDesktop/classes/class.ilPDContentBlockGUI.php");
         $content_block = new ilPDContentBlockGUI();
         $content_block->setContent($note_gui->getPDNoteHTML($_GET["note_id"]));
         $content_block->setTitle($lng->txt("note"));
         $content_block->setColSpan(2);
         $content_block->addHeaderCommand(
             $ilCtrl->getLinkTargetByClass("ilpersonaldesktopgui", "show"),
             $lng->txt("selected_items_back")
         );
         
         return $content_block->getHTML();
     }

Field Documentation

◆ $block_type

ilPDNotesBlockGUI::$block_type = "pdnotes"

static

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

◆ $note_gui

ilPDNotesBlockGUI::$note_gui = null

protected

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

Referenced by showNote().

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

Services/Notes/classes/class.ilPDNotesBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ fillDataSection()

◆ fillRow()

◆ getBlockType()

◆ getHTML()

◆ getListRowData()

◆ getOverview()

◆ getScreenMode()

◆ isRepositoryObject()

◆ showNote()

Field Documentation

◆ $block_type

◆ $note_gui