ilMailUserActionProvider Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilMailUserActionProvider:

Collaboration diagram for ilMailUserActionProvider:

Public Member Functions
	checkUserMailAccess (int $a_user_id)
	getComponentId ()
	getActionTypes ()
	collectActionsForTargetUser (int $a_target_user)
	Collect actions for a target user. More...
Public Member Functions inherited from ilUserActionProvider
	__construct ()
	setUserId (int $a_val)
	getUserId ()
	collectActionsForTargetUser (int $a_target_user)
	Collect actions for a target user. More...
	getComponentId ()
	getActionTypes ()
	getJsScripts (string $a_action_type)

Static Public Attributes
static array	$user_access = []

Additional Inherited Members
Protected Attributes inherited from ilUserActionProvider
int	$user_id
Language	$lng
ilDBInterface	$db

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Adds link to mail

Author

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

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

Member Function Documentation

checkUserMailAccess()

ilMailUserActionProvider::checkUserMailAccess

(

int

$a_user_id

)

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

                                                       : bool
    {
        global $DIC;
 
        $rbacsystem = $DIC['rbacsystem'];
 
        if (!isset(self::$user_access[$a_user_id])) {
            self::$user_access[$a_user_id] =
                $rbacsystem->checkAccessOfUser($a_user_id, 'internal_mail', ilMailGlobalServices::getMailObjectRefId());
        }
        return (bool) self::$user_access[$a_user_id];
    }

References $DIC, and ilMailGlobalServices\getMailObjectRefId().

Referenced by collectActionsForTargetUser().

Here is the call graph for this function:

Here is the caller graph for this function:

collectActionsForTargetUser()

ilMailUserActionProvider::collectActionsForTargetUser

(

int

$a_target_user

)

Collect actions for a target user.

Reimplemented from ilUserActionProvider.

Definition at line 55 of file class.ilMailUserActionProvider.php.

                                                                   : ilUserActionCollection
    {
        $coll = new ilUserActionCollection();
 
        // check mail permission of user
        if ($this->getUserId() == ANONYMOUS_USER_ID || !$this->checkUserMailAccess($this->getUserId())) {
            return $coll;
        }
 
        // check mail permission of target user
        if ($this->checkUserMailAccess($a_target_user)) {
            $f = new ilUserAction();
            $f->setType("compose");
            $f->setText($this->lng->txt("mail"));
            $tn = ilObjUser::_lookupName($a_target_user);
            $f->setHref(ilMailFormCall::getLinkTarget("", '', [], ['type' => 'new', 'rcp_to' => $tn["login"]]));
            $coll->addAction($f);
        }
 
        return $coll;
    }

References Vendor\Package\$f, ilObjUser\_lookupName(), ANONYMOUS_USER_ID, checkUserMailAccess(), ilMailFormCall\getLinkTarget(), ilUserActionProvider\getUserId(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getActionTypes()

ilMailUserActionProvider::getActionTypes

(

)

Returns

array<string,string>

Reimplemented from ilUserActionProvider.

Definition at line 48 of file class.ilMailUserActionProvider.php.

                                    : array
    {
        return [
            "compose" => $this->lng->txt("mail")
        ];
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getComponentId()

ilMailUserActionProvider::getComponentId

(

)

Returns

string component id as defined in services.xml/module.xml

Reimplemented from ilUserActionProvider.

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

                                    : string
    {
        return "mail";
    }

Field Documentation

$user_access

array ilMailUserActionProvider::$user_access = []

static

Definition at line 25 of file class.ilMailUserActionProvider.php.

---

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

• components/ILIAS/User/classes/Actions/class.ilMailUserActionProvider.php