BlockGUI class for Tasks on PD. More...

Inheritance diagram for ilPDTasksBlockGUI:

Collaboration diagram for ilPDTasksBlockGUI:

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

	getBlockType ()
	Returns string More...

	executeCommand ()
	execute command More...

	fillDataSection ()
	Fill data section. More...

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

	getOverview ()
	Get overview. More...

	getHTMLNew ()
	Get HTML. More...

Public Member Functions inherited from ilBlockGUI
	getBlockType ()

	__construct ()
	Constructor. More...

	setData ($a_data)
	Set Data. More...

	getData ()
	Get Data. More...

	setPresentation (int $type)
	Set presentation. More...

	getPresentation ()
	Get presentation type. More...

	setBlockId ($a_block_id=0)
	Set Block Id. More...

	getBlockId ()
	Get Block Id. More...

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

	getGuiObject ()
	Get GuiObject. More...

	setTitle ($a_title)
	Set Title. More...

	getTitle ()
	Get Title. 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...

	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 (bool $a_admincommands)
	Set Administration Commmands. More...

	getAdminCommands ()
	Get Administration Commmands. 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 ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()
	Get Row Template Name. More...

	getRowTemplateDir ()
	Get Row Template Directory. More...

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")
	Add Block Command. More...

	getBlockCommands ()
	Get Block commands. More...

	getHTML ()
	Get HTML. 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...

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

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

	getHTMLNew ()
	Get HTML. 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 = "pdtasks"

Protected Member Functions

isRepositoryObject ()

Returns whether block has a corresponding repository object.

Returns: bool

More...

getListItemForData (array $data)

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

More...

getNoItemFoundContent ()

No item entry. More...

Protected Member Functions inherited from ilBlockGUI

isRepositoryObject ()

Returns whether block has a corresponding repository object. More...

initCommands ()

Init commands. More...

fillRowColor ($a_placeholder="CSS_ROW")

preloadData (array $data)

Can be overwritten in subclasses. More...

getLegacyContent ()

Get legacy content. More...

getViewControls ()

Get view controls. 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...

getNoItemFoundContent ()

No item entry. More...

Protected Attributes
	$tasks = []

	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
	$ui

	$data = array()

	$enablenuminfo = true

	$footer_links = array()

	$block_id = 0

	$allow_moving = true

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

	$block_commands = array()

	$max_count = false

	$close_command = false

	$image = false

	$property = false

	$nav_value = ""

	$css_row = ""

	$title = ""

	$admincommands = false

	$dropdown

	$tpl

	$main_tpl

	$user

	$ctrl

	$access

	$lng

	$obj_def

	$presentation

	$new_rendering = false

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

Detailed Description

BlockGUI class for Tasks on PD.

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

@ilCtrl_IsCalledBy ilPDTasksBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDTasksBlockGUI::__construct ( )

Constructor.

Reimplemented from ilBlockGUI.

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

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $lng = $DIC->language();
 
        parent::__construct();
 
        $this->setLimit(5);
        $lng->loadLanguageModule("task");
        $this->setTitle($lng->txt("task_derived_tasks"));
 
        $this->setPresentation(self::PRES_SEC_LIST);
    }

