ILIAS\Setup\DefinitionProcessor Class Reference

Inheritance diagram for ILIAS\Setup\DefinitionProcessor:

Collaboration diagram for ILIAS\Setup\DefinitionProcessor:

Public Member Functions
	__construct (private readonly \ilDBInterface $db, \ilSetting $setting, \ilComponentRepository $component_repository, \ilComponentFactory $component_factory)
	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...

Private Attributes
readonly JobRepository	$job_repository
string	$component = null
array	$has_cron

Detailed Description

Definition at line 26 of file DefinitionProcessor.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Setup\DefinitionProcessor::__construct	(	private readonly \ilDBInterface	$db,
		\ilSetting	$setting,
		\ilComponentRepository	$component_repository,
		\ilComponentFactory	$component_factory
	)

Definition at line 33 of file DefinitionProcessor.php.

      {
        $this->has_cron = [];

        $this->job_repository = new JobRepositoryImpl(
            $this->db,
            $setting,
            new \ILIAS\components\Logging\NullLogger(),
            $component_repository,
            $component_factory
        );
    }

Member Function Documentation

beginComponent()

ILIAS\Setup\DefinitionProcessor::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 54 of file DefinitionProcessor.php.

References ILIAS\Setup\DefinitionProcessor\$component.

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

beginTag()

ILIAS\Setup\DefinitionProcessor::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 66 of file DefinitionProcessor.php.

References ILIAS\Setup\DefinitionProcessor\$component, and null.

                                                             : void
    {
        if ($name !== 'cron') {
            return;
        }

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

        $this->job_repository->registerJob(
            $component,
            $attributes['id'],
            $attributes['class'],
            ($attributes['path'] ?? null)
        );

        $this->has_cron[] = $attributes['id'];
    }

endComponent()

ILIAS\Setup\DefinitionProcessor::endComponent	(	string	$component,
		string	$type
	)

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

Implements ilComponentDefinitionProcessor.

Definition at line 60 of file DefinitionProcessor.php.

References null.

                                                                 : void
    {
        $this->component = null;
        $this->has_cron = [];
    }

endTag()

ILIAS\Setup\DefinitionProcessor::endTag

(

string

$name

)

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

Implements ilComponentDefinitionProcessor.

Definition at line 87 of file DefinitionProcessor.php.

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

        $this->job_repository->unregisterJob($this->component, $this->has_cron);
    }

purge()

ILIAS\Setup\DefinitionProcessor::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 50 of file DefinitionProcessor.php.

                           : void
    {
    }

Field Documentation

$component

string ILIAS\Setup\DefinitionProcessor::$component = null

private

Definition at line 29 of file DefinitionProcessor.php.

Referenced by ILIAS\Setup\DefinitionProcessor\beginComponent(), and ILIAS\Setup\DefinitionProcessor\beginTag().

$has_cron

array ILIAS\Setup\DefinitionProcessor::$has_cron

private

Definition at line 31 of file DefinitionProcessor.php.

$job_repository

readonly JobRepository ILIAS\Setup\DefinitionProcessor::$job_repository

private

Definition at line 28 of file DefinitionProcessor.php.

---

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

• components/ILIAS/Cron/src/Setup/DefinitionProcessor.php