ilMailTemplateService Class Reference

Class ilMailTemplateService. More...

Collaboration diagram for ilMailTemplateService:

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

Static Protected Member Functions
static	getContextInstance ($a_component, $a_id, $a_class, $a_path)
static	createEntry (ilMailTemplateContext $a_context, $a_component, $a_class, $a_path)

Detailed Description

Class ilMailTemplateService.

Author

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

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

Member Function Documentation

clearFromXml()

static ilMailTemplateService::clearFromXml (   $a_component, array  $a_new_templates  )

static

Parameters

string	$a_component
array	$a_new_templates

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

References $DIC, $id, $query, $row, and array.

Referenced by ilObjDefReader\handlerEndTag().

    {
        global $DIC;

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

        $persisted_templates = array();
        $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 (count($persisted_templates)) {
            if (count($a_new_templates)) {
                foreach ($persisted_templates as $id) {
                    if (!in_array($id, $a_new_templates)) {
                        $DIC->database()->manipulate(
                            'DELETE FROM mail_tpl_ctx WHERE component = ' . $DIC->database()->quote($a_component, 'text') . ' AND id = ' . $DIC->database()->quote($id, 'text')
                        );
                        $DIC['ilLog']->debug("Mail Template XML - Context " . $id . " in class " . $a_component . " deleted.");
                    }
                }
            } else {
                $DIC->database()->manipulate('DELETE FROM mail_tpl_ctx WHERE component = ' . $DIC->database()->quote($a_component, 'text'));
                $DIC['ilLog']->debug("Mail Template XML - All contexts deleted for " . $a_component . " as component is inactive.");
            }
        }
    }

Here is the caller graph for this function:

createEntry()

static ilMailTemplateService::createEntry ( ilMailTemplateContext  $a_context,   $a_component,   $a_class,   $a_path  )

staticprotected

Parameters

ilMailTemplateContext	$a_context
string	$a_component
string	$a_class
string	$a_path

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

References $DIC, $query, $res, $row, array, and ilMailTemplateContext\getId().

    {
        global $DIC;

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

        if (!$context_exists) {
            $DIC->database()->insert('mail_tpl_ctx', array(
                'id'        => array('text', $a_context->getId()),
                'component' => array('text', $a_component),
                'class'     => array('text', $a_class),
                'path'      => array('text', $a_path)
            ));

            $DIC['ilLog']->debug("Mail Template  XML - Context " . $a_context->getId() . " in class " . $a_class . " added.");
        } else {
            $DIC->database()->update('mail_tpl_ctx', array(
                'component' => array('text', $a_component),
                'class'     => array('text', $a_class),
                'path'      => array('text', $a_path)
            ), array(
                'id'        => array('text', $a_context->getId())
            ));

            $DIC['ilLog']->debug("Mail Template  XML - Context " . $a_context->getId() . " in class " . $a_class . " updated.");
        }
    }

Here is the call graph for this function:

getContextInstance()

static ilMailTemplateService::getContextInstance (   $a_component,   $a_id,   $a_class,   $a_path  )

staticprotected

Parameters

string	$a_component
string	$a_id
string	$a_class
string	$a_path

Returns

null|ilMailTemplateContext

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

References $DIC.

    {
        global $DIC;

        $mess = '';

        if (!$a_path) {
            $a_path = $a_component . '/classes/';
        }
        $class_file = $a_path . 'class.' . $a_class . '.php';

        if (file_exists($class_file)) {
            require_once $class_file;
            if (class_exists($a_class)) {
                $context = new $a_class();
                if ($context instanceof ilMailTemplateContext) {
                    if ($context->getId() == $a_id) {
                        return $context;
                    } else {
                        $mess .= " - context id mismatch";
                    }
                } else {
                    $mess .= " - does not extend ilMailTemplateContext";
                }
            } else {
                $mess = "- class not found in file";
            }
        } else {
            $mess = " - class file not found";
        }

        $DIC['ilLog']->debug("Mail Template XML - Context " . $a_id . " in class " . $a_class . " (" . $class_file . ") is invalid." . $mess);
    }

getTemplateContextById()

static ilMailTemplateService::getTemplateContextById (   $a_id )

static

Parameters

string

$a_id

Returns

ilMailTemplateContext

Exceptions

ilMailException

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

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

    {
        $contexts      = self::getTemplateContexts($a_id);
        $first_context = current($contexts);
        if (!($first_context instanceof ilMailTemplateContext)  || $first_context->getId() != $a_id) {
            require_once 'Services/Mail/exceptions/class.ilMailException.php';
            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 ilMailTemplateService::getTemplateContexts (   $a_id = null )

static

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

Parameters

null | string | array

$a_id

Returns

ilMailTemplateContext[]

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

References $DIC, $query, $row, and array.

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

    {
        global $DIC;

        $templates = array();

        if ($a_id && !is_array($a_id)) {
            $a_id = array($a_id);
        }

        $query = 'SELECT * FROM mail_tpl_ctx';
        $where = array();
        if ($a_id) {
            $where[] = $DIC->database()->in('id', $a_id, false, 'text');
        }
        if (count($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 ilMailTemplateService::insertFromXML (   $a_component,   $a_id,   $a_class,   $a_path  )

static

Parameters

string	$a_component
string	$a_id
string	$a_class
string	$a_path

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

References $DIC.

Referenced by ilObjDefReader\handlerBeginTag().

    {
        global $DIC;

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

        $context = self::getContextInstance($a_component, $a_id, $a_class, $a_path);
        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:

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