ilCronDefinitionProcessor Class Reference

Inheritance diagram for ilCronDefinitionProcessor:

Collaboration diagram for ilCronDefinitionProcessor:

Public Member Functions
	__construct (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
ilDBInterface	$db
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	(	ilDBInterface	$db,
		ilSetting	$setting,
		ilComponentRepository	$componentRepository,
		ilComponentFactory	$componentFactory
	)

PhpInconsistentReturnPointsInspection

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

References $db, ILIAS\UI\examples\MessageBox\Info\info(), and ilLogLevel\INFO.

      {
        $this->db = $db;
        $this->has_cron = [];

        $this->cronRepository = new ilCronJobRepositoryImpl(
            $this->db,
            $setting,
            new class () extends ilLogger {
                public function __construct()
                {
                }

                public function isHandling(int $a_level): bool
                {
                    return false;
                }

                public function log(string $a_message, int $a_level = ilLogLevel::INFO): void
                {
                }

                public function dump($a_variable, int $a_level = ilLogLevel::INFO): void
                {
                }

                public function debug(string $a_message, array $a_context = []): void
                {
                }

                public function info(string $a_message): void
                {
                }

                public function notice(string $a_message): void
                {
                }

                public function warning(string $a_message): void
                {
                }

                public function error(string $a_message): void
                {
                }

                public function critical(string $a_message): void
                {
                }

                public function alert(string $a_message): void
                {
                }

                public function emergency(string $a_message): void
                {
                }

                public function getLogger(): Logger
                {
                }

                public function write(string $a_message, $a_level = ilLogLevel::INFO): void
                {
                }

                public function writeLanguageLog(string $a_topic, string $a_lang_key): void
                {
                }

                public function logStack(?int $a_level = null, string $a_message = ''): void
                {
                }

                public function writeMemoryPeakUsage(int $a_level): void
                {
                }
            },
            $componentRepository,
            $componentFactory
        );
    }

Here is the call graph for this function:

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 123 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 135 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 129 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 156 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 119 of file class.ilCronDefinitionProcessor.php.

                           : void
    {
    }

Field Documentation

$component

string ilCronDefinitionProcessor::$component = null

private

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

Referenced by beginComponent(), and beginTag().

$cronRepository

ilCronJobRepository ilCronDefinitionProcessor::$cronRepository

private

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

$db

ilDBInterface ilCronDefinitionProcessor::$db

private

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

Referenced by __construct().

$has_cron

array ilCronDefinitionProcessor::$has_cron

private

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

---

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

• Services/Cron/classes/Setup/class.ilCronDefinitionProcessor.php