ilMailMimeSenderFactory Class Reference

Collaboration diagram for ilMailMimeSenderFactory:

Public Member Functions
	__construct (protected ilSetting $settings, protected ilMustacheFactory $mustache_factory, ?int $anonymous_usr_id=null)
	getSenderByUsrId (int $usr_id)
	system ()
	user (int $usr_id)
	userByEmailAddress (string $email_address)

Protected Member Functions
	isSystemMail (int $usr_id)

Protected Attributes
array	$senders = []
int	$anonymous_usr_id = 0

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailMimeSenderFactory::__construct	(	protected ilSetting	$settings,
		protected ilMustacheFactory	$mustache_factory,
		?int	$anonymous_usr_id = null
	)

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

References $anonymous_usr_id, ANONYMOUS_USER_ID, and null.

      {
        if ($anonymous_usr_id === null && defined('ANONYMOUS_USER_ID')) {
            $anonymous_usr_id = ANONYMOUS_USER_ID;
        }
        if ($anonymous_usr_id === null) {
            throw new Exception();
        }

        $this->anonymous_usr_id = $anonymous_usr_id;
    }

Member Function Documentation

getSenderByUsrId()

ilMailMimeSenderFactory::getSenderByUsrId

(

int

$usr_id

)

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

References isSystemMail(), system(), and user().

                                                 : ilMailMimeSender
    {
        if (array_key_exists($usr_id, $this->senders)) {
            return $this->senders[$usr_id];
        }

        if ($this->isSystemMail($usr_id)) {
            $sender = $this->system();
        } else {
            $sender = $this->user($usr_id);
        }

        $this->senders[$usr_id] = $sender;

        return $sender;
    }

Here is the call graph for this function:

isSystemMail()

ilMailMimeSenderFactory::isSystemMail ( int  $usr_id )

protected

Definition at line 42 of file class.ilMailMimeSenderFactory.php.

References $anonymous_usr_id.

Referenced by getSenderByUsrId().

                                                : bool
    {
        return $usr_id === $this->anonymous_usr_id;
    }

Here is the caller graph for this function:

system()

ilMailMimeSenderFactory::system

(

)

Definition at line 64 of file class.ilMailMimeSenderFactory.php.

References ILIAS\Repository\settings().

Referenced by getSenderByUsrId().

                            : ilMailMimeSenderSystem
    {
        return new ilMailMimeSenderSystem($this->settings);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

user()

ilMailMimeSenderFactory::user

(

int

$usr_id

)

Definition at line 69 of file class.ilMailMimeSenderFactory.php.

References ILIAS\Repository\settings().

Referenced by getSenderByUsrId().

                                     : ilMailMimeSenderUser
    {
        return new ilMailMimeSenderUserById($this->settings, $usr_id, $this->mustache_factory);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userByEmailAddress()

ilMailMimeSenderFactory::userByEmailAddress

(

string

$email_address

)

Definition at line 74 of file class.ilMailMimeSenderFactory.php.

References ILIAS\Repository\settings().

                                                             : ilMailMimeSenderUser
    {
        return new ilMailMimeSenderUserByEmailAddress($this->settings, $email_address, $this->mustache_factory);
    }

Here is the call graph for this function:

Field Documentation

$anonymous_usr_id

int ilMailMimeSenderFactory::$anonymous_usr_id = 0

protected

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

Referenced by __construct(), and isSystemMail().

$senders

array ilMailMimeSenderFactory::$senders = []

protected

Definition at line 24 of file class.ilMailMimeSenderFactory.php.

---

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

• components/ILIAS/Mail/classes/Mime/Sender/class.ilMailMimeSenderFactory.php