ilMailTemplateService Class Reference

Inheritance diagram for ilMailTemplateService:

Collaboration diagram for ilMailTemplateService:

Public Member Functions
	__construct (protected ilMailTemplateRepository $repository, protected TemplateEngineFactoryInterface $template_engine_factory)
	createNewTemplate (string $context_id, string $title, string $subject, string $message, string $language)
	modifyExistingTemplate (int $template_id, string $context_id, string $title, string $subject, string $message, string $language)
	loadTemplateForId (int $template_id)
	loadTemplatesForContextId (string $context_id)
	deleteTemplatesByIds (array $template_ids)
	listAllTemplatesAsArray ()
	unsetAsContextDefault (ilMailTemplate $template)
	setAsContextDefault (ilMailTemplate $template)
	createNewTemplate (string $context_id, string $title, string $subject, string $message, string $language)
	modifyExistingTemplate (int $template_id, string $context_id, string $title, string $subject, string $message, string $language)
	loadTemplateForId (int $template_id)
	loadTemplatesForContextId (string $context_id)
	deleteTemplatesByIds (array $template_ids)
	listAllTemplatesAsArray ()
	unsetAsContextDefault (ilMailTemplate $template)
	setAsContextDefault (ilMailTemplate $template)

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailTemplateService::__construct	(	protected ilMailTemplateRepository	$repository,
		protected TemplateEngineFactoryInterface	$template_engine_factory
	)

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

      {
    }

Member Function Documentation

createNewTemplate()

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

Implements ilMailTemplateServiceInterface.

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

     : ilMailTemplate {
        try {
            $this->template_engine_factory->getBasicEngine()->render($subject, []);
        } catch (Exception) {
            throw new TemplateSubjectSyntaxException('Invalid mail template for subject');
        }
 
        try {
            $this->template_engine_factory->getBasicEngine()->render($message, []);
        } catch (Exception) {
            throw new TemplateMessageSyntaxException('Invalid mail template for message');
        }
 
        $template = new ilMailTemplate();
        $template->setContext($context_id);
        $template->setTitle($title);
        $template->setSubject($subject);
        $template->setMessage($message);
        $template->setLang($language);
 
        $this->repository->store($template);
 
        return $template;
    }

deleteTemplatesByIds()

ilMailTemplateService::deleteTemplatesByIds

(

array

$template_ids

)

Parameters

list<int>

$template_ids

Implements ilMailTemplateServiceInterface.

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

                                                             : void
    {
        $this->repository->deleteByIds($template_ids);
    }

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

listAllTemplatesAsArray()

ilMailTemplateService::listAllTemplatesAsArray

(

)

Returns

list<array<string, mixed>>

Implements ilMailTemplateServiceInterface.

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

                                             : array
    {
        $templates = $this->repository->getAll();
 
        return array_map(static fn(ilMailTemplate $template): array => $template->toArray(), $templates);
    }

References ILIAS\UI\examples\Deck\repository(), and ilMailTemplate\toArray().

Here is the call graph for this function:

loadTemplateForId()

ilMailTemplateService::loadTemplateForId

(

int

$template_id

)

Implements ilMailTemplateServiceInterface.

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

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

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

loadTemplatesForContextId()

ilMailTemplateService::loadTemplatesForContextId

(

string

$context_id

)

Returns

list<ilMailTemplate>

Implements ilMailTemplateServiceInterface.

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

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

References ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

modifyExistingTemplate()

ilMailTemplateService::modifyExistingTemplate	(	int	$template_id,
		string	$context_id,
		string	$title,
		string	$subject,
		string	$message,
		string	$language
	)

Exceptions

TemplateSubjectSyntaxException|TemplateMessageSyntaxException

Implements ilMailTemplateServiceInterface.

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

     : void {
        try {
            $this->template_engine_factory->getBasicEngine()->render($subject, []);
        } catch (Exception) {
            throw new TemplateSubjectSyntaxException('Invalid mail template for subject');
        }
 
        try {
            $this->template_engine_factory->getBasicEngine()->render($message, []);
        } catch (Exception) {
            throw new TemplateMessageSyntaxException('Invalid mail template for message');
        }
 
        $template = $this->repository->findById($template_id);
 
        $template->setContext($context_id);
        $template->setTitle($title);
        $template->setSubject($subject);
        $template->setMessage($message);
        $template->setLang($language);
 
        $this->repository->store($template);
    }

setAsContextDefault()

ilMailTemplateService::setAsContextDefault

(

ilMailTemplate

$template

)

Implements ilMailTemplateServiceInterface.

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

                                                                 : void
    {
        $all_of_context = $this->repository->findByContextId($template->getContext());
        foreach ($all_of_context as $other_template) {
            $other_template->setAsDefault(false);
 
            if ($template->getTplId() === $other_template->getTplId()) {
                $other_template->setAsDefault(true);
            }
 
            $this->repository->store($other_template);
        }
    }

References ilMailTemplate\getContext(), ilMailTemplate\getTplId(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

unsetAsContextDefault()

ilMailTemplateService::unsetAsContextDefault

(

ilMailTemplate

$template

)

Implements ilMailTemplateServiceInterface.

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

                                                                   : void
    {
        $template->setAsDefault(false);
 
        $this->repository->store($template);
    }

References ILIAS\UI\examples\Deck\repository(), and ilMailTemplate\setAsDefault().

Here is the call graph for this function:

---

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

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