ilCronDefinitionProcessor Class Reference

Inheritance diagram for ilCronDefinitionProcessor:

Collaboration diagram for ilCronDefinitionProcessor:

Public Member Functions
	__construct (private readonly ilDBInterface $db, ilSetting $setting, ilComponentRepository $componentRepository, ilComponentFactory $componentFactory)
	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 ilCronJobRepository	$cronRepository
string	$component = null
array	$has_cron

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilCronDefinitionProcessor::__construct	(	private readonly ilDBInterface	$db,
		ilSetting	$setting,
		ilComponentRepository	$componentRepository,
		ilComponentFactory	$componentFactory
	)

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

      {
        $this->has_cron = [];

        $this->cronRepository = new ilCronJobRepositoryImpl(
            $this->db,
            $setting,
            new NullLogger(),
            $componentRepository,
            $componentFactory
        );
    }

Member Function Documentation

beginComponent()

ilCronDefinitionProcessor::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 51 of file class.ilCronDefinitionProcessor.php.

References $component.

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

beginTag()

ilCronDefinitionProcessor::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 63 of file class.ilCronDefinitionProcessor.php.

References $component.

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

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

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

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

endComponent()

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

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

Implements ilComponentDefinitionProcessor.

Definition at line 57 of file class.ilCronDefinitionProcessor.php.

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

endTag()

ilCronDefinitionProcessor::endTag

(

string

$name

)

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

Implements ilComponentDefinitionProcessor.

Definition at line 84 of file class.ilCronDefinitionProcessor.php.

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

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

purge()

ilCronDefinitionProcessor::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 47 of file class.ilCronDefinitionProcessor.php.

                           : void
    {
    }

Field Documentation

$component

string ilCronDefinitionProcessor::$component = null

private

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

Referenced by beginComponent(), and beginTag().

$cronRepository

readonly ilCronJobRepository ilCronDefinitionProcessor::$cronRepository

private

Definition at line 25 of file class.ilCronDefinitionProcessor.php.

$has_cron

array ilCronDefinitionProcessor::$has_cron

private

Definition at line 28 of file class.ilCronDefinitionProcessor.php.

---

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

• components/ILIAS/Cron/classes/Setup/class.ilCronDefinitionProcessor.php