ilMailMimeSenderFactory Class Reference

Class ilMailMimeSenderFactory. More...

Collaboration diagram for ilMailMimeSenderFactory:

Public Member Functions
	__construct (\ilSetting $settings)
	ilMailMimeSenderFactory constructor. More...
	getSenderByUsrId ($usrId)
	system ()
	user ($usrId)
	userByEmailAddress ($emailAddress)

Protected Member Functions
	isSystemMail ($usrId)

Protected Attributes
	$settings
	$senders = array()

Detailed Description

Class ilMailMimeSenderFactory.

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

Constructor & Destructor Documentation

__construct()

ilMailMimeSenderFactory::__construct

(

\ilSetting

$settings

)

ilMailMimeSenderFactory constructor.

Parameters

ilSetting

$settings

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

    {
        $this->settings = $settings;
    }

References $settings, and settings().

Here is the call graph for this function:

Member Function Documentation

getSenderByUsrId()

ilMailMimeSenderFactory::getSenderByUsrId

(

$usrId

)

Parameters

int

$usrId

Returns

ilMailMimeSender

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

    {
        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;
    }

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

Here is the call graph for this function:

isSystemMail()

ilMailMimeSenderFactory::isSystemMail (   $usrId )

protected

Parameters

int

$usrId

Returns

bool

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

    {
        return $usrId == ANONYMOUS_USER_ID;
    }

Referenced by getSenderByUsrId().

Here is the caller graph for this function:

system()

ilMailMimeSenderFactory::system

(

)

Returns

ilMailMimeSenderSystem

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

    {
        require_once 'Services/Mail/classes/Mime/Sender/class.ilMailMimeSenderSystem.php';
        return new ilMailMimeSenderSystem($this->settings);
    }

References settings().

Referenced by getSenderByUsrId().

Here is the call graph for this function:

Here is the caller graph for this function:

user()

ilMailMimeSenderFactory::user

(

$usrId

)

Parameters

int

$usrId

Returns

ilMailMimeSenderUser

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

    {
        require_once 'Services/Mail/classes/Mime/Sender/class.ilMailMimeSenderUser.php';
        return ilMailMimeSenderUser::byUsrId($this->settings, $usrId);
    }

References ilMailMimeSenderUser\byUsrId(), and settings().

Referenced by getSenderByUsrId().

Here is the call graph for this function:

Here is the caller graph for this function:

userByEmailAddress()

ilMailMimeSenderFactory::userByEmailAddress

(

$emailAddress

)

Parameters

$emailAddress

Returns

ilMailMimeSenderUser

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

    {
        require_once 'Services/Mail/classes/Mime/Sender/class.ilMailMimeSenderUser.php';
        return ilMailMimeSenderUser::byEmailAddress($this->settings, $emailAddress);
    }

References ilMailMimeSenderUser\byEmailAddress(), and settings().

Here is the call graph for this function:

Field Documentation

$senders

ilMailMimeSenderFactory::$senders = array()

protected

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

$settings

ilMailMimeSenderFactory::$settings

protected

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