BlockGUI class for Tasks on PD. More...

Inheritance diagram for ilPDTasksBlockGUI:

Collaboration diagram for ilPDTasksBlockGUI:

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

	getBlockType ()

	executeCommand ()
	execute command More...

	fillDataSection ()
	Fill data section. More...

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

	getOverview ()
	Get overview. More...

	getHTMLNew ()

	getNoItemFoundContent ()
	No item entry. More...

Public Member Functions inherited from ilBlockGUI
	__construct ()

	getBlockType ()

	setData (array $a_data)

	getData ()

	setPresentation (int $type)

	getPresentation ()

	setBlockId (string $a_block_id="0")

	getBlockId ()

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

	getGuiObject ()

	setTitle (string $a_title)

	getTitle ()

	setOffset (int $a_offset)

	getOffset ()

	correctOffset ()

	setLimit (int $a_limit)

	getLimit ()

	setEnableEdit (bool $a_enableedit)

	getEnableEdit ()

	setRepositoryMode (bool $a_repositorymode)

	getRepositoryMode ()

	setSubtitle (string $a_subtitle)

	getSubtitle ()

	setRefId (int $a_refid)
	Set Ref Id (only used if isRepositoryObject() is true). More...

	getRefId ()

	setAdminCommands (bool $a_admincommands)

	getAdminCommands ()

	setEnableNumInfo (bool $a_enablenuminfo)

	getEnableNumInfo ()

	setProperties (array $a_properties)
	This function is supposed to be used for block type specific properties, that should be inherited through ilColumnGUI->setBlockProperties. More...

	getProperty (string $a_property)

	setProperty (string $a_property, string $a_value)

	setRowTemplate (string $a_rowtemplatename, string $a_rowtemplatedir="")
	Set Row Template Name. More...

	getNavParameter ()

	getConfigParameter ()

	getMoveParameter ()

	getRowTemplateName ()

	getRowTemplateDir ()

	addBlockCommand (string $a_href, string $a_text, string $a_onclick="")

	getBlockCommands ()

	getHTML ()

	fillHeaderCommands ()

	fillHeaderTitleBlock ()

	setDataSection (string $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 (array $a_set)

	fillFooter ()

	fillPreviousNext ()

	setPreviousNextLinks ()

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

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

	getHTMLNew ()

	getNoItemFoundContent ()

Static Public Member Functions
static	getScreenMode ()
	Get Screen Mode for current command. More...

static	getScreenMode ()

Static Public Attributes
static string	$block_type = "pdtasks"

Protected Member Functions

isRepositoryObject ()

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

getListItemForData (array $data)

Get list item for data array.

Parameters

array $data

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

More...

Protected Member Functions inherited from ilBlockGUI

isRepositoryObject ()

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

specialCharsAsEntities (string $string)

initCommands ()

fillRowColor (string $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...

send (string $output)

Send. More...

Protected Attributes
array	$tasks = []

bool	$new_rendering = true

Protected Attributes inherited from ilBlockGUI
object	$gui_object

ILIAS Block StandardGUIRequest	$request

ILIAS Block BlockManager	$block_manager

bool	$repositorymode = false

ILIAS DI UIServices	$ui

array	$data = array()

bool	$enablenuminfo = true

array	$footer_links = array()

string	$block_id = "0"

bool	$allow_moving = true

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

array	$block_commands = array()

int	$max_count = 0

bool	$close_command = false

bool	$image = false

array	$property = []

string	$nav_value = ""

string	$css_row = ""

string	$title = ""

bool	$admincommands = false

array	$dropdown

ilTemplate	$tpl

ilGlobalTemplateInterface	$main_tpl

ilObjUser	$user

ilCtrl	$ctrl

ilAccessHandler	$access

ilLanguage	$lng

ilObjectDefinition	$obj_def

int	$presentation

int	$requested_ref_id

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

const	PRES_MAIN_TILE = 4

Detailed Description

BlockGUI class for Tasks on PD.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

@ilCtrl_IsCalledBy ilPDTasksBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDTasksBlockGUI::__construct ( )

Constructor.

Reimplemented from ilBlockGUI.

Definition at line 37 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(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setTitle(), ilLanguage\txt(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPDTasksBlockGUI::executeCommand ( )

execute command

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

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

References ilBlockGUI\$ctrl, and ilCtrl\getCmd().

Here is the call graph for this function:

◆ fillDataSection()

ilPDTasksBlockGUI::fillDataSection ( )

Fill data section.

Reimplemented from ilBlockGUI.

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

                                     : void
    {
        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 ILIAS\Repository\user().

Here is the call graph for this function:

◆ fillRow()

ilPDTasksBlockGUI::fillRow ( array $a_set )

get flat list for personal desktop

Reimplemented from ilBlockGUI.

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

                                         : void
    {
        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);
 
            $url = 0 === $a_set['url'] ? ilLink::_getStaticLink($a_set["ref_id"]) : $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);
 
            $url = 0 === $a_set['url'] ? ilLink::_getStaticLink($a_set["wsp_id"]) : $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, ilLanguage\txt(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getBlockType()

ilPDTasksBlockGUI::getBlockType ( )

Reimplemented from ilBlockGUI.

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

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getHTMLNew()

ilPDTasksBlockGUI::getHTMLNew ( )

Reimplemented from ilBlockGUI.

Definition at line 228 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 ILIAS\Repository\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 243 of file class.ilPDTasksBlockGUI.php.

                                                      : ?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);
            $url = $data['url'] == "" ? ilLink::_getStaticLink($data["ref_id"]) : $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);
            $url = $data['url'] == "" ? ilLink::_getStaticLink($data["wsp_id"]) : $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, ilLanguage\txt(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ getNoItemFoundContent()

ilPDTasksBlockGUI::getNoItemFoundContent ( )

No item entry.

Reimplemented from ilBlockGUI.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getOverview()

ilPDTasksBlockGUI::getOverview ( )

Get overview.

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

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

References ilBlockGUI\$lng, and ilLanguage\txt().

Referenced by fillDataSection().

Here is the call graph for this function:

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 74 of file class.ilPDTasksBlockGUI.php.

                                          : string
    {
        return IL_SCREEN_SIDE;
    }

References IL_SCREEN_SIDE.

◆ isRepositoryObject()

ilPDTasksBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

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

                                           : bool
    {
        return false;
    }

Field Documentation

◆ $block_type

string ilPDTasksBlockGUI::$block_type = "pdtasks"

static

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

Referenced by getBlockType().

◆ $new_rendering

bool ilPDTasksBlockGUI::$new_rendering = true

protected

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

◆ $tasks

array ilPDTasksBlockGUI::$tasks = []

protected

Definition at line 32 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