ilMailRoleAddressType Class Reference

Inheritance diagram for ilMailRoleAddressType:

Collaboration diagram for ilMailRoleAddressType:

Public Member Functions
	__construct (ilMailAddressTypeHelper $type_helper, ilMailAddress $address, protected ilRoleMailboxSearch $role_mailbox_search, ilLogger $logger, protected ilRbacSystem $rbacsystem, protected ilRbacReview $rbacreview)
	resolve ()
	Returns an array of resolved user ids based on an address instance. More...
Public Member Functions inherited from ilBaseMailAddressType
	__construct (protected ilMailAddressTypeHelper $type_helper, protected ilMailAddress $address, protected ilLogger $logger)
	validate (int $sender_id)
	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 $sender_id)
	isValid (int $sender_id)
Protected Member Functions inherited from ilBaseMailAddressType
	isValid (int $sender_id)
	pushError (string $language_variable, array $place_holder_values=[])

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailRoleAddressType::__construct	(	ilMailAddressTypeHelper	$type_helper,
		ilMailAddress	$address,
		protected ilRoleMailboxSearch	$role_mailbox_search,
		ilLogger	$logger,
		protected ilRbacSystem	$rbacsystem,
		protected ilRbacReview	$rbacreview
	)

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

References ILIAS\GlobalScreen\Provider\__construct().

      {
        parent::__construct($type_helper, $address, $logger);
    }

Here is the call graph for this function:

Member Function Documentation

getRoleIdsByAddress()

ilMailRoleAddressType::getRoleIdsByAddress ( ilMailAddress  $address )

protected

Returns

list<int>

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

Referenced by isValid(), and resolve().

                                                                  : array
    {
        $combined_address = (string) $address;

        return $this->role_mailbox_search->searchRoleIdsByAddressString($combined_address);
    }

Here is the caller graph for this function:

isValid()

ilMailRoleAddressType::isValid ( int  $sender_id )

protected

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

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

                                              : bool
    {
        $role_ids = $this->getRoleIdsByAddress($this->address);
        if (!$this->maySendToGlobalRole($sender_id)) {
            foreach ($role_ids as $role_id) {
                if ($this->rbacreview->isGlobalRole($role_id)) {
                    $this->pushError('mail_to_global_roles_not_allowed', [$this->address->getMailbox()]);
                    return false;
                }
            }
        }

        if ($role_ids === []) {
            $this->pushError('mail_recipient_not_found', [$this->address->getMailbox()]);
            return false;
        }

        if (count($role_ids) > 1) {
            $this->pushError('mail_multiple_role_recipients_found', [
                $this->address->getMailbox(),
                implode(',', $role_ids),
            ]);
            return false;
        }

        return true;
    }

Here is the call graph for this function:

maySendToGlobalRole()

ilMailRoleAddressType::maySendToGlobalRole ( int  $sender_id )

protected

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

References ANONYMOUS_USER_ID.

Referenced by isValid().

                                                          : bool
    {
        if ($sender_id === ANONYMOUS_USER_ID) {
            return true;
        }

        return $this->rbacsystem->checkAccessOfUser(
            $sender_id,
            'mail_to_global_roles',
            $this->type_helper->getGlobalMailSystemId()
        );
    }

Here is the caller graph for this function:

resolve()

ilMailRoleAddressType::resolve

(

)

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

Returns

list<int>

Implements ilMailAddressType.

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

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

                             : array
    {
        $usr_ids = [];

        $role_ids = $this->getRoleIdsByAddress($this->address);

        if ($role_ids !== []) {
            $this->logger->debug(sprintf(
                "Found the following role ids for address '%s': %s",
                $this->address,
                implode(', ', array_unique($role_ids))
            ));

            foreach ($role_ids as $role_id) {
                foreach ($this->rbacreview->assignedUsers($role_id) as $usr_id) {
                    $usr_ids[] = $usr_id;
                }
            }

            if ($usr_ids !== []) {
                $this->logger->debug(sprintf(
                    "Found the following user ids for roles determined by address '%s': %s",
                    $this->address,
                    implode(', ', array_unique($usr_ids))
                ));
            } 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($usr_ids);
    }

Here is the call graph for this function:

---

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

• components/ILIAS/Mail/classes/Address/Type/class.ilMailRoleAddressType.php