ilMailTemplateRepository Class Reference

Collaboration diagram for ilMailTemplateRepository:

Public Member Functions
	__construct (?ilDBInterface $db=null)
	getAll ()
	findById (int $template_id)
	findByContextId (string $context_id)
	deleteByIds (array $template_ids)
	store (ilMailTemplate $template)

Protected Attributes
ilDBInterface	$db

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailTemplateRepository::__construct

(

?ilDBInterface

$db = null

)

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

References $DIC.

    {
        global $DIC;
        $this->db = $db ?? $DIC->database();
    }

Member Function Documentation

deleteByIds()

ilMailTemplateRepository::deleteByIds

(

array

$template_ids

)

Parameters

list<int>

$template_ids

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

References ilDBConstants\T_INTEGER.

                                                    : void
    {
        if ($template_ids !== []) {
            $this->db->manipulate(
                'DELETE FROM mail_man_tpl WHERE ' . $this->db->in('tpl_id', $template_ids, false, ilDBConstants::T_INTEGER)
            );
        }
    }

findByContextId()

ilMailTemplateRepository::findByContextId

(

string

$context_id

)

Returns

list<ilMailTemplate>

Definition at line 66 of file class.ilMailTemplateRepository.php.

References getAll(), and ilMailTemplate\getContext().

                                                       : array
    {
        return array_values(
            array_filter(
                $this->getAll(),
                static fn(ilMailTemplate $template): bool => $context_id === $template->getContext()
            )
        );
    }

Here is the call graph for this function:

findById()

ilMailTemplateRepository::findById

(

int

$template_id

)

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

References $res, and ilDBConstants\T_INTEGER.

                                              : ilMailTemplate
    {
        $res = $this->db->queryF(
            'SELECT * FROM mail_man_tpl WHERE tpl_id  = %s',
            [ilDBConstants::T_INTEGER],
            [$template_id]
        );

        if ($this->db->numRows($res) === 1) {
            $row = $this->db->fetchAssoc($res);
            return new ilMailTemplate($row);
        }

        throw new OutOfBoundsException(sprintf('Could not find template by id: %s', $template_id));
    }

getAll()

ilMailTemplateRepository::getAll

(

)

Returns

list<ilMailTemplate>

Definition at line 34 of file class.ilMailTemplateRepository.php.

References $res.

Referenced by findByContextId().

                            : array
    {
        $templates = [];

        $res = $this->db->query('SELECT * FROM mail_man_tpl');
        while ($row = $this->db->fetchAssoc($res)) {
            $template = new ilMailTemplate($row);
            $templates[] = $template;
        }

        return $templates;
    }

Here is the caller graph for this function:

store()

ilMailTemplateRepository::store

(

ilMailTemplate

$template

)

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

References ilMailTemplate\getContext(), ilMailTemplate\getLang(), ilMailTemplate\getMessage(), ilMailTemplate\getSubject(), ilMailTemplate\getTitle(), ilMailTemplate\getTplId(), ilMailTemplate\isDefault(), ilMailTemplate\setTplId(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                   : void
    {
        if ($template->getTplId() > 0) {
            $this->db->update(
                'mail_man_tpl',
                [
                    'title' => [ilDBConstants::T_TEXT, $template->getTitle()],
                    'context' => [ilDBConstants::T_TEXT, $template->getContext()],
                    'lang' => [ilDBConstants::T_TEXT, $template->getLang()],
                    'm_subject' => [ilDBConstants::T_TEXT, $template->getSubject()],
                    'm_message' => [ilDBConstants::T_TEXT, $template->getMessage()],
                    'is_default' => [ilDBConstants::T_INTEGER, $template->isDefault()],
                ],
                [
                    'tpl_id' => [ilDBConstants::T_INTEGER, $template->getTplId()],
                ]
            );
        } else {
            $next_id = $this->db->nextId('mail_man_tpl');
            $this->db->insert('mail_man_tpl', [
                'tpl_id' => [ilDBConstants::T_INTEGER, $next_id],
                'title' => [ilDBConstants::T_TEXT, $template->getTitle()],
                'context' => [ilDBConstants::T_TEXT, $template->getContext()],
                'lang' => [ilDBConstants::T_TEXT, $template->getLang()],
                'm_subject' => [ilDBConstants::T_TEXT, $template->getSubject()],
                'm_message' => [ilDBConstants::T_TEXT, $template->getMessage()],
                'is_default' => [ilDBConstants::T_INTEGER, $template->isDefault()],
            ]);
            $template->setTplId($next_id);
        }
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilMailTemplateRepository::$db

protected

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

---

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

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