ilMailGroupAddressType Class Reference

Class ilMailGroupAddressType. More...

Inheritance diagram for ilMailGroupAddressType:

Collaboration diagram for ilMailGroupAddressType:

Public Member Functions
	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. See also ::getErrors Parameters $senderId integer The id of the acting ILIAS user, can be used for permission checks etc. Returns bool More...
	getErrors ()
	Returns a list of errors determined in the validation process.The errors should be reset everytime the validation is triggered. See also ::validate Returns More...
	getAddress ()
	The address instance used for validation and user id lookup. Returns More...

Protected Member Functions
	isValid (int $senderId)
Protected Member Functions inherited from ilBaseMailAddressType
	isValid (int $senderId)
	pushError (string $languageVariable, array $placeHolderValues=[])

Additional Inherited Members
Protected Attributes inherited from ilBaseMailAddressType
	$typeHelper
	$address
	$logger

Detailed Description

Class ilMailGroupAddressType.

Author

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

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

Member Function Documentation

isValid()

ilMailGroupAddressType::isValid ( int  $senderId )

protected

Definition at line 13 of file class.ilMailGroupAddressType.php.

                                              : bool
    {
        return $this->typeHelper->doesGroupNameExists(substr($this->address->getMailbox(), 1));
    }

resolve()

ilMailGroupAddressType::resolve

(

)

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

Returns

int[]

Implements ilMailAddressType.

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

                              : array
    {
        $usrIds = [];

        $possibleGroupTitle = substr($this->address->getMailbox(), 1);
        $possibleGroupObjId = $this->typeHelper->getGroupObjIdByTitle($possibleGroupTitle);

        $group = null;
        foreach ($this->typeHelper->getAllRefIdsForObjId($possibleGroupObjId) as $refId) {
            $group = $this->typeHelper->getInstanceByRefId($refId);
            break;
        }

        if ($group instanceof \ilObjGroup) {
            foreach ($group->getGroupMemberIds() as $usr_id) {
                $usrIds[] = $usr_id;
            }

            $this->logger->debug(sprintf(
                "Found the following group member user ids for address (object title) '%s' and obj_id %s: %s",
                $possibleGroupTitle,
                $possibleGroupObjId,
                implode(', ', array_unique($usrIds))
            ));
        } else {
            $this->logger->debug(sprintf(
                "Did not find any group object for address (object title) '%s'",
                $possibleGroupTitle
            ));
        }

        return array_unique($usrIds);
    }

---

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

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