ilCertificateDateHelper Class Reference

Collaboration diagram for ilCertificateDateHelper:

Public Member Functions
	__construct ()
	formatDate ($raw_date_input, ?ilObjUser $user=null, ?int $date_format=null)
	formatDateTime ($raw_datetime_input, ?ilObjUser $user=null, ?int $datetime_format=null)

Private Member Functions
	format ($raw, ?ilObjUser $user, int $format, bool $has_time)
	autoDetectFormat ($value, int $default_when_not_unix)
	assertFormatMatchesInput ($value, int $format)
	isProbablyUnixTimestamp ($maybe_timestamp)

Detailed Description

Definition at line 21 of file ilCertificateDateHelper.php.

Constructor & Destructor Documentation

__construct()

ilCertificateDateHelper::__construct

(

)

Definition at line 23 of file ilCertificateDateHelper.php.

    {
        class_exists('ilDateTime'); // Ensure all global constants are defined
    }

Member Function Documentation

assertFormatMatchesInput()

ilCertificateDateHelper::assertFormatMatchesInput (   $value, int  $format  )

private

Parameters

string | int

$value

Exceptions

InvalidArgumentException

Definition at line 104 of file ilCertificateDateHelper.php.

                                                                  : void
    {
        $is_unix_like = $this->isProbablyUnixTimestamp($value);
 
        if ($format === IL_CAL_UNIX && !$is_unix_like) {
            throw new InvalidArgumentException('Non-numeric input given for IL_CAL_UNIX');
        }
 
        if ($format !== IL_CAL_UNIX && $is_unix_like) {
            throw new InvalidArgumentException('Unix timestamp given but format is not IL_CAL_UNIX');
        }
    }

References IL_CAL_UNIX, and isProbablyUnixTimestamp().

Referenced by format().

Here is the call graph for this function:

Here is the caller graph for this function:

autoDetectFormat()

ilCertificateDateHelper::autoDetectFormat (   $value, int  $default_when_not_unix  )

private

Parameters

string | int

$value

Definition at line 95 of file ilCertificateDateHelper.php.

                                                                         : int
    {
        return $this->isProbablyUnixTimestamp($value) ? IL_CAL_UNIX : $default_when_not_unix;
    }

References IL_CAL_UNIX, and isProbablyUnixTimestamp().

Referenced by formatDate(), and formatDateTime().

Here is the call graph for this function:

Here is the caller graph for this function:

format()

ilCertificateDateHelper::format (   $raw, ?ilObjUser  $user, int  $format, bool  $has_time  )

private

Parameters

int | string

$raw

Exceptions

ilDateTimeException
InvalidArgumentException

Definition at line 63 of file ilCertificateDateHelper.php.

                                                                                : string
    {
        $this->assertFormatMatchesInput($raw, $format);
 
        if ($format === IL_CAL_UNIX) {
            $raw = (int) $raw;
        } else {
            $raw = (string) $raw;
        }
 
        $restore_rel = ilDatePresentation::useRelativeDates();
        ilDatePresentation::setUseRelativeDates(false);
        try {
            $dateObj = $has_time
                ? new ilDateTime($raw, $format)
                : new ilDate($raw, $format);
 
            return ilDatePresentation::formatDate(
                $dateObj,
                false,
                false,
                false,
                $user
            );
        } finally {
            ilDatePresentation::setUseRelativeDates($restore_rel);
        }
    }

References assertFormatMatchesInput(), ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Repository\int(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by formatDate(), and formatDateTime().

Here is the call graph for this function:

Here is the caller graph for this function:

formatDate()

ilCertificateDateHelper::formatDate	(		$raw_date_input,
		?ilObjUser	$user = null,
		?int	$date_format = null
	)

Parameters

string | int

$raw_date_input

Exceptions

ilDateTimeException
InvalidArgumentException

Definition at line 33 of file ilCertificateDateHelper.php.

                                                                                                  : string
    {
        return $this->format(
            $raw_date_input,
            $user,
            $date_format ?? $this->autoDetectFormat($raw_date_input, IL_CAL_DATE),
            false
        );
    }

References autoDetectFormat(), format(), and IL_CAL_DATE.

Referenced by ilCertificateDateHelperTest\testExplicitFormatsWorkAsExpected().

Here is the call graph for this function:

Here is the caller graph for this function:

formatDateTime()

ilCertificateDateHelper::formatDateTime	(		$raw_datetime_input,
		?ilObjUser	$user = null,
		?int	$datetime_format = null
	)

Parameters

string | int

$raw_datetime_input

Exceptions

ilDateTimeException
InvalidArgumentException

Definition at line 48 of file ilCertificateDateHelper.php.

                                                                                                              : string
    {
        return $this->format(
            $raw_datetime_input,
            $user,
            $datetime_format ?? $this->autoDetectFormat($raw_datetime_input, IL_CAL_DATETIME),
            true
        );
    }

References autoDetectFormat(), format(), and IL_CAL_DATETIME.

Here is the call graph for this function:

isProbablyUnixTimestamp()

ilCertificateDateHelper::isProbablyUnixTimestamp (   $maybe_timestamp )

private

Parameters

int | string

$maybe_timestamp

Definition at line 120 of file ilCertificateDateHelper.php.

                                                              : bool
    {
        if (is_int($maybe_timestamp)) {
            return true;
        }
 
        if (!is_string($maybe_timestamp) || !ctype_digit($maybe_timestamp)) {
            return false;
        }
 
        try {
            $datetime = DateTimeImmutable::createFromFormat('Ymd', $maybe_timestamp);
            return $datetime === false;
        } catch (Throwable) {
            // Fallthrough
        }
 
        return true;
    }

References $datetime.

Referenced by assertFormatMatchesInput(), and autoDetectFormat().

Here is the caller graph for this function:

---

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

• components/ILIAS/Certificate/classes/Helper/ilCertificateDateHelper.php