ilMailTemplateRepository Class Reference

Class ilMailTemplateRepository. More...

Collaboration diagram for ilMailTemplateRepository:

Public Member Functions
	__construct (\ilDBInterface $db=null)
	ilMailTemplateRepository constructor. More...
	getAll ()
	findById (int $templateId)
	findByContextId (string $contextId)
	deleteByIds (array $templateIds)
	store (\ilMailTemplate $template)

Protected Attributes
	$db

Detailed Description

Class ilMailTemplateRepository.

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

Constructor & Destructor Documentation

__construct()

ilMailTemplateRepository::__construct

(

\ilDBInterface

$db = null

)

ilMailTemplateRepository constructor.

Parameters

ilDBInterface | null

$db

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

References $db, and $DIC.

    {
        global $DIC;

        if (null === $db) {
            $db = $DIC->database();
        }
        $this->db = $db;
    }

Member Function Documentation

deleteByIds()

ilMailTemplateRepository::deleteByIds

(

array

$templateIds

)

Parameters

int[]

$templateIds

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

    {
        if (count($templateIds) > 0) {
            $this->db->manipulate(
                '
                                DELETE FROM mail_man_tpl WHERE ' .
                $this->db->in('tpl_id', $templateIds, false, 'integer')
            );
        }
    }

findByContextId()

ilMailTemplateRepository::findByContextId

(

string

$contextId

)

Parameters

string

$contextId

Returns

[]

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

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

                                                       : array
    {
        return array_filter($this->getAll(), function (\ilMailTemplate $template) use ($contextId) {
            return $contextId === $template->getContext();
        });
    }

Here is the call graph for this function:

findById()

ilMailTemplateRepository::findById

(

int

$templateId

)

Parameters

int

$templateId

Returns

Exceptions

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

References $res, and $row.

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

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

        throw new \OutOfBoundsException(sprintf("Could not find template by id: %s", $templateId));
    }

getAll()

ilMailTemplateRepository::getAll

(

)

Returns

[]

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

References $res, $row, and $template.

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

)

Parameters

\ilMailTemplate

$template

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

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

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

Here is the call graph for this function:

Field Documentation

$db

ilMailTemplateRepository::$db

protected

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

Referenced by __construct().

---

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

• Services/Mail/classes/class.ilMailTemplateRepository.php