An ilComponentDefinitionProcessor processes some attributes from a component.xml (i.e. More...

Inheritance diagram for ilComponentDefinitionProcessor:

Collaboration diagram for ilComponentDefinitionProcessor:

Public Member Functions
	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...

Detailed Description

An ilComponentDefinitionProcessor processes some attributes from a component.xml (i.e.

a service.xml or module.xml) and puts the information into the according places in the provider of the processor.

Make sure to understand that this is used in the context of processing xml via sax-style parsing. That is, the processor needs to act in a stateful session and react on beginning and ending of tags.

Definition at line 30 of file class.ilComponentDefinitionProcessor.php.

Member Function Documentation

◆ beginComponent()

ilComponentDefinitionProcessor::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.

Implemented in ilCronDefinitionProcessor, ilMailTemplateContextDefinitionProcessor, ilComponentInfoDefinitionProcessor, ilObjectDefinitionProcessor, ilBadgeDefinitionProcessor, ilPDFGenerationDefinitionProcessor, ilEventDefinitionProcessor, ilSecurePathDefinitionProcessor, ilSystemCheckDefinitionProcessor, ilCOPageDefinitionProcessor, and ilLoggingDefinitionProcessor.

◆ beginTag()

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

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

Parameters

string[] $attributes

Implemented in ilCronDefinitionProcessor, ilMailTemplateContextDefinitionProcessor, ilComponentInfoDefinitionProcessor, ilObjectDefinitionProcessor, ilBadgeDefinitionProcessor, ilPDFGenerationDefinitionProcessor, ilEventDefinitionProcessor, ilSystemCheckDefinitionProcessor, ilSecurePathDefinitionProcessor, ilCOPageDefinitionProcessor, and ilLoggingDefinitionProcessor.

◆ endComponent()

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

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

Implemented in ilCronDefinitionProcessor, ilMailTemplateContextDefinitionProcessor, ilComponentInfoDefinitionProcessor, ilObjectDefinitionProcessor, ilBadgeDefinitionProcessor, ilPDFGenerationDefinitionProcessor, ilEventDefinitionProcessor, ilSecurePathDefinitionProcessor, ilSystemCheckDefinitionProcessor, ilCOPageDefinitionProcessor, and ilLoggingDefinitionProcessor.

◆ endTag()

ilComponentDefinitionProcessor::endTag ( string $name )

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

Implemented in ilCronDefinitionProcessor, ilObjectDefinitionProcessor, ilComponentInfoDefinitionProcessor, ilMailTemplateContextDefinitionProcessor, ilBadgeDefinitionProcessor, ilSystemCheckDefinitionProcessor, ilCOPageDefinitionProcessor, ilEventDefinitionProcessor, ilSecurePathDefinitionProcessor, ilPDFGenerationDefinitionProcessor, and ilLoggingDefinitionProcessor.

◆ purge()

ilComponentDefinitionProcessor::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.

Implemented in ilCronDefinitionProcessor, ilMailTemplateContextDefinitionProcessor, ilComponentInfoDefinitionProcessor, ilPDFGenerationDefinitionProcessor, ilBadgeDefinitionProcessor, ilObjectDefinitionProcessor, ilEventDefinitionProcessor, ilSecurePathDefinitionProcessor, ilSystemCheckDefinitionProcessor, ilCOPageDefinitionProcessor, and ilLoggingDefinitionProcessor.

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

Services/Component/classes/class.ilComponentDefinitionProcessor.php