ilMailTemplate Class Reference

Class ilMailTemplate. More...

Collaboration diagram for ilMailTemplate:

Public Member Functions
	__construct (?array $data=null)
	toArray ()
	getTplId ()
	setTplId (int $templateId)
	getTitle ()
	setTitle (string $title)
	getContext ()
	setContext (string $context)
	getLang ()
	setLang (string $lang)
	getSubject ()
	setSubject (string $subject)
	getMessage ()
	setMessage (string $message)
	isDefault ()
	setAsDefault (bool $isDefault)

Protected Attributes
int	$templateId = 0
string	$title = ''
string	$context = ''
string	$lang = ''
string	$subject = ''
string	$message = ''
bool	$isDefault = false

Detailed Description

Class ilMailTemplate.

Author

Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilMailTemplate::__construct

(

?array

$data = null

)

Definition at line 35 of file class.ilMailTemplate.php.

References $data, setAsDefault(), setContext(), setLang(), setMessage(), setSubject(), setTitle(), and setTplId().

    {
        if ($data) {
            $this->setTplId((int) $data['tpl_id']);
            $this->setTitle((string) $data['title']);
            $this->setContext((string) $data['context']);
            $this->setLang((string) $data['lang']);
            $this->setSubject((string) $data['m_subject']);
            $this->setMessage((string) $data['m_message']);
            $this->setAsDefault((bool) $data['is_default']);
        }
    }

Here is the call graph for this function:

Member Function Documentation

getContext()

ilMailTemplate::getContext

(

)

Definition at line 84 of file class.ilMailTemplate.php.

References $context.

Referenced by ilMailTemplateRepository\findByContextId(), ilMailTemplateGUI\populateFormWithTemplate(), ilMailTemplateService\setAsContextDefault(), ilMailTemplateRepository\store(), and toArray().

                                : string
    {
        return $this->context;
    }

Here is the caller graph for this function:

getLang()

ilMailTemplate::getLang

(

)

Definition at line 94 of file class.ilMailTemplate.php.

References $lang.

Referenced by ilMailTemplateGUI\populateFormWithTemplate(), ilMailTemplateRepository\store(), and toArray().

                             : string
    {
        return $this->lang;
    }

Here is the caller graph for this function:

getMessage()

ilMailTemplate::getMessage

(

)

Definition at line 114 of file class.ilMailTemplate.php.

References $message.

Referenced by ilMailTemplateGUI\populateFormWithTemplate(), ilMailTemplateRepository\store(), and toArray().

                                : string
    {
        return $this->message;
    }

Here is the caller graph for this function:

getSubject()

ilMailTemplate::getSubject

(

)

Definition at line 104 of file class.ilMailTemplate.php.

References $subject.

Referenced by ilMailTemplateGUI\populateFormWithTemplate(), ilMailTemplateRepository\store(), and toArray().

                                : string
    {
        return $this->subject;
    }

Here is the caller graph for this function:

getTitle()

ilMailTemplate::getTitle

(

)

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

References $title.

Referenced by ilMailTemplateGUI\populateFormWithTemplate(), ilMailTemplateRepository\store(), and toArray().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

getTplId()

ilMailTemplate::getTplId

(

)

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

References $templateId.

Referenced by ilMailTemplateGUI\getTemplateForm(), ilMailTemplateGUI\populateFormWithTemplate(), ilMailTemplateService\setAsContextDefault(), ilMailTemplateRepository\store(), ilMailTemplateRepositoryTest\testEntityCanBeDeleted(), and toArray().

                              : int
    {
        return $this->templateId;
    }

Here is the caller graph for this function:

isDefault()

ilMailTemplate::isDefault

(

)

Definition at line 124 of file class.ilMailTemplate.php.

References $isDefault.

Referenced by setAsDefault(), ilMailTemplateRepository\store(), and toArray().

                               : bool
    {
        return $this->isDefault;
    }

Here is the caller graph for this function:

setAsDefault()

ilMailTemplate::setAsDefault

(

bool

$isDefault

)

Definition at line 129 of file class.ilMailTemplate.php.

References $isDefault, and isDefault().

Referenced by __construct(), and ilMailTemplateService\unsetAsContextDefault().

                                                 : void
    {
        $this->isDefault = $isDefault;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setContext()

ilMailTemplate::setContext

(

string

$context

)

Definition at line 89 of file class.ilMailTemplate.php.

References $context.

Referenced by __construct().

                                               : void
    {
        $this->context = $context;
    }

Here is the caller graph for this function:

setLang()

ilMailTemplate::setLang

(

string

$lang

)

Definition at line 99 of file class.ilMailTemplate.php.

References $lang.

Referenced by __construct().

                                         : void
    {
        $this->lang = $lang;
    }

Here is the caller graph for this function:

setMessage()

ilMailTemplate::setMessage

(

string

$message

)

Definition at line 119 of file class.ilMailTemplate.php.

References $message.

Referenced by __construct().

                                               : void
    {
        $this->message = $message;
    }

Here is the caller graph for this function:

setSubject()

ilMailTemplate::setSubject

(

string

$subject

)

Definition at line 109 of file class.ilMailTemplate.php.

References $subject.

Referenced by __construct().

                                               : void
    {
        $this->subject = $subject;
    }

Here is the caller graph for this function:

setTitle()

ilMailTemplate::setTitle

(

string

$title

)

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

References $title.

Referenced by __construct().

                                           : void
    {
        $this->title = $title;
    }

Here is the caller graph for this function:

setTplId()

ilMailTemplate::setTplId

(

int

$templateId

)

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

References $templateId.

Referenced by __construct(), and ilMailTemplateRepository\store().

                                             : void
    {
        $this->templateId = $templateId;
    }

Here is the caller graph for this function:

toArray()

ilMailTemplate::toArray

(

)

Returns

array{tpl_id: int, title: string, context: string, lang: string, m_subject: string, m_message: string, is_default: bool}

Definition at line 51 of file class.ilMailTemplate.php.

References getContext(), getLang(), getMessage(), getSubject(), getTitle(), getTplId(), and isDefault().

Referenced by ilMailTemplateService\listAllTemplatesAsArray().

                             : array
    {
        return [
            'tpl_id' => $this->getTplId(),
            'title' => $this->getTitle(),
            'context' => $this->getContext(),
            'lang' => $this->getLang(),
            'm_subject' => $this->getSubject(),
            'm_message' => $this->getMessage(),
            'is_default' => $this->isDefault(),
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$context

string ilMailTemplate::$context = ''

protected

Definition at line 29 of file class.ilMailTemplate.php.

Referenced by getContext(), and setContext().

$isDefault

bool ilMailTemplate::$isDefault = false

protected

Definition at line 33 of file class.ilMailTemplate.php.

Referenced by isDefault(), and setAsDefault().

$lang

string ilMailTemplate::$lang = ''

protected

Definition at line 30 of file class.ilMailTemplate.php.

Referenced by getLang(), and setLang().

$message

string ilMailTemplate::$message = ''

protected

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

Referenced by getMessage(), and setMessage().

$subject

string ilMailTemplate::$subject = ''

protected

Definition at line 31 of file class.ilMailTemplate.php.

Referenced by getSubject(), and setSubject().

$templateId

int ilMailTemplate::$templateId = 0

protected

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

Referenced by getTplId(), and setTplId().

$title

string ilMailTemplate::$title = ''

protected

Definition at line 28 of file class.ilMailTemplate.php.

Referenced by getTitle(), and setTitle().

---

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

• components/ILIAS/Mail/classes/class.ilMailTemplate.php