Cron.php

Go to the documentation of this file.

<?php

namespace  SimpleSAML\Module\cron;

class Cron
{
    private $cronconfig;

    /*
     * @param \SimpleSAML_Configuration $cronconfig The cron configuration to use. If not specified defaults
     * to `config/module_cron.php`
     */
    public function __construct(\SimpleSAML_Configuration $cronconfig = null)
    {
        if ($cronconfig == null) {
            $cronconfig = \SimpleSAML_Configuration::getConfig('module_cron.php');
        }
        $this->cronconfig = $cronconfig;
    }

    public function runTag($tag)
    {

        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;
    }

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