ilMailRoleAddressType Class Reference

Class ilMailRoleAddressType. More...

Inheritance diagram for ilMailRoleAddressType:

Collaboration diagram for ilMailRoleAddressType:

Public Member Functions
	__construct (ilMailAddressTypeHelper $typeHelper, ilMailAddress $address, ilRoleMailboxSearch $roleMailboxSearch, ilLogger $logger, ilRbacSystem $rbacsystem, ilRbacReview $rbacreview)
	ilMailRoleAddressType constructor. More...
	resolve ()
	Returns an array of resolved user ids based on an address instance. Returns int[] More...
Public Member Functions inherited from ilBaseMailAddressType
	__construct (ilMailAddressTypeHelper $typeHelper, ilMailAddress $address, ilLogger $logger)
	ilBaseMailAddressType constructor. More...
	validate (int $senderId)
	Validates the parsed recipients and set errors accordingly. Parameters $senderId integer The id of the acting ILIAS user, can be used for permission checks etc. Returns bool See also ilMailAddressType::getErrors More...
	getErrors ()
	Returns a list of errors determined in the validation process.The errors should be reset everytime the validation is triggered. Returns ilMailError[] See also ilMailAddressType::validate More...
	getAddress ()
	The address instance used for validation and user id lookup. Returns ilMailAddress More...
	resolve ()
	Returns an array of resolved user ids based on an address instance. More...
	validate (int $senderId)
	Validates the parsed recipients and set errors accordingly. More...
	getErrors ()
	Returns a list of errors determined in the validation process. More...
	getAddress ()
	The address instance used for validation and user id lookup. More...

Protected Member Functions
	getRoleIdsByAddress (ilMailAddress $address)
	maySendToGlobalRole (int $senderId)
	isValid (int $senderId)
	Parameters $senderId integer Returns bool More...
Protected Member Functions inherited from ilBaseMailAddressType
	isValid (int $senderId)
	pushError (string $languageVariable, array $placeHolderValues=[])

Protected Attributes
	$rbacsystem
	$rbacreview
	$roleMailboxSearch
Protected Attributes inherited from ilBaseMailAddressType
	$typeHelper
	$address
	$logger

Detailed Description

Class ilMailRoleAddressType.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 8 of file class.ilMailRoleAddressType.php.

Constructor & Destructor Documentation

__construct()

ilMailRoleAddressType::__construct	(	ilMailAddressTypeHelper	$typeHelper,
		ilMailAddress	$address,
		ilRoleMailboxSearch	$roleMailboxSearch,
		ilLogger	$logger,
		ilRbacSystem	$rbacsystem,
		ilRbacReview	$rbacreview
	)

ilMailRoleAddressType constructor.

Parameters

ilMailAddressTypeHelper	$typeHelper
ilMailAddress	$address
ilRoleMailboxSearch	$roleMailboxSearch
ilLogger	$logger
ilRbacSystem	$rbacsystem
ilRbacReview	$rbacreview

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

      {
        parent::__construct($typeHelper, $address, $logger);
 
        $this->roleMailboxSearch = $roleMailboxSearch;
        $this->rbacsystem = $rbacsystem;
        $this->rbacreview = $rbacreview;
    }

References ilBaseMailAddressType\$address, ilBaseMailAddressType\$logger, $rbacreview, $rbacsystem, $roleMailboxSearch, ilBaseMailAddressType\$typeHelper, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

getRoleIdsByAddress()

ilMailRoleAddressType::getRoleIdsByAddress ( ilMailAddress  $address )

protected

Parameters

ilMailAddress

$address

Returns

int[]

Definition at line 47 of file class.ilMailRoleAddressType.php.

                                                                   : array
    {
        $combinedAddress = (string) $address;
 
        $roleIds = $this->roleMailboxSearch->searchRoleIdsByAddressString($combinedAddress);
 
        return $roleIds;
    }

References ilBaseMailAddressType\$address.

