@ilCtrl_IsCalledBy ilPDMailBlockGUI: ilColumnGUI More...

Inheritance diagram for ilPDMailBlockGUI:

Collaboration diagram for ilPDMailBlockGUI:

Public Member Functions
	__construct ()

	getBlockType ()

	executeCommand ()

	getHTML ()

	getNoItemFoundContent ()

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

	checkOffset (int $offset)

	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="", ?RoundTrip $modal=null)

	getBlockCommands ()

	getHTML ()

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

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

	getViewControlsForPanel ()

	sortObject ()

	addSortOption (string $option, string $label, bool $active)

	setSortTarget (string $target)

	addPresentation (string $label, string $target, bool $active)

	getNoItemFoundContent ()

Static Public Member Functions
static	getScreenMode ()

static	getScreenMode ()

Static Public Attributes
static string	$block_type = 'pdmail'

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

	getMails ()

	getOverview ()

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

	getListItemForData (array $data)
	Get list item for data array. More...

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

	specialCharsAsEntities (string $string)

	initCommands ()

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

	getLegacyContent ()
	Get legacy content. 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...

	getActionsForPanel ()

	send (string $output)
	Send. More...

Protected Attributes
ilRbacSystem	$rbacsystem

ilSetting	$setting

array	$mails = []

int	$inbox

Protected Attributes inherited from ilBlockGUI
ILIAS UI Renderer	$renderer

Factory	$factory

object	$gui_object

ILIAS Container Block StandardGUIRequest	$request

ILIAS Container 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

Private Attributes
readonly GlobalHttpState	$http

readonly Refinery	$refinery

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

@ilCtrl_IsCalledBy ilPDMailBlockGUI: ilColumnGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilPDMailBlockGUI::__construct ( )

Reimplemented from ilBlockGUI.

