ilMailMimeSenderFactory Class Reference

Class ilMailMimeSenderFactory. More...

Collaboration diagram for ilMailMimeSenderFactory:

Public Member Functions
	__construct (ilSetting $settings, int $anonymousUsrId=null)
	ilMailMimeSenderFactory constructor. More...
	getSenderByUsrId (int $usrId)
	system ()
	user (int $usrId)
	userByEmailAddress (string $emailAddress)

Protected Member Functions
	isSystemMail (int $usrId)

Protected Attributes
	$settings
	$senders = []
	$anonymousUsrId = 0

Detailed Description

Class ilMailMimeSenderFactory.

Author

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

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

Constructor & Destructor Documentation

__construct()

ilMailMimeSenderFactory::__construct	(	ilSetting	$settings,
		int	$anonymousUsrId = null
	)

ilMailMimeSenderFactory constructor.

Parameters

ilSetting	$settings
int | null	$anonymousUsrId

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

References $anonymousUsrId, $settings, ANONYMOUS_USER_ID, and settings().

    {
        $this->settings = $settings;
        if (null === $anonymousUsrId && defined('ANONYMOUS_USER_ID')) {
            $anonymousUsrId = (int) ANONYMOUS_USER_ID;
        }
        $this->anonymousUsrId = $anonymousUsrId;
    }

Here is the call graph for this function:

Member Function Documentation

getSenderByUsrId()

ilMailMimeSenderFactory::getSenderByUsrId

(

int

$usrId

)

Parameters

int

$usrId

Returns

ilMailMimeSender

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

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

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

        switch (true) {
            case $this->isSystemMail($usrId):
                $sender = $this->system();
                break;

            default:
                $sender = $this->user($usrId);
                break;
        }

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

        return $sender;
    }

Here is the call graph for this function:

isSystemMail()

ilMailMimeSenderFactory::isSystemMail ( int  $usrId )

protected

Parameters

int

$usrId

Returns

bool

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

References $anonymousUsrId.

Referenced by getSenderByUsrId().

                                                : bool
    {
        return $usrId === $this->anonymousUsrId;
    }

Here is the caller graph for this function:

system()

ilMailMimeSenderFactory::system

(

)

Returns

ilMailMimeSenderSystem

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

References 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

$usrId

)

Parameters

int

$usrId

Returns

ilMailMimeSenderUser

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

References settings().

Referenced by getSenderByUsrId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

userByEmailAddress()

ilMailMimeSenderFactory::userByEmailAddress

(

string

$emailAddress

)

Parameters

string

$emailAddress

Returns

ilMailMimeSenderUser

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

References settings().

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

Here is the call graph for this function:

Field Documentation

$anonymousUsrId

ilMailMimeSenderFactory::$anonymousUsrId = 0

protected

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

Referenced by __construct(), and isSystemMail().

$senders

ilMailMimeSenderFactory::$senders = []

protected

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

$settings

ilMailMimeSenderFactory::$settings

protected

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

Referenced by __construct().

---

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

• Services/Mail/classes/Mime/Sender/class.ilMailMimeSenderFactory.php