ilMailTemplateContextDefinitionProcessor Class Reference

Inheritance diagram for ilMailTemplateContextDefinitionProcessor:

Collaboration diagram for ilMailTemplateContextDefinitionProcessor:

Public Member Functions
	__construct (protected ilDBInterface $db)
	purge ()
	This methods is supposed to purge existing data in the provider of the component, so new components can be added to a clean slate. More...
	beginComponent (string $component, string $type)
	This method is called when parsing of component.xml for the given component starts. More...
	endComponent (string $component, string $type)
	This method is called when parsing of component.xml for the given component ends. More...
	beginTag (string $name, array $attributes)
	This is called when a tag starts in the context of the given component. More...
	endTag (string $name)
	This is called when a tag ends in the context of the given component. More...

Protected Attributes
string	$component = null
bool	$in_mailtemplates = false
array	$mail_templates = []

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMailTemplateContextDefinitionProcessor::__construct

(

protected ilDBInterface

$db

)

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

    {
    }

Member Function Documentation

beginComponent()

ilMailTemplateContextDefinitionProcessor::beginComponent	(	string	$component,
		string	$type
	)

This method is called when parsing of component.xml for the given component starts.

This is supposed to reset any internal parsing state.

Implements ilComponentDefinitionProcessor.

Definition at line 39 of file class.ilMailTemplateContextDefinitionProcessor.php.

References $component.

                                                                   : void
    {
        $this->component = $type . '/' . $component;
        $this->in_mailtemplates = false;
        $this->mail_templates = [];
    }

beginTag()

ilMailTemplateContextDefinitionProcessor::beginTag	(	string	$name,
		array	$attributes
	)

This is called when a tag starts in the context of the given component.

Parameters

string[]

$attributes

Implements ilComponentDefinitionProcessor.

Definition at line 53 of file class.ilMailTemplateContextDefinitionProcessor.php.

References $component, ilMailTemplateContextService\insertFromXML(), and null.

                                                             : void
    {
        if ($name === 'mailtemplates') {
            $this->in_mailtemplates = true;
            return;
        }
        if ($name !== 'context' || !$this->in_mailtemplates) {
            return;
        }

        $component = $attributes['component'] ?? null;
        if (!$component) {
            $component = $this->component;
        }

        ilMailTemplateContextService::insertFromXML(
            $component,
            $attributes['id'],
            $attributes['class'],
            $attributes['path'] ?? null
        );
        $this->mail_templates[] = $attributes['id'];
    }

Here is the call graph for this function:

endComponent()

ilMailTemplateContextDefinitionProcessor::endComponent	(	string	$component,
		string	$type
	)

This method is called when parsing of component.xml for the given component ends.

Implements ilComponentDefinitionProcessor.

Definition at line 46 of file class.ilMailTemplateContextDefinitionProcessor.php.

References null.

                                                                 : void
    {
        $this->component = null;
        $this->in_mailtemplates = false;
        $this->mail_templates = [];
    }

endTag()

ilMailTemplateContextDefinitionProcessor::endTag

(

string

$name

)

This is called when a tag ends in the context of the given component.

Implements ilComponentDefinitionProcessor.

Definition at line 77 of file class.ilMailTemplateContextDefinitionProcessor.php.

References ilMailTemplateContextService\clearFromXml().

                                        : void
    {
        if ($name === 'mailtemplates') {
            $this->in_mailtemplates = false;
            return;
        }

        if ($name !== 'module' && $name !== 'service') {
            return;
        }

        ilMailTemplateContextService::clearFromXml($this->component, $this->mail_templates);
    }

Here is the call graph for this function:

purge()

ilMailTemplateContextDefinitionProcessor::purge

(

)

This methods is supposed to purge existing data in the provider of the component, so new components can be added to a clean slate.

Implements ilComponentDefinitionProcessor.

Definition at line 35 of file class.ilMailTemplateContextDefinitionProcessor.php.

                           : void
    {
    }

Field Documentation

$component

string ilMailTemplateContextDefinitionProcessor::$component = null

protected

Definition at line 23 of file class.ilMailTemplateContextDefinitionProcessor.php.

Referenced by beginComponent(), and beginTag().

$in_mailtemplates

bool ilMailTemplateContextDefinitionProcessor::$in_mailtemplates = false

protected

Definition at line 24 of file class.ilMailTemplateContextDefinitionProcessor.php.

$mail_templates

array ilMailTemplateContextDefinitionProcessor::$mail_templates = []

protected

Definition at line 29 of file class.ilMailTemplateContextDefinitionProcessor.php.

---

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

• components/ILIAS/Mail/classes/Setup/class.ilMailTemplateContextDefinitionProcessor.php