ilMailTemplateContextService Class Reference

Collaboration diagram for ilMailTemplateContextService:

Static Public Member Functions
static	clearFromXml (string $a_component, array $a_new_templates)
static	insertFromXML (string $a_component, string $a_id, string $a_class, ?string $a_path)
static	getTemplateContextById (string $a_id)
static	getTemplateContexts (?array $a_id=null)
	Returns an array of mail template contexts, the key of each entry matches its id. More...

Static Private Member Functions
static	getContextInstance (string $a_component, string $a_id, string $a_class, ?string $a_path, bool $isCreationContext=false)
static	createEntry (ilMailTemplateContext $a_context, string $a_component, string $a_class, ?string $a_path)

Detailed Description

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

Member Function Documentation

clearFromXml()

static ilMailTemplateContextService::clearFromXml ( string  $a_component, array  $a_new_templates  )

static

Parameters

string[]

$a_new_templates

Definition at line 26 of file class.ilMailTemplateContextService.php.

References $DIC, and $id.

Referenced by ilMailTemplateContextDefinitionProcessor\endTag().

                                                                                    : void
    {
        global $DIC;
        if (!$DIC->database()->tableExists('mail_tpl_ctx')) {
            return;
        }
        $persisted_templates = [];
        $query = 'SELECT id FROM mail_tpl_ctx WHERE component = ' . $DIC->database()->quote($a_component, 'text');
        $set = $DIC->database()->query($query);
        while ($row = $DIC->database()->fetchAssoc($set)) {
            $persisted_templates[] = $row['id'];
        }

        if ($persisted_templates !== []) {
            if ($a_new_templates !== []) {
                foreach ($persisted_templates as $id) {
                    if (!in_array($id, $a_new_templates, true)) {
                        $DIC->database()->manipulate(
                            'DELETE FROM mail_tpl_ctx WHERE component = ' . $DIC->database()->quote(
                                $a_component,
                                'text'
                            ) . ' AND id = ' . $DIC->database()->quote($id, 'text')
                        );
                    }
                }
            } else {
                $DIC->database()->manipulate(
                    'DELETE FROM mail_tpl_ctx WHERE component = ' . $DIC->database()->quote(
                        $a_component,
                        'text'
                    )
                );
            }
        }
    }

Here is the caller graph for this function:

createEntry()

static ilMailTemplateContextService::createEntry ( ilMailTemplateContext  $a_context, string  $a_component, string  $a_class, ?string  $a_path  )

staticprivate

Parameters

class-string

$a_class

Definition at line 149 of file class.ilMailTemplateContextService.php.

References $DIC, $res, ilMailTemplateContext\getId(), and null.

     : void {
        global $DIC;

        $query = 'SELECT id FROM mail_tpl_ctx WHERE id = %s';
        $res = $DIC->database()->queryF($query, ['text'], [$a_context->getId()]);
        $row = $DIC->database()->fetchAssoc($res);
        $row_id = $row['id'] ?? null;
        $context_exists = ($row_id === $a_context->getId());

        if ($context_exists) {
            $DIC->database()->update('mail_tpl_ctx', [
                'component' => ['text', $a_component],
                'class' => ['text', $a_class],
                'path' => ['text', $a_path]
            ], [
                'id' => ['text', $a_context->getId()]
            ]);
        } else {
            $DIC->database()->insert('mail_tpl_ctx', [
                'id' => ['text', $a_context->getId()],
                'component' => ['text', $a_component],
                'class' => ['text', $a_class],
                'path' => ['text', $a_path]
            ]);
        }
    }

Here is the call graph for this function:

getContextInstance()

static ilMailTemplateContextService::getContextInstance ( string  $a_component, string  $a_id, string  $a_class, ?string  $a_path, bool  $isCreationContext = false  )

staticprivate

Parameters

class-string

$a_class

Definition at line 123 of file class.ilMailTemplateContextService.php.

References $context, and null.

     : ?ilMailTemplateContext {
        if (class_exists($a_class)) {
            if ($isCreationContext) {
                $reflClass = new ReflectionClass($a_class);
                $context = $reflClass->newInstanceWithoutConstructor();
            } else {
                $context = new $a_class();
            }

            if (($context instanceof ilMailTemplateContext) && $context->getId() === $a_id) {
                return $context;
            }
        }

        return null;
    }

getTemplateContextById()

static ilMailTemplateContextService::getTemplateContextById ( string  $a_id )

static

Exceptions

ilMailException

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

Referenced by ilMailTemplateGUI\getAjaxPlaceholdersById(), ilMailFormGUI\getTemplateDataById(), ilMailTemplateGUI\getTemplateForm(), ilMailTemplateGUI\insertTemplate(), ilMail\replacePlaceholders(), ilExAssignmentReminder\sentReminderPlaceholders(), ilObjSurvey\sentReminderPlaceholders(), ilMailFormGUI\showForm(), and ilMailTemplateGUI\updateTemplate().

                                                               : ilMailTemplateContext
    {
        $contexts = self::getTemplateContexts([$a_id]);
        $first_context = current($contexts);
        if (!($first_context instanceof ilMailTemplateContext) || $first_context->getId() !== $a_id) {
            throw new ilMailException(sprintf('Could not find a mail template context with id: %s', $a_id));
        }

        return $first_context;
    }

Here is the caller graph for this function:

getTemplateContexts()

static ilMailTemplateContextService::getTemplateContexts ( ?array  $a_id = null )

static

Returns an array of mail template contexts, the key of each entry matches its id.

Parameters

string[]

$a_id

Returns

array<string, ilMailTemplateContext>

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

References $context, and $DIC.

Referenced by ilMailTemplateTableGUI\__construct(), ilMailTemplateGUI\getTemplateForm(), and ilMailTemplateGUI\showTemplates().

                                                                   : array
    {
        global $DIC;
        $templates = [];

        $query = 'SELECT * FROM mail_tpl_ctx';
        $where = [];
        if (is_array($a_id) && count($a_id)) {
            $where[] = $DIC->database()->in('id', $a_id, false, 'text');
        }
        if ($where !== []) {
            $query .= ' WHERE ' . implode(' AND ', $where);
        }

        $set = $DIC->database()->query($query);
        while ($row = $DIC->database()->fetchAssoc($set)) {
            $context = self::getContextInstance($row['component'], $row['id'], $row['class'], $row['path']);
            if ($context instanceof ilMailTemplateContext) {
                $templates[$context->getId()] = $context;
            }
        }

        return $templates;
    }

Here is the caller graph for this function:

insertFromXML()

static ilMailTemplateContextService::insertFromXML ( string  $a_component, string  $a_id, string  $a_class, ?string  $a_path  )

static

Definition at line 62 of file class.ilMailTemplateContextService.php.

References $context, and $DIC.

Referenced by ilMailTemplateContextDefinitionProcessor\beginTag().

                                                                                                             : void
    {
        global $DIC;

        if (!$DIC->database()->tableExists('mail_tpl_ctx')) {
            return;
        }

        $context = self::getContextInstance($a_component, $a_id, $a_class, $a_path, true);
        if ($context instanceof ilMailTemplateContext) {
            self::createEntry($context, $a_component, $a_class, $a_path);
        }
    }

Here is the caller graph for this function:

---

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

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