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)
	resolve ()
	Returns an array of resolved user ids based on an address instance. More...
Public Member Functions inherited from ilBaseMailAddressType
	__construct (ilMailAddressTypeHelper $typeHelper, ilMailAddress $address, ilLogger $logger)
	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...
	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)
Protected Member Functions inherited from ilBaseMailAddressType
	isValid (int $senderId)
	pushError (string $languageVariable, array $placeHolderValues=[])

Protected Attributes
ilRbacSystem	$rbacsystem
ilRbacReview	$rbacreview
ilRoleMailboxSearch	$roleMailboxSearch
Protected Attributes inherited from ilBaseMailAddressType
ilMailAddressTypeHelper	$typeHelper
ilMailAddress	$address
ilLogger	$logger

Detailed Description

Class ilMailRoleAddressType.

Author

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

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

Constructor & Destructor Documentation

__construct()

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

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

Returns

int[]

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

Reimplemented from ilBaseMailAddressType.

Definition at line 73 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 ($roleIds === []) {
            $this->pushError('mail_recipient_not_found', [$this->address->getMailbox()]);
            return false;
        }
 
        if (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

Definition at line 58 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 101 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",
                $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",
                    $this->address,
                    implode(', ', array_unique($usrIds))
                ));
            } else {
                $this->logger->debug(sprintf(
                    "Did not find any assigned users for roles determined by '%s'",
                    $this->address
                ));
            }
        } else {
            $this->logger->debug(sprintf(
                "Did not find any role (and user ids) for address '%s'",
                $this->address
            ));
        }
 
        return array_unique($usrIds);
    }

References getRoleIdsByAddress(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Field Documentation

$rbacreview

ilRbacReview ilMailRoleAddressType::$rbacreview

protected

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

Referenced by __construct().

$rbacsystem

ilRbacSystem ilMailRoleAddressType::$rbacsystem

protected

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

Referenced by __construct().

$roleMailboxSearch

ilRoleMailboxSearch ilMailRoleAddressType::$roleMailboxSearch

protected

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