Handles interactions with SSP's cron system/hooks. More...

Collaboration diagram for SimpleSAML\Module\cron\Cron:

Public Member Functions
	__construct (\SimpleSAML_Configuration $cronconfig=null)

	runTag ($tag)
	Invoke the cron hook for the given tag. More...

	isValidTag ($tag)

Private Attributes
	$cronconfig

Detailed Description

Handles interactions with SSP's cron system/hooks.

Definition at line 8 of file Cron.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleSAML\Module\cron\Cron::__construct ( \SimpleSAML_Configuration $cronconfig = null )

Definition at line 20 of file Cron.php.

References SimpleSAML\Module\cron\Cron\$cronconfig, and SimpleSAML_Configuration\getConfig().

     {
         if ($cronconfig == null) {
             $cronconfig = \SimpleSAML_Configuration::getConfig('module_cron.php');
         }
         $this->cronconfig = $cronconfig;
     }

Here is the call graph for this function:

Member Function Documentation

◆ isValidTag()

SimpleSAML\Module\cron\Cron::isValidTag ( $tag )

Definition at line 56 of file Cron.php.

References $tag.

Referenced by SimpleSAML\Module\cron\Cron\runTag().

     {
         if (!is_null($this->cronconfig->getValue('allowed_tags'))) {
             return in_array($tag, $this->cronconfig->getArray('allowed_tags'), true);
         }
         return true;
     }

Here is the caller graph for this function:

◆ runTag()

SimpleSAML\Module\cron\Cron::runTag ( $tag )

Invoke the cron hook for the given tag.

Parameters

$tag	string The tag to use. Must be valid in the cronConfig

Returns: array the tag, and summary information from the run.

Exceptions

Exception If an invalid tag specified

Definition at line 34 of file Cron.php.

References $croninfo, $s, $summary, $tag, array, SimpleSAML\Module\callHooks(), SimpleSAML\Logger\debug(), and SimpleSAML\Module\cron\Cron\isValidTag().

     {
 
         if (!$this->isValidTag($tag)) {
             throw new \Exception("Invalid cron tag '$tag''");
         }
 
         $summary = array();
         $croninfo = array(
             'summary' => &$summary,
             'tag' => $tag,
         );
 
         \SimpleSAML\Module::callHooks('cron', $croninfo);
 
         foreach ($summary as $s) {
             \SimpleSAML\Logger::debug('Cron - Summary: ' . $s);
         }
 
         return $croninfo;
     }

Here is the call graph for this function:

Field Documentation

◆ $cronconfig

SimpleSAML\Module\cron\Cron::$cronconfig

private

Definition at line 14 of file Cron.php.

Referenced by SimpleSAML\Module\cron\Cron\__construct().

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

libs/composer/vendor/simplesamlphp/simplesamlphp/modules/cron/lib/Cron.php

Public Member Functions

Private Attributes