Portfolio block for PD. More...

Inheritance diagram for ilPDPortfolioBlockGUI:

Collaboration diagram for ilPDPortfolioBlockGUI:

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

	getBlockType ()
	Returns string More...

	executeCommand ()
	Execute command. More...

	getHTML ()
	Execute command. More...

	fillDataSection ()
	Fill data section. More...

	fillRow ($p)
	get flat bookmark list for personal desktop 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	getScreenMode ()
	Get Screen Mode for current command. More...

Static Public Attributes
static	$block_type = 'pdportf'

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

	getOverview ()
	Get overview. More...

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
	$settings

	$default_portfolio = 0

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

Portfolio block for PD.

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

Version: $Id$ @ilCtrl_IsCalledBy ilPDPortfolioBlockGUI: ilColumnGUI

Definition at line 14 of file class.ilPDPortfolioBlockGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPDPortfolioBlockGUI::__construct ( )

Constructor.

Reimplemented from ilBlockGUI.

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

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->settings = $DIC->settings();
        $this->user = $DIC->user();
 
        parent::__construct();
 
        $this->setLimit(5);
        $this->setAvailableDetailLevels(2);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPDPortfolioBlockGUI::executeCommand ( )

Execute command.

Definition at line 77 of file class.ilPDPortfolioBlockGUI.php.

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

References ilBlockGUI\$ctrl, and $ilCtrl.

◆ fillDataSection()

ilPDPortfolioBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

Definition at line 125 of file class.ilPDPortfolioBlockGUI.php.

    {
        $ilUser = $this->user;
 
        include_once "Modules/Portfolio/classes/class.ilObjPortfolio.php";
        $data = ilObjPortfolio::getPortfoliosOfUser($ilUser->getId());
        $this->setData($data);
 
        if ($this->getCurrentDetailLevel() > 1 && count($this->getData()) > 0) {
            $this->setRowTemplate("tpl.pd_portf_block_row.html", "Modules/Portfolio");
            if ($this->getCurrentDetailLevel() > 2) {
                $this->setColSpan(2);
            }
            parent::fillDataSection();
        } else {
            $this->setEnableNumInfo(false);
            if (count($this->getData()) == 0) {
                $this->setEnableDetailRow(false);
            }
            $this->setDataSection($this->getOverview());
        }
    }

References ilBlockGUI\$data, $ilUser, ilBlockGUI\$user, ilBlockGUI\getCurrentDetailLevel(), ilBlockGUI\getData(), getOverview(), ilObjPortfolio\getPortfoliosOfUser(), ilBlockGUI\setColSpan(), ilBlockGUI\setData(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableDetailRow(), ilBlockGUI\setEnableNumInfo(), and ilBlockGUI\setRowTemplate().

Here is the call graph for this function:

◆ fillRow()

ilPDPortfolioBlockGUI::fillRow ( $p )

get flat bookmark list for personal desktop

Reimplemented from ilBlockGUI.

Definition at line 151 of file class.ilPDPortfolioBlockGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        if ($this->getCurrentDetailLevel() > 1) {
            $ilCtrl->setParameterByClass("ilobjportfoliogui", "prt_id", $p["id"]);
            $this->tpl->setVariable("HREF", $ilCtrl->getLinkTargetByClass(array("ilpersonaldesktopgui", "ilportfoliorepositorygui", "ilobjportfoliogui"), "preview"));
            $this->tpl->setVariable("TITLE", trim($p["title"]));
            
            if ($this->default_portfolio == $p["id"]) {
                // #16490
                $this->tpl->setVariable("DESC", $lng->txt("prtf_default_portfolio"));
            }
            
            $ilCtrl->setParameterByClass("ilobjportfoliogui", "prt_id", "");
        }
    }

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, and ilBlockGUI\getCurrentDetailLevel().

Here is the call graph for this function:

◆ getBlockType()

ilPDPortfolioBlockGUI::getBlockType ( )

Returns: string

Reimplemented from ilBlockGUI.

Definition at line 45 of file class.ilPDPortfolioBlockGUI.php.

                                   : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getHTML()

ilPDPortfolioBlockGUI::getHTML ( )

Execute command.

Reimplemented from ilBlockGUI.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilSetting = $this->settings;
        $ilUser = $this->user;
 
        if (!$ilSetting->get('user_portfolios')) {
            return '';
        }
 
        if ($this->getCurrentDetailLevel() == 0) {
            return '';
        } else {
            include_once("./Modules/Portfolio/classes/class.ilObjPortfolio.php");
            $this->default_portfolio = ilObjPortfolio::getDefaultPortfolio($ilUser->getId());
 
            $lng->loadLanguageModule("prtf");
            $this->setTitle($lng->txt('prtf_tab_portfolios'));
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass(array("ilpersonaldesktopgui", "ilportfoliorepositorygui"), ""),
                $lng->txt("prtf_manage_portfolios")
            );
            $this->addBlockCommand(
                $ilCtrl->getLinkTargetByClass(array("ilpersonaldesktopgui", "ilportfoliorepositorygui", "ilobjportfoliogui"), "create"),
                $lng->txt("prtf_add_portfolio")
            );
 
            $html = parent::getHTML();
            return $html;
        }
    }

References ilBlockGUI\$ctrl, $html, $ilCtrl, $ilSetting, $ilUser, ilBlockGUI\$lng, $settings, ilBlockGUI\$user, ilBlockGUI\addBlockCommand(), ilBlockGUI\getCurrentDetailLevel(), ilObjPortfolio\getDefaultPortfolio(), and ilBlockGUI\setTitle().

Here is the call graph for this function:

◆ getOverview()

ilPDPortfolioBlockGUI::getOverview ( )

protected

Get overview.

Definition at line 173 of file class.ilPDPortfolioBlockGUI.php.

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        if (count($this->getData()) == 0) {
            // ilias.php?cmd=create&cmdClass=ilobjportfoliogui&cmdNode=5f:o8:oh&baseClass=ilPersonalDesktopGUI
            return '<div class="small"><a href="' .
                $ilCtrl->getLinkTargetByClass(array("ilpersonaldesktopgui", "ilportfoliorepositorygui", "ilobjportfoliogui"), "create") .
                '">' . $lng->txt("prtf_add_portfolio") . '</a></div>';
        } else {
            $t = (count($this->getData()) == 1)
                ? $lng->txt("obj_prtf")
                : $lng->txt("prtf_portfolios");
            return '<div class="small"><a href="' .
                $ilCtrl->getLinkTargetByClass(array("ilpersonaldesktopgui", "ilportfoliorepositorygui"), "") .
                '">' . ((int) count($this->getData())) . " " . $t . "</a></div>";
        }
    }

References ilBlockGUI\$ctrl, $ilCtrl, ilBlockGUI\$lng, $t, and ilBlockGUI\getData().

Referenced by fillDataSection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getScreenMode()

static ilPDPortfolioBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

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

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

References $_GET, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

◆ isRepositoryObject()

ilPDPortfolioBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Returns: bool

Reimplemented from ilBlockGUI.

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

                                            : bool
    {
        return false;
    }

Field Documentation

◆ $block_type

ilPDPortfolioBlockGUI::$block_type = 'pdportf'

static

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

Referenced by getBlockType().

◆ $default_portfolio

ilPDPortfolioBlockGUI::$default_portfolio = 0

protected

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

◆ $settings

ilPDPortfolioBlockGUI::$settings

protected

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

Referenced by getHTML().

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

Modules/Portfolio/classes/class.ilPDPortfolioBlockGUI.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()

◆ getOverview()

◆ getScreenMode()

◆ isRepositoryObject()

Field Documentation

◆ $block_type

◆ $default_portfolio

◆ $settings