ILIAS\MetaData\DataHelper\DataHelper Class Reference

Inheritance diagram for ILIAS\MetaData\DataHelper\DataHelper:

Collaboration diagram for ILIAS\MetaData\DataHelper\DataHelper:

Public Member Functions
	matchesDurationPattern (string $string)
	matchesDatetimePattern (string $string)
	durationToIterator (string $duration)
	durationToSeconds (string $duration)
	datetimeToIterator (string $datetime)
	datetimeToObject (string $datetime)
	durationFromIntegers (?int $years, ?int $months, ?int $days, ?int $hours, ?int $minutes, ?int $seconds)
	datetimeFromObject (\DateTimeImmutable $object)
	Note that LOM in ILIAS ignores the time part of any datetimes. More...
	getAllLanguages ()

Additional Inherited Members
Data Fields inherited from ILIAS\MetaData\DataHelper\Constants
const string	DURATION_REGEX
	This monstrosity makes sure durations conform to the format given by LOM, and picks out the relevant numbers. More...
Protected Attributes inherited from ILIAS\MetaData\DataHelper\Constants
const string	DATETIME_REGEX
	This monstrosity makes sure datetimes conform to the format given by LOM, and picks out the relevant numbers. More...
const array	LANGUAGES
	Note that 'xx' should be translated to 'none'. More...

Detailed Description

Definition at line 23 of file DataHelper.php.

Member Function Documentation

datetimeFromObject()

ILIAS\MetaData\DataHelper\DataHelper::datetimeFromObject

(

\DateTimeImmutable

$object

)

Note that LOM in ILIAS ignores the time part of any datetimes.

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 136 of file DataHelper.php.

                                                                  : string
    {
        return $object->format('Y-m-d');
    }

datetimeToIterator()

ILIAS\MetaData\DataHelper\DataHelper::datetimeToIterator

(

string

$datetime

)

Returns

string[]|null[]

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 66 of file DataHelper.php.

References ILIAS\MetaData\DataHelper\Constants\DATETIME_REGEX, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

                                                        : \Generator
    {
        if (!preg_match(
            Constants::DATETIME_REGEX,
            $datetime,
            $matches,
            PREG_UNMATCHED_AS_NULL
        )) {
            return;
        }
        yield from array_slice($matches, 1);
    }

Here is the call graph for this function:

datetimeToObject()

ILIAS\MetaData\DataHelper\DataHelper::datetimeToObject

(

string

$datetime

)

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 79 of file DataHelper.php.

References ILIAS\MetaData\DataHelper\Constants\DATETIME_REGEX.

                                                      : \DateTimeImmutable
    {
        preg_match(
            Constants::DATETIME_REGEX,
            $datetime,
            $matches,
            PREG_UNMATCHED_AS_NULL
        );
        return new \DateTimeImmutable(
            ($matches[1] ?? '0000') . '-' .
            ($matches[2] ?? '01') . '-' .
            ($matches[3] ?? '01')
        );
    }

durationFromIntegers()

ILIAS\MetaData\DataHelper\DataHelper::durationFromIntegers	(	?int	$years,
		?int	$months,
		?int	$days,
		?int	$hours,
		?int	$minutes,
		?int	$seconds
	)

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 94 of file DataHelper.php.

     : string {
        $has_time = !is_null($hours) || !is_null($minutes) || !is_null($seconds);

        if (is_null($years) && is_null($months) && is_null($days) && !$has_time) {
            return '';
        }

        $string = 'P';
        if (!is_null($years)) {
            $string .= max($years, 0) . 'Y';
        }
        if (!is_null($months)) {
            $string .= max($months, 0) . 'M';
        }
        if (!is_null($days)) {
            $string .= max($days, 0) . 'D';
        }

        if (!$has_time) {
            return $string;
        }
        $string .= 'T';
        if (!is_null($hours)) {
            $string .= max($hours, 0) . 'H';
        }
        if (!is_null($minutes)) {
            $string .= max($minutes, 0) . 'M';
        }
        if (!is_null($seconds)) {
            $string .= max($seconds, 0) . 'S';
        }

        return $string;
    }

durationToIterator()

ILIAS\MetaData\DataHelper\DataHelper::durationToIterator

(

string

$duration

)

Returns

string[]|null[]

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 38 of file DataHelper.php.

References ILIAS\MetaData\DataHelper\Constants\DURATION_REGEX, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by ILIAS\MetaData\DataHelper\DataHelper\durationToSeconds().

                                                        : \Generator
    {
        if (!preg_match(
            Constants::DURATION_REGEX,
            $duration,
            $matches,
            PREG_UNMATCHED_AS_NULL
        )) {
            return;
        }
        yield from array_slice($matches, 1);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

durationToSeconds()

ILIAS\MetaData\DataHelper\DataHelper::durationToSeconds

(

string

$duration

)

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 51 of file DataHelper.php.

References ILIAS\MetaData\DataHelper\DataHelper\durationToIterator().

                                                       : int
    {
        $factors = [1, 12, 30, 24, 60, 60];
        $factor_index = 0;
        $result = 0;
        foreach ($this->durationToIterator($duration) as $number) {
            $result = $factors[$factor_index] * $result + $number;
            $factor_index++;
        }
        return $result;
    }

Here is the call graph for this function:

getAllLanguages()

ILIAS\MetaData\DataHelper\DataHelper::getAllLanguages

(

)

Returns

string[]

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 144 of file DataHelper.php.

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from(), and ILIAS\MetaData\DataHelper\Constants\LANGUAGES.

                                     : \Generator
    {
        yield from Constants::LANGUAGES;
    }

Here is the call graph for this function:

matchesDatetimePattern()

ILIAS\MetaData\DataHelper\DataHelper::matchesDatetimePattern

(

string

$string

)

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 30 of file DataHelper.php.

References ILIAS\MetaData\DataHelper\Constants\DATETIME_REGEX.

                                                          : bool
    {
        return (bool) preg_match(Constants::DATETIME_REGEX, $string);
    }

matchesDurationPattern()

ILIAS\MetaData\DataHelper\DataHelper::matchesDurationPattern

(

string

$string

)

Implements ILIAS\MetaData\DataHelper\DataHelperInterface.

Definition at line 25 of file DataHelper.php.

References ILIAS\MetaData\DataHelper\Constants\DURATION_REGEX.

                                                          : bool
    {
        return (bool) preg_match(Constants::DURATION_REGEX, $string);
    }

---

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

• components/ILIAS/MetaData/classes/DataHelper/DataHelper.php