Definition at line 41 of file class.ilPDMailBlockGUI.php.

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->setting = $DIC->settings();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
 
        parent::__construct();
 
        $this->setLimit(5);
        $this->setTitle($this->lng->txt('mail'));
        $this->setPresentation(self::PRES_SEC_LIST);
 
        $umail = new ilMail($this->user->getId());
        if ($this->rbacsystem->checkAccess('internal_mail', $umail->getMailObjectReferenceId())) {
            $this->has_access = true;
            $this->getMails();
            $this->setData($this->mails);
        }
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), getMails(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilBlockGUI\setData(), ilBlockGUI\setLimit(), ilBlockGUI\setPresentation(), ilBlockGUI\setTitle(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ executeCommand()

ilPDMailBlockGUI::executeCommand ( )

Definition at line 90 of file class.ilPDMailBlockGUI.php.

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

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getBlockType()

ilPDMailBlockGUI::getBlockType ( )

Reimplemented from ilBlockGUI.

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

                                  : string
    {
        return self::$block_type;
    }

References $block_type.

◆ getHTML()

ilPDMailBlockGUI::getHTML ( )

Reimplemented from ilBlockGUI.

Definition at line 97 of file class.ilPDMailBlockGUI.php.

                             : string
    {
        if (!$this->has_access) {
            return '';
        }
        return parent::getHTML();
    }

◆ getListItemForData()

ilPDMailBlockGUI::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 138 of file class.ilPDMailBlockGUI.php.

                                                      : ?Item
    {
        $f = $this->ui->factory();
 
        $user = ilMailUserCache::getUserObjectById($data['sender_id']);
 
        $avatar = null;
        if ($user && $user->getId() !== ANONYMOUS_USER_ID) {
            $avatar = $user->getAvatar();
            $public_name_long = $user->getPublicName();
        } elseif ($user) {
            $avatar = $this->ui->factory()
                ->symbol()
                ->avatar()
                ->picture(ilUtil::getImagePath('logo/ilias_logo_centered.png'), ilMail::_getIliasMailerName());
            $public_name_long = ilMail::_getIliasMailerName();
        } else {
            $public_name_long = trim(($data['import_name'] ?? '') . ' (' . $this->lng->txt('user_deleted') . ')');
        }
 
        $new_mail_subj = htmlentities($data['m_subject'], ENT_NOQUOTES, 'UTF-8');
        $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mobj_id', $this->inbox);
        $this->ctrl->setParameterByClass(ilMailFolderGUI::class, 'mail_id', $data['mail_id']);
        $new_mail_link = $this->ctrl->getLinkTargetByClass([ilMailGUI::class, ilMailFolderGUI::class], 'showMail');
        $this->ctrl->clearParametersByClass(ilMailFolderGUI::class);
 
        $button = $f->link()->standard($new_mail_subj, $new_mail_link);
 
        $item = $f->item()->standard($button);
        if ($avatar !== null) {
            $item = $item->withLeadAvatar($avatar);
        }
 
        $item = $item->withProperties([
            $this->lng->txt('from') => $public_name_long,
            $this->lng->txt('mail_sent_datetime') => ilDatePresentation::formatDate(new ilDateTime($data['send_time'], IL_CAL_DATETIME)),
        ]);
 
        return $item;
    }

References ilBlockGUI\$data, Vendor\Package\$f, ilBlockGUI\$user, ilMail\_getIliasMailerName(), ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilObjUser\getAvatar(), ilObject\getId(), ilUtil\getImagePath(), ilObjUser\getPublicName(), ilMailUserCache\getUserObjectById(), IL_CAL_DATETIME, ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ getMails()

ilPDMailBlockGUI::getMails ( )

protected

Definition at line 105 of file class.ilPDMailBlockGUI.php.

                                 : void
    {
        $umail = new ilMail($this->user->getId());
        $mbox = new ilMailbox($this->user->getId());
        $this->inbox = $mbox->getInboxFolder();
 
        $this->mails = $umail->getMailsOfFolder(
            $this->inbox,
            [
                 'status' => 'unread',
            ]
        );
        $this->max_count = count($this->mails);
    }

References ILIAS\Repository\user().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNoItemFoundContent()

ilPDMailBlockGUI::getNoItemFoundContent ( )

Reimplemented from ilBlockGUI.

Definition at line 179 of file class.ilPDMailBlockGUI.php.

                                           : string
    {
        return $this->lng->txt('mail_no_mail_items');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getOverview()

ilPDMailBlockGUI::getOverview ( )

protected

Definition at line 120 of file class.ilPDMailBlockGUI.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getScreenMode()

static ilPDMailBlockGUI::getScreenMode ( )

static

Reimplemented from ilBlockGUI.

Definition at line 76 of file class.ilPDMailBlockGUI.php.

                                          : string
    {
        global $DIC;
        $cmd = '';
        if ($DIC->http()->wrapper()->query()->has('cmd')) {
            $cmd = $DIC->http()->wrapper()->query()->retrieve('cmd', $DIC->refinery()->kindlyTo()->string());
        }
        if ($cmd === 'showMail') {
            return IL_SCREEN_CENTER;
        }
 
        return IL_SCREEN_SIDE;
    }

References $DIC, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

◆ isRepositoryObject()

ilPDMailBlockGUI::isRepositoryObject ( )

protected

Returns whether block has a corresponding repository object.

Reimplemented from ilBlockGUI.

Definition at line 71 of file class.ilPDMailBlockGUI.php.

                                           : bool
    {
        return false;
    }

◆ preloadData()

ilPDMailBlockGUI::preloadData ( array $data )

protected

Can be overwritten in subclasses.

Only the visible part of the complete data was passed so a preload of the visible data is possible.

Parameters

array $data

Reimplemented from ilBlockGUI.

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

                                               : void
    {
        $usr_ids = [];
 
        foreach ($data as $mail) {
            if ($mail['sender_id'] && $mail['sender_id'] !== ANONYMOUS_USER_ID) {
                $usr_ids[$mail['sender_id']] = $mail['sender_id'];
            }
        }
 
        ilMailUserCache::preloadUserObjects($usr_ids);
    }

References ilBlockGUI\$data, ANONYMOUS_USER_ID, and ilMailUserCache\preloadUserObjects().

Here is the call graph for this function:

Field Documentation

◆ $block_type

string ilPDMailBlockGUI::$block_type = 'pdmail'

static

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

Referenced by getBlockType().

◆ $has_access

bool ilPDMailBlockGUI::$has_access = false

private

Definition at line 39 of file class.ilPDMailBlockGUI.php.

◆ $http

readonly GlobalHttpState ilPDMailBlockGUI::$http

private

Definition at line 32 of file class.ilPDMailBlockGUI.php.

◆ $inbox

int ilPDMailBlockGUI::$inbox

protected

Definition at line 38 of file class.ilPDMailBlockGUI.php.

◆ $mails

array ilPDMailBlockGUI::$mails = []

protected

Definition at line 37 of file class.ilPDMailBlockGUI.php.

◆ $rbacsystem

ilRbacSystem ilPDMailBlockGUI::$rbacsystem

protected

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

◆ $refinery

readonly Refinery ilPDMailBlockGUI::$refinery

private

Definition at line 33 of file class.ilPDMailBlockGUI.php.

◆ $setting

ilSetting ilPDMailBlockGUI::$setting

protected

Definition at line 35 of file class.ilPDMailBlockGUI.php.

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

components/ILIAS/Mail/classes/class.ilPDMailBlockGUI.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ executeCommand()

◆ getBlockType()

◆ getHTML()

◆ getListItemForData()

◆ getMails()

◆ getNoItemFoundContent()

◆ getOverview()

◆ getScreenMode()

◆ isRepositoryObject()

◆ preloadData()

Field Documentation

◆ $block_type

◆ $has_access

◆ $http

◆ $inbox

◆ $mails

◆ $rbacsystem

◆ $refinery

◆ $setting