ilPDMailBlockGUI Class Reference

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

Inheritance diagram for ilPDMailBlockGUI:

Collaboration diagram for ilPDMailBlockGUI:

Public Member Functions
	__construct ()
	getBlockType ()
	executeCommand ()
	getHTML ()
	deleteMail ()
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 Public Member Functions inherited from ilBlockGUI
static	getScreenMode ()

Static Public Attributes
static string	$block_type = 'pdmail'

Protected Member Functions
	isRepositoryObject ()
	getMails ()
	getOverview ()
	showMail ()
	preloadData (array $data)
	getListItemForData (array $data)
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 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

Private Attributes
readonly GlobalHttpState	$http
readonly Refinery	$refinery
int	$requestMailObjId = 0
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

BlockGUI class for Personal Desktop Mail block.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilPDMailBlockGUI::__construct

(

)

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__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().

    {
        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);
        }
    }

Here is the call graph for this function:

Member Function Documentation

deleteMail()

ilPDMailBlockGUI::deleteMail

(

)

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

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                : void
    {
        $this->lng->loadLanguageModule('mail');

        $umail = new ilMail($this->user->getId());
        $mbox = new ilMailbox($this->user->getId());

        $mailId = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }
        $mobjId = 0;
        if ($this->http->wrapper()->query()->has('mobj_id')) {
            $mobjId = $this->http->wrapper()->query()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        }

        if ($mobjId) {
            $this->requestMailObjId = $mbox->getInboxFolder();
        }

        if ($umail->moveMailsToFolder(
            [$mailId],
            $mbox->getTrashFolder()
        )) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('mail_moved_to_trash'), true);
        } else {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('mail_move_error'), true);
        }
        $this->ctrl->redirectByClass(ilDashboardGUI::class, 'show');
    }

Here is the call graph for this function:

executeCommand()

ilPDMailBlockGUI::executeCommand

(

)

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

References ILIAS\Repository\ctrl().

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

        return $this->$cmd();
    }

Here is the call graph for this function:

getBlockType()

ilPDMailBlockGUI::getBlockType

(

)

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

                                  : string
    {
        return self::$block_type;
    }

getHTML()

ilPDMailBlockGUI::getHTML

(

)

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

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

getListItemForData()

ilPDMailBlockGUI::getListItemForData ( array  $data )

protected

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

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

                                                      : ?Item
    {
        $f = $this->ui->factory();

        $user = ilMailUserCache::getUserObjectById($data['sender_id']);

        if ($user && $user->getId() !== ANONYMOUS_USER_ID) {
            $public_name_long = $user->getPublicName();
            $img_sender = $user->getPersonalPicturePath('xxsmall');
            $alt_sender = htmlspecialchars($user->getPublicName());
        } elseif (!$user instanceof ilObjUser) {
            $public_name_long = trim(($data['import_name'] ?? '') . ' (' . $this->lng->txt('user_deleted') . ')');
            $img_sender = "";
            $alt_sender = "";
        } else {
            $public_name_long = ilMail::_getIliasMailerName();
            $img_sender = ilUtil::getImagePath('logo/HeaderIconAvatar.svg');
            $alt_sender = htmlspecialchars(ilMail::_getIliasMailerName());
        }

        $new_mail_date = ilDatePresentation::formatDate(new ilDate($data['send_time'], IL_CAL_DATE));
        $new_mail_subj = htmlentities($data['m_subject'], ENT_NOQUOTES, 'UTF-8');
        $this->ctrl->setParameter($this, 'mobj_id', $this->inbox);
        $this->ctrl->setParameter($this, 'mail_id', $data['mail_id']);
        $new_mail_link = $this->ctrl->getLinkTarget($this, 'showMail');
        $this->ctrl->clearParameters($this);


        $button = $f->button()->shy($new_mail_subj, $new_mail_link);

        $item = $f->item()->standard($button)->withDescription($new_mail_date);
        if ($img_sender !== "") {
            $item = $item->withLeadImage($f->image()->standard($img_sender, $alt_sender));
        }

        return $item;
    }

Here is the call graph for this function:

getMails()

ilPDMailBlockGUI::getMails ( )

protected

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

References ilMail\getMailsOfFolder(), and ILIAS\Repository\user().

Referenced by __construct().

                                 : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getOverview()

ilPDMailBlockGUI::getOverview ( )

protected

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getScreenMode()

static ilPDMailBlockGUI::getScreenMode ( )

static

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

References $DIC, IL_SCREEN_CENTER, and IL_SCREEN_SIDE.

                                          : 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;
    }

isRepositoryObject()

ilPDMailBlockGUI::isRepositoryObject ( )

protected

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

                                           : bool
    {
        return false;
    }

preloadData()

ilPDMailBlockGUI::preloadData ( array  $data )

protected

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

References ANONYMOUS_USER_ID, and ilMailUserCache\preloadUserObjects().

                                               : 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);
    }

Here is the call graph for this function:

showMail()

ilPDMailBlockGUI::showMail ( )

protected

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

References $requestMailObjId, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                 : string
    {
        $mail_gui = new ilPDMailGUI();

        $content_block = new ilDashboardContentBlockGUI();
        $mailId = 0;
        if ($this->http->wrapper()->query()->has('mail_id')) {
            $mailId = $this->http->wrapper()->query()->retrieve('mail_id', $this->refinery->kindlyTo()->int());
        }
        $mobjId = $this->requestMailObjId;
        if ($this->http->wrapper()->query()->has('mobj_id')) {
            $mobjId = $this->http->wrapper()->query()->retrieve('mobj_id', $this->refinery->kindlyTo()->int());
        }
        $content_block->setContent($mail_gui->getPDMailHTML(
            $mailId,
            $mobjId
        ));
        $content_block->setTitle($this->lng->txt("message"));

        $content_block->addBlockCommand(
            "ilias.php?baseClass=ilMailGUI&mail_id=" .
            $mailId . "&mobj_id="
            . $mobjId . "&type=reply",
            $this->lng->txt("reply")
        );
        $content_block->addBlockCommand(
            "ilias.php?baseClass=ilMailGUI&mail_id=" .
            $mailId . "&mobj_id="
            . $mobjId . "&type=read",
            $this->lng->txt("inbox")
        );

        $this->ctrl->setParameter($this, 'mail_id', $mailId);
        $content_block->addBlockCommand(
            $this->ctrl->getLinkTarget($this, 'deleteMail'),
            $this->lng->txt('delete')
        );

        return $content_block->getHTML();
    }

Here is the call graph for this function:

Field Documentation

$block_type

string ilPDMailBlockGUI::$block_type = 'pdmail'

static

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

$has_access

bool ilPDMailBlockGUI::$has_access = false

private

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

$http

readonly GlobalHttpState ilPDMailBlockGUI::$http

private

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

$inbox

int ilPDMailBlockGUI::$inbox

protected

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

$mails

array ilPDMailBlockGUI::$mails = []

protected

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

$rbacsystem

ilRbacSystem ilPDMailBlockGUI::$rbacsystem

protected

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

$refinery

readonly Refinery ilPDMailBlockGUI::$refinery

private

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

$requestMailObjId

int ilPDMailBlockGUI::$requestMailObjId = 0

private

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

Referenced by showMail().

$setting

ilSetting ilPDMailBlockGUI::$setting

protected

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

---

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

• Services/Mail/classes/class.ilPDMailBlockGUI.php