SimpleSAML\Utils\Time Class Reference

Collaboration diagram for SimpleSAML\Utils\Time:

Static Public Member Functions
static	generateTimestamp ($instant=null)
	This function generates a timestamp on the form used by the SAML protocols. More...
static	initTimezone ()
	Initialize the timezone. More...
static	parseDuration ($duration, $timestamp=null)
	Interpret a ISO8601 duration value relative to a given timestamp. More...

Static Private Attributes
static	$tz_initialized = false

Detailed Description

Definition at line 12 of file Time.php.

Member Function Documentation

generateTimestamp()

static SimpleSAML\Utils\Time::generateTimestamp (   $instant = null )

static

This function generates a timestamp on the form used by the SAML protocols.

Parameters

int

$instant

The time the timestamp should represent. Defaults to current time.

Returns

string The timestamp.

Author

Olav Morken, UNINETT AS olav..nosp@m.mork.nosp@m.en@un.nosp@m.inet.nosp@m.t.no

Definition at line 31 of file Time.php.

Referenced by SimpleSAML\Bindings\Shib13\Artifact\buildRequest(), SimpleSAML\XML\Shib13\AuthnResponse\generate(), sspmod_adfs_IdP_ADFS\generateResponse(), and SimpleSAML_Utilities\generateTimestamp().

    {
        if ($instant === null) {
            $instant = time();
        }
        return gmdate('Y-m-d\TH:i:s\Z', $instant);
    }

Here is the caller graph for this function:

initTimezone()

static SimpleSAML\Utils\Time::initTimezone ( )

static

Initialize the timezone.

This function should be called before any calls to date().

Author

Olav Morken, UNINETT AS olav..nosp@m.mork.nosp@m.en@un.nosp@m.inet.nosp@m.t.no

Exceptions

Definition at line 51 of file Time.php.

References $globalConfig, SimpleSAML_Configuration\getInstance(), SimpleSAML\Logger\maskErrors(), and SimpleSAML\Logger\popErrorMask().

Referenced by SimpleSAML\Logger\FileLoggingHandler\__construct(), and SimpleSAML_Utilities\initTimezone().

    {
        if (self::$tz_initialized) {
            return;
        }

        $globalConfig = \SimpleSAML_Configuration::getInstance();

        $timezone = $globalConfig->getString('timezone', null);
        if ($timezone !== null) {
            if (!date_default_timezone_set($timezone)) {
                throw new \SimpleSAML_Error_Exception('Invalid timezone set in the "timezone" option in config.php.');
            }
            self::$tz_initialized = true;
            return;
        }
        // we don't have a timezone configured

        Logger::maskErrors(E_ALL);
        $serverTimezone = date_default_timezone_get();
        Logger::popErrorMask();

        // set the timezone to the default
        date_default_timezone_set($serverTimezone);
        self::$tz_initialized = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseDuration()

static SimpleSAML\Utils\Time::parseDuration (   $duration,   $timestamp = null  )

static

Interpret a ISO8601 duration value relative to a given timestamp.

Please note no fractions are allowed, neither durations specified in the formats PYYYYMMDDThhmmss nor P[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss].

Parameters

string	$duration	The duration, as a string.
int	$timestamp	The unix timestamp we should apply the duration to. Optional, default to the current time.

Returns

int The new timestamp, after the duration is applied.

Exceptions

Definition at line 91 of file Time.php.

References $timestamp.

Referenced by SimpleSAML_Utilities\parseDuration().

    {
        if (!(is_string($duration) && (is_int($timestamp) || is_null($timestamp)))) {
            throw new \InvalidArgumentException('Invalid input parameters');
        }

        // parse the duration. We use a very strict pattern
        $durationRegEx = '#^(-?)P(?:(?:(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)D)?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+)'.
            '(?:[.,]\d+)?S)?)?)|(?:(\\d+)W))$#D';
        if (!preg_match($durationRegEx, $duration, $matches)) {
            throw new \InvalidArgumentException('Invalid ISO 8601 duration: '.$duration);
        }

        $durYears = (empty($matches[2]) ? 0 : (int) $matches[2]);
        $durMonths = (empty($matches[3]) ? 0 : (int) $matches[3]);
        $durDays = (empty($matches[4]) ? 0 : (int) $matches[4]);
        $durHours = (empty($matches[5]) ? 0 : (int) $matches[5]);
        $durMinutes = (empty($matches[6]) ? 0 : (int) $matches[6]);
        $durSeconds = (empty($matches[7]) ? 0 : (int) $matches[7]);
        $durWeeks = (empty($matches[8]) ? 0 : (int) $matches[8]);

        if (!empty($matches[1])) {
            // negative
            $durYears = -$durYears;
            $durMonths = -$durMonths;
            $durDays = -$durDays;
            $durHours = -$durHours;
            $durMinutes = -$durMinutes;
            $durSeconds = -$durSeconds;
            $durWeeks = -$durWeeks;
        }

        if ($timestamp === null) {
            $timestamp = time();
        }

        if ($durYears !== 0 || $durMonths !== 0) {
            /* Special handling of months and years, since they aren't a specific interval, but
             * instead depend on the current time.
             */

            /* We need the year and month from the timestamp. Unfortunately, PHP doesn't have the
             * gmtime function. Instead we use the gmdate function, and split the result.
             */
            $yearmonth = explode(':', gmdate('Y:n', $timestamp));
            $year = (int) ($yearmonth[0]);
            $month = (int) ($yearmonth[1]);

            // remove the year and month from the timestamp
            $timestamp -= gmmktime(0, 0, 0, $month, 1, $year);

            // add years and months, and normalize the numbers afterwards
            $year += $durYears;
            $month += $durMonths;
            while ($month > 12) {
                $year += 1;
                $month -= 12;
            }
            while ($month < 1) {
                $year -= 1;
                $month += 12;
            }

            // add year and month back into timestamp
            $timestamp += gmmktime(0, 0, 0, $month, 1, $year);
        }

        // add the other elements
        $timestamp += $durWeeks * 7 * 24 * 60 * 60;
        $timestamp += $durDays * 24 * 60 * 60;
        $timestamp += $durHours * 60 * 60;
        $timestamp += $durMinutes * 60;
        $timestamp += $durSeconds;

        return $timestamp;
    }

Here is the caller graph for this function:

Field Documentation

$tz_initialized

SimpleSAML\Utils\Time::$tz_initialized = false

staticprivate

Definition at line 20 of file Time.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Utils/Time.php