Collaboration diagram for ilMailTemplate:

Public Member Functions
	__construct (?array $data=null)

	toArray ()

	getTplId ()

	setTplId (int $template_id)

	getTitle ()

	setTitle (string $title)

	getContext ()

	setContext (string $context)

	getLang ()

	setLang (string $lang)

	getSubject ()

	setSubject (string $subject)

	getMessage ()

	setMessage (string $message)

	isDefault ()

	setAsDefault (bool $is_default)

Protected Attributes
int	$template_id = 0

string	$title = ''

string	$context = ''

string	$lang = ''

string	$subject = ''

string	$message = ''

bool	$is_default = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMailTemplate::__construct ( ?array $data = null )

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

    {
        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']);
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getContext()

ilMailTemplate::getContext ( )

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

                                : string
    {
        return $this->context;
    }

References $context.

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

Here is the caller graph for this function:

◆ getLang()

ilMailTemplate::getLang ( )

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

                             : string
    {
        return $this->lang;
    }

References $lang.

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

Here is the caller graph for this function:

◆ getMessage()

ilMailTemplate::getMessage ( )

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

                                : string
    {
        return $this->message;
    }

References $message.

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

Here is the caller graph for this function:

◆ getSubject()

ilMailTemplate::getSubject ( )

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

                                : string
    {
        return $this->subject;
    }

References $subject.

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

Here is the caller graph for this function:

◆ getTitle()

ilMailTemplate::getTitle ( )

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

                              : string
    {
        return $this->title;
    }

References $title.

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

Here is the caller graph for this function:

◆ getTplId()

ilMailTemplate::getTplId ( )

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

                              : int
    {
        return $this->template_id;
    }

References $template_id.

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

Here is the caller graph for this function:

◆ isDefault()

ilMailTemplate::isDefault ( )

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

                               : bool
    {
        return $this->is_default;
    }

References $is_default.

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

Here is the caller graph for this function:

◆ setAsDefault()

ilMailTemplate::setAsDefault ( bool $is_default )

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

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

References $is_default.

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

Here is the caller graph for this function:

◆ setContext()

ilMailTemplate::setContext ( string $context )

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

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

References $context.

Referenced by __construct().

Here is the caller graph for this function:

◆ setLang()

ilMailTemplate::setLang ( string $lang )

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

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

References $lang.

Referenced by __construct().

Here is the caller graph for this function:

◆ setMessage()

ilMailTemplate::setMessage ( string $message )

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

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

References $message.

Referenced by __construct().

Here is the caller graph for this function:

◆ setSubject()

ilMailTemplate::setSubject ( string $subject )

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

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

References $subject.

Referenced by __construct().

Here is the caller graph for this function:

◆ setTitle()

ilMailTemplate::setTitle ( string $title )

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

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

References $title.

Referenced by __construct().

Here is the caller graph for this function:

◆ setTplId()

ilMailTemplate::setTplId ( int $template_id )

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

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

References $template_id.

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

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 47 of file class.ilMailTemplate.php.

                             : 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(),
        ];
    }

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

Referenced by ilMailTemplateService\listAllTemplatesAsArray().

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 25 of file class.ilMailTemplate.php.

Referenced by getContext(), and setContext().

◆ $is_default

bool ilMailTemplate::$is_default = false

protected

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

Referenced by isDefault(), and setAsDefault().

◆ $lang

string ilMailTemplate::$lang = ''

protected

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

Referenced by getLang(), and setLang().

◆ $message

string ilMailTemplate::$message = ''

protected

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

Referenced by getMessage(), and setMessage().

◆ $subject

string ilMailTemplate::$subject = ''

protected

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

Referenced by getSubject(), and setSubject().

◆ $template_id

int ilMailTemplate::$template_id = 0

protected

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

Referenced by getTplId(), and setTplId().

◆ $title

string ilMailTemplate::$title = ''

protected

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getContext()

◆ getLang()

◆ getMessage()

◆ getSubject()

◆ getTitle()

◆ getTplId()

◆ isDefault()

◆ setAsDefault()

◆ setContext()

◆ setLang()

◆ setMessage()

◆ setSubject()

◆ setTitle()

◆ setTplId()

◆ toArray()

Field Documentation

◆ $context

◆ $is_default

◆ $lang

◆ $message

◆ $subject

◆ $template_id

◆ $title