Referenced by isValid(), and resolve().

Here is the caller graph for this function:

isValid()

ilMailRoleAddressType::isValid ( int  $senderId )

protected

Parameters

$senderId

integer

Returns

bool

Reimplemented from ilBaseMailAddressType.

Definition at line 78 of file class.ilMailRoleAddressType.php.

                                              : bool
    {
        $roleIds = $this->getRoleIdsByAddress($this->address);
        if (!$this->maySendToGlobalRole($senderId)) {
            foreach ($roleIds as $roleId) {
                if ($this->rbacreview->isGlobalRole($roleId)) {
                    $this->pushError('mail_to_global_roles_not_allowed', [$this->address->getMailbox()]);
                    return false;
                }
            }
        }
 
        if (count($roleIds) == 0) {
            $this->pushError('mail_recipient_not_found', [$this->address->getMailbox()]);
            return false;
        } elseif (count($roleIds) > 1) {
            $this->pushError('mail_multiple_role_recipients_found', [
                $this->address->getMailbox(),
                implode(',', $roleIds),
            ]);
            return false;
        }
 
        return true;
    }

References getRoleIdsByAddress(), maySendToGlobalRole(), and ilBaseMailAddressType\pushError().

Here is the call graph for this function:

maySendToGlobalRole()

ilMailRoleAddressType::maySendToGlobalRole ( int  $senderId )

protected

Parameters

int

$senderId

Returns

bool

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

                                                          : bool
    {
        if ($senderId == ANONYMOUS_USER_ID) {
            return true;
        }
 
        $maySendToGlobalRoles = $this->rbacsystem->checkAccessOfUser(
            $senderId,
            'mail_to_global_roles',
            $this->typeHelper->getGlobalMailSystemId()
        );
 
        return $maySendToGlobalRoles;
    }

References ANONYMOUS_USER_ID.

Referenced by isValid().

Here is the caller graph for this function:

resolve()

ilMailRoleAddressType::resolve

(

)

Returns an array of resolved user ids based on an address instance.

Returns

int[]

Implements ilMailAddressType.

Definition at line 107 of file class.ilMailRoleAddressType.php.

                              : array
    {
        $usrIds = [];
 
        $roleIds = $this->getRoleIdsByAddress($this->address);
 
        if (count($roleIds) > 0) {
            $this->logger->debug(sprintf(
                "Found the following role ids for address '%s': %s",
                (string) $this->address,
                implode(', ', array_unique($roleIds))
            ));
 
            foreach ($roleIds as $roleId) {
                foreach ($this->rbacreview->assignedUsers($roleId) as $usrId) {
                    $usrIds[] = $usrId;
                }
            }
 
            if (count($usrIds) > 0) {
                $this->logger->debug(sprintf(
                    "Found the following user ids for roles determined by address '%s': %s",
                    (string) $this->address,
                    implode(', ', array_unique($usrIds))
                ));
            } else {
                $this->logger->debug(sprintf(
                    "Did not find any assigned users for roles determined by '%s'",
                    (string) $this->address
                ));
            }
        } else {
            $this->logger->debug(sprintf(
                "Did not find any role (and user ids) for address '%s'",
                (string) $this->address
            ));
        }
 
        return array_unique($usrIds);
    }

References getRoleIdsByAddress().

Here is the call graph for this function:

Field Documentation

$rbacreview

ilMailRoleAddressType::$rbacreview

protected

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

Referenced by __construct().

$rbacsystem

ilMailRoleAddressType::$rbacsystem

protected

Definition at line 11 of file class.ilMailRoleAddressType.php.

Referenced by __construct().

$roleMailboxSearch

ilMailRoleAddressType::$roleMailboxSearch

protected

Definition at line 17 of file class.ilMailRoleAddressType.php.

Referenced by __construct().

---

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

• Services/Mail/classes/Address/Type/class.ilMailRoleAddressType.php