References $DIC, ilBlockGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setTitle(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPDTasksBlockGUI::executeCommand ( )

execute command

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

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

References ilBlockGUI\$ctrl.

◆ fillDataSection()

ilPDTasksBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

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

    {
        global $DIC;
        $collector = $DIC->task()->derived()->factory()->collector();
 
        $this->tasks = $collector->getEntries($this->user->getId());
 
        if (count($this->tasks) > 0) {
            $this->setRowTemplate("tpl.pd_tasks.html", "Services/Tasks");
            $this->getListRowData();
            parent::fillDataSection();
        } else {
            $this->setEnableNumInfo(false);
            $this->setDataSection($this->getOverview());
        }
    }

References $DIC, getOverview(), ilBlockGUI\setDataSection(), ilBlockGUI\setEnableNumInfo(), ilBlockGUI\setRowTemplate(), and user().

Here is the call graph for this function:

◆ fillRow()

ilPDTasksBlockGUI::fillRow ( $a_set )

get flat list for personal desktop

Reimplemented from ilBlockGUI.

Definition at line 127 of file class.ilPDTasksBlockGUI.php.

    {
        global $DIC;
 
        $factory = $DIC->ui()->factory();
        $renderer = $DIC->ui()->renderer();
        $lng = $this->lng;
 
        $info_screen = new ilInfoScreenGUI($this);
        $info_screen->setFormAction("#");
        $info_screen->addSection($lng->txt(""));
        //$toolbar = new ilToolbarGUI();
 
        $info_screen->addProperty(
            $lng->txt("task_task"),
            $a_set["title"]
        );
 
        if ($a_set["ref_id"] > 0) {
            $obj_id = ilObject::_lookupObjId($a_set["ref_id"]);
            $obj_type = ilObject::_lookupType($obj_id);
            
            if (0 === $a_set['url']) {
                $url = ilLink::_getStaticLink($a_set["ref_id"]);
            } else {
                $url = $a_set['url'];
            }
            $link = $factory->button()->shy(ilObject::_lookupTitle($obj_id), $url);
 
            $info_screen->addProperty(
                $lng->txt("obj_" . $obj_type),
                $renderer->render($link)
            );
        }
 
        if ($a_set["wsp_id"] > 0) {
            $wst = new ilWorkspaceTree($this->user->getId());
            $obj_id = $wst->lookupObjectId($a_set["wsp_id"]);
            $obj_type = ilObject::_lookupType($obj_id);
 
            if (0 === $a_set['url']) {
                $url = ilLink::_getStaticLink($a_set["wsp_id"]);
            } else {
                $url = $a_set['url'];
            }
            $link = $factory->button()->shy(ilObject::_lookupTitle($obj_id), $url);
 
            $info_screen->addProperty(
                $lng->txt("obj_" . $obj_type),
                $renderer->render($link)
            );
        }
 
        if ($a_set["starting_time"] > 0) {
            $start = new ilDateTime($a_set["starting_time"], IL_CAL_UNIX);
            $info_screen->addProperty(
                $lng->txt("task_start"),
                ilDatePresentation::formatDate($start)
            );
        }
 
        if ($a_set["deadline"] > 0) {
            $end = new ilDateTime($a_set["deadline"], IL_CAL_UNIX);
            $info_screen->addProperty(
                $lng->txt("task_deadline"),
                ilDatePresentation::formatDate($end)
            );
        }
 
        $modal = $factory->modal()->roundtrip(
            $lng->txt("task_details"),
            $factory->legacy($info_screen->getHTML())
        )
            ->withCancelButtonLabel("close");
        $button1 = $factory->button()->shy($a_set["title"], '#')
            ->withOnClick($modal->getShowSignal());
 
        $this->tpl->setVariable("TITLE", $renderer->render([$button1, $modal]));
    }

References $DIC, $factory, ilBlockGUI\$lng, $url, ilLink\_getStaticLink(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilDatePresentation\formatDate(), IL_CAL_UNIX, and user().

Here is the call graph for this function:

◆ getBlockType()

ilPDTasksBlockGUI::getBlockType ( )

Returns: string

Reimplemented from ilBlockGUI.

Definition at line 44 of file class.ilPDTasksBlockGUI.php.

                                   : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getHTMLNew()

ilPDTasksBlockGUI::getHTMLNew ( )

Get HTML.

Reimplemented from ilBlockGUI.

Definition at line 226 of file class.ilPDTasksBlockGUI.php.

                                 : string
    {
        global $DIC;
        $collector = $DIC->task()->derived()->factory()->collector();
 
        $this->tasks = $collector->getEntries($this->user->getId());
 
        $this->getListRowData();
 
        return parent::getHTMLNew();
    }

References $DIC, and user().

Here is the call graph for this function:

◆ getListItemForData()

ilPDTasksBlockGUI::getListItemForData ( array $data )

protected

Get list item for data array.

Parameters

array $data

Returns: null|\ILIAS\UI\Component\Item\Item

Reimplemented from ilBlockGUI.

Definition at line 241 of file class.ilPDTasksBlockGUI.php.

                                                       : \ILIAS\UI\Component\Item\Item
    {
        $factory = $this->ui->factory();
        $lng = $this->lng;
 
        $title = $data["title"];
        $props = [];
 
        if ($data["ref_id"] > 0) {
            $obj_id = ilObject::_lookupObjId($data["ref_id"]);
            $obj_type = ilObject::_lookupType($obj_id);
            if ($data['url'] == "") {
                $url = ilLink::_getStaticLink($data["ref_id"]);
            } else {
                $url = $data['url'];
            }
            $link = $url;
            $title = $factory->link()->standard($data["title"], $link);
            $props[$lng->txt("obj_" . $obj_type)] = ilObject::_lookupTitle($obj_id);
        }
 
        if ($data["wsp_id"] > 0) {
            $wst = new ilWorkspaceTree($this->user->getId());
            $obj_id = $wst->lookupObjectId($data["wsp_id"]);
            $obj_type = ilObject::_lookupType($obj_id);
            if ($data['url'] == "") {
                $url = ilLink::_getStaticLink($data["wsp_id"]);
            } else {
                $url = $data['url'];
            }
            $link = $url;
            $title = $factory->link()->standard($data["title"], $link);
            $props[$lng->txt("obj_" . $obj_type)] = ilObject::_lookupTitle($obj_id);
        }
 
        if ($data["starting_time"] > 0) {
            $start = new ilDateTime($data["starting_time"], IL_CAL_UNIX);
            $props[$lng->txt("task_start")] = ilDatePresentation::formatDate($start);
        }
 
        $factory = $this->ui->factory();
        $item = $factory->item()->standard($title)
                        ->withProperties($props);
 
        if ($data["deadline"] > 0) {
            $end = new ilDateTime($data["deadline"], IL_CAL_UNIX);
            //$props[$lng->txt("task_deadline")] =
            //    ilDatePresentation::formatDate($end);
            $item = $item->withDescription(ilDatePresentation::formatDate($end));
        }
 
 
        return $item;
    }

References ilBlockGUI\$data, $factory, ilBlockGUI\$lng, ilBlockGUI\$title, $url, ilLink\_getStaticLink(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilDatePresentation\formatDate(), IL_CAL_UNIX, ui(), and user().

Here is the call graph for this function:

◆ getNoItemFoundContent()

ilPDTasksBlockGUI::getNoItemFoundContent ( )

protected

No item entry.

Returns: string

Reimplemented from ilBlockGUI.

Definition at line 301 of file class.ilPDTasksBlockGUI.php.

                                               : string
    {
        return $this->lng->txt("task_no_task_items");
    }

◆ getOverview()

ilPDTasksBlockGUI::getOverview ( )

Get overview.

Definition at line 210 of file class.ilPDTasksBlockGUI.php.

    {
        $lng = $this->lng;
 
        return '<div class="small">' . ((int) count($this->tasks)) . " " . $lng->txt("task_derived_tasks") . "</div>";
    }

References ilBlockGUI\$lng.

Referenced by fillDataSection().

Here is the caller graph for this function:

◆ getScreenMode()

static ilPDTasksBlockGUI::getScreenMode ( )

static

Get Screen Mode for current command.

Reimplemented from ilBlockGUI.

Definition at line 60 of file class.ilPDTasksBlockGUI.php.

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

References $_GET, and IL_SCREEN_SIDE.

◆ isRepositoryObject()

ilPDTasksBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Returns: bool

Reimplemented from ilBlockGUI.

Definition at line 52 of file class.ilPDTasksBlockGUI.php.

                                            : bool
    {
        return false;
    }

Field Documentation

◆ $block_type

ilPDTasksBlockGUI::$block_type = "pdtasks"

static

Definition at line 16 of file class.ilPDTasksBlockGUI.php.

Referenced by getBlockType().

◆ $new_rendering

ilPDTasksBlockGUI::$new_rendering = true

protected

Definition at line 221 of file class.ilPDTasksBlockGUI.php.

◆ $tasks

ilPDTasksBlockGUI::$tasks = []

protected

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

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

Services/Tasks/classes/class.ilPDTasksBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ fillDataSection()

◆ fillRow()

◆ getBlockType()

◆ getHTMLNew()

◆ getListItemForData()

◆ getNoItemFoundContent()

◆ getOverview()

◆ getScreenMode()

◆ isRepositoryObject()

Field Documentation

◆ $block_type

◆ $new_rendering

◆ $tasks