ilMailTemplateService Class Reference

Class ilMailTemplateService. More...

Collaboration diagram for ilMailTemplateService:

Public Member Functions
	__construct (\ilMailTemplateRepository $repository)
	ilMailTemplateService constructor. More...
	createNewTemplate (string $contextId, string $title, string $subject, string $message, string $language)
	modifyExistingTemplate (int $templateId, string $contextId, string $title, string $subject, string $message, string $language)
	loadTemplateForId (int $templateId)
	loadTemplatesForContextId (string $contextId)
	deleteTemplatesByIds (array $templateIds)
	listAllTemplatesAsArray ()
	unsetAsContextDefault (\ilMailTemplate $template)
	setAsContextDefault (\ilMailTemplate $template)

Protected Attributes
	$repository

Detailed Description

Class ilMailTemplateService.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 9 of file class.ilMailTemplateService.php.

Constructor & Destructor Documentation

__construct()

ilMailTemplateService::__construct

(

\ilMailTemplateRepository

$repository

)

ilMailTemplateService constructor.

Parameters

ilMailTemplateRepository

$repository

Definition at line 18 of file class.ilMailTemplateService.php.

References $repository, and repository().

    {
        $this->repository = $repository;
    }

Here is the call graph for this function:

Member Function Documentation

createNewTemplate()

ilMailTemplateService::createNewTemplate	(	string	$contextId,
		string	$title,
		string	$subject,
		string	$message,
		string	$language
	)

Parameters

string	$contextId
string	$title
string	$subject
string	$message
string	$language

Returns

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

References $template, and repository().

      : \ilMailTemplate {
        $template = new \ilMailTemplate();
        $template->setContext($contextId);
        $template->setTitle($title);
        $template->setSubject($subject);
        $template->setMessage($message);
        $template->setLang($language);

        $this->repository->store($template);

        return $template;
    }

Here is the call graph for this function:

deleteTemplatesByIds()

ilMailTemplateService::deleteTemplatesByIds

(

array

$templateIds

)

Parameters

array

$templateIds

Definition at line 98 of file class.ilMailTemplateService.php.

References repository().

    {
        $this->repository->deleteByIds($templateIds);
    }

Here is the call graph for this function:

listAllTemplatesAsArray()

ilMailTemplateService::listAllTemplatesAsArray

(

)

Returns

array[]

Definition at line 106 of file class.ilMailTemplateService.php.

References $template, repository(), and ilMailTemplate\toArray().

                                              : array
    {
        $templates = $this->repository->getAll();

        $templates = array_map(function (\ilMailTemplate $template) {
            return $template->toArray();
        }, $templates);

        return $templates;
    }

Here is the call graph for this function:

loadTemplateForId()

ilMailTemplateService::loadTemplateForId

(

int

$templateId

)

Parameters

int

$templateId

Returns

Definition at line 81 of file class.ilMailTemplateService.php.

References repository().

                                                       : \ilMailTemplate
    {
        return $this->repository->findById($templateId);
    }

Here is the call graph for this function:

loadTemplatesForContextId()

ilMailTemplateService::loadTemplatesForContextId

(

string

$contextId

)

Parameters

string

$contextId

Returns

[]

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

References repository().

                                                                 : array
    {
        return $this->repository->findByContextId($contextId);
    }

Here is the call graph for this function:

modifyExistingTemplate()

ilMailTemplateService::modifyExistingTemplate	(	int	$templateId,
		string	$contextId,
		string	$title,
		string	$subject,
		string	$message,
		string	$language
	)

Parameters

int	$templateId
string	$contextId
string	$title
string	$subject
string	$message
string	$language

Definition at line 58 of file class.ilMailTemplateService.php.

References $template, and repository().

      {
        $template = $this->repository->findById($templateId);

        $template->setContext($contextId);
        $template->setTitle($title);
        $template->setSubject($subject);
        $template->setMessage($message);
        $template->setLang($language);

        $this->repository->store($template);
    }

Here is the call graph for this function:

setAsContextDefault()

ilMailTemplateService::setAsContextDefault

(

\ilMailTemplate

$template

)

Parameters

\ilMailTemplate

$template

Definition at line 130 of file class.ilMailTemplateService.php.

References ilMailTemplate\getContext(), ilMailTemplate\getTplId(), and repository().

    {
        $allOfContext = $this->repository->findByContextId($template->getContext());
        foreach ($allOfContext as $otherTemplate) {
            $otherTemplate->setAsDefault(false);

            if ((int) $template->getTplId() === (int) $otherTemplate->getTplId()) {
                $otherTemplate->setAsDefault(true);
            }

            $this->repository->store($otherTemplate);
        }
    }

Here is the call graph for this function:

unsetAsContextDefault()

ilMailTemplateService::unsetAsContextDefault

(

\ilMailTemplate

$template

)

Parameters

\ilMailTemplate

$template

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

References repository(), and ilMailTemplate\setAsDefault().

    {
        $template->setAsDefault(false);

        $this->repository->store($template);
    }

Here is the call graph for this function:

Field Documentation

$repository

ilMailTemplateService::$repository

protected

Definition at line 12 of file class.ilMailTemplateService.php.

Referenced by __construct().

---

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

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