ILIAS\Mail\TemplateEngine\MailTemplateContextAdapter Class Reference

This class forms an interface between the existing ILIAS mail contexts and the requirements of the template engine. More...

Collaboration diagram for ILIAS\Mail\TemplateEngine\MailTemplateContextAdapter:

Public Member Functions
	withContext (ilMailTemplateContext $context)
	__isset (string $name)
	__get (string $name)

Detailed Description

This class forms an interface between the existing ILIAS mail contexts and the requirements of the template engine.

In the old system, it was possible to gradually replace individual placeholders via the contexts. This is now done by the template engine and requires a single source. If a placeholder does not exist in this source, then it will be replaced with NULL. Mustache takes two steps to find the placeholder. On the one hand the check whether it would be theoretically possible and the actual query for the value if the check is successful. This is done in this class using the two magic methods. With the introduction of this interface, the ILIAS mail contexts do not have to be changed for the template engine.

Definition at line 35 of file MailTemplateContextAdapter.php.

Member Function Documentation

__get()

ILIAS\Mail\TemplateEngine\MailTemplateContextAdapter::__get

(

string

$name

)

Definition at line 70 of file MailTemplateContextAdapter.php.

                                       : string
    {
        foreach ($this->contexts as $context) {
            $ret = $context->resolvePlaceholder($name, $this->context_parameter, $this->recipient);
            if (\in_array($name, $context->getNestedPlaceholders(), true)) {
                $ret = $this->template_engine->render($ret, $this);
            }
            if ($ret !== '') {
                return $ret;
            }
        }
 
        return '';
    }

__isset()

ILIAS\Mail\TemplateEngine\MailTemplateContextAdapter::__isset

(

string

$name

)

Definition at line 53 of file MailTemplateContextAdapter.php.

                                         : bool
    {
        foreach ($this->contexts as $context) {
            $possible_placeholder = array_map(
                static function ($placeholder): string {
                    return strtoupper($placeholder);
                },
                array_keys($context->getPlaceholders())
            );
            if (\in_array($name, $possible_placeholder, true)) {
                return true;
            }
        }
 
        return false;
    }

withContext()

ILIAS\Mail\TemplateEngine\MailTemplateContextAdapter::withContext

(

ilMailTemplateContext

$context

)

Definition at line 46 of file MailTemplateContextAdapter.php.

                                                               : self
    {
        $clone = clone $this;
        $clone->contexts[] = $context;
        return $clone;
    }

---

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

• components/ILIAS/Mail/src/TemplateEngine/MailTemplateContextAdapter.php