ILIAS\MetaData\Services\DataHelper\DataHelper Class Reference

Inheritance diagram for ILIAS\MetaData\Services\DataHelper\DataHelper:

Collaboration diagram for ILIAS\MetaData\Services\DataHelper\DataHelper:

Public Member Functions
	__construct (InternalDataHelper $internal_helper, DataPresentation $data_presentation)
	makePresentable (DataInterface $data)
	makePresentableAsList (string $separator, DataInterface ... $data)
	durationToArray (string $duration)
	durationToSeconds (string $duration)
	Translates strings in the LOM-internal duration format to seconds. More...
	datetimeToObject (string $datetime)
	Translates strings in the LOM-internal datetime format to datetime objects. More...
	durationFromIntegers (?int $years, ?int $months, ?int $days, ?int $hours, ?int $minutes, ?int $seconds)
	Get a string in the LOM-internal duration format as specified by the provided integers. More...
	datetimeFromObject (\DateTimeImmutable $object)
	Translates datetime objects to strings in the LOM-internal datetime format. More...
	getAllLanguages ()

Protected Attributes
InternalDataHelper	$internal_helper
DataPresentation	$data_presentation

Detailed Description

Definition at line 27 of file DataHelper.php.

Constructor & Destructor Documentation

__construct()

ILIAS\MetaData\Services\DataHelper\DataHelper::__construct	(	InternalDataHelper	$internal_helper,
		DataPresentation	$data_presentation
	)

Definition at line 32 of file DataHelper.php.

References ILIAS\MetaData\Services\DataHelper\DataHelper\$data_presentation, and ILIAS\MetaData\Services\DataHelper\DataHelper\$internal_helper.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelperTest\getData().

      {
        $this->data_presentation = $data_presentation;
        $this->internal_helper = $internal_helper;
    }

Here is the caller graph for this function:

Member Function Documentation

datetimeFromObject()

ILIAS\MetaData\Services\DataHelper\DataHelper::datetimeFromObject

(

\DateTimeImmutable

$object

)

Translates datetime objects to strings in the LOM-internal datetime format.

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

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 94 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelperTest\getDataHelper().

                                                                  : string
    {
        return $this->internal_helper->datetimeFromObject($object);
    }

Here is the caller graph for this function:

datetimeToObject()

ILIAS\MetaData\Services\DataHelper\DataHelper::datetimeToObject

(

string

$datetime

)

Translates strings in the LOM-internal datetime format to datetime objects.

Note that LOM datetimes in ILIAS only consist of a date, without a time.

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 71 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelperTest\getDataHelper().

                                                      : \DateTimeImmutable
    {
        return $this->internal_helper->datetimeToObject($datetime);
    }

Here is the caller graph for this function:

durationFromIntegers()

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

Get a string in the LOM-internal duration format as specified by the provided integers.

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 76 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelperTest\getDataHelper().

     : string {
        return $this->internal_helper->durationFromIntegers(
            $years,
            $months,
            $days,
            $hours,
            $minutes,
            $seconds
        );
    }

Here is the caller graph for this function:

durationToArray()

ILIAS\MetaData\Services\DataHelper\DataHelper::durationToArray

(

string

$duration

)

Returns

int[]|null[]

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 57 of file DataHelper.php.

References ILIAS\Repository\int().

                                                     : array
    {
        $array = [];
        foreach ($this->internal_helper->durationToIterator($duration) as $value) {
            $array[] = is_null($value) ? $value : (int) $value;
        }
        return $array;
    }

Here is the call graph for this function:

durationToSeconds()

ILIAS\MetaData\Services\DataHelper\DataHelper::durationToSeconds

(

string

$duration

)

Translates strings in the LOM-internal duration format to seconds.

This is only a rough estimate, as LOM-durations do not have a start date, so e.g. each month is treated as 30 days.

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 66 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelperTest\getDataHelper().

                                                       : int
    {
        return $this->internal_helper->durationToSeconds($duration);
    }

Here is the caller graph for this function:

getAllLanguages()

ILIAS\MetaData\Services\DataHelper\DataHelper::getAllLanguages

(

)

Returns

LabelledValueInterface[]

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 102 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelperTest\getDataHelper().

                                     : array
    {
        $languages = [];
        foreach ($this->internal_helper->getAllLanguages() as $language) {
            $languages[] = new LabelledValue(
                $language,
                $this->data_presentation->language($language)
            );
        }
        return $languages;
    }

Here is the caller graph for this function:

makePresentable()

ILIAS\MetaData\Services\DataHelper\DataHelper::makePresentable

(

DataInterface

$data

)

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 40 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelper\makePresentableAsList().

                                                        : string
    {
        return $this->data_presentation->dataValue($data);
    }

Here is the caller graph for this function:

makePresentableAsList()

ILIAS\MetaData\Services\DataHelper\DataHelper::makePresentableAsList	(	string	$separator,
		DataInterface ...	$data
	)

Implements ILIAS\MetaData\Services\DataHelper\DataHelperInterface.

Definition at line 45 of file DataHelper.php.

References ILIAS\MetaData\Services\DataHelper\DataHelper\makePresentable().

                                                                                    : string
    {
        $presentable = [];
        foreach ($data as $datum) {
            $presentable[] = $this->makePresentable($datum);
        }
        return implode($separator, $presentable);
    }

Here is the call graph for this function:

Field Documentation

$data_presentation

DataPresentation ILIAS\MetaData\Services\DataHelper\DataHelper::$data_presentation

protected

Definition at line 30 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelper\__construct(), and ILIAS\MetaData\Services\DataHelper\DataHelperTest\getDataHelper().

$internal_helper

InternalDataHelper ILIAS\MetaData\Services\DataHelper\DataHelper::$internal_helper

protected

Definition at line 29 of file DataHelper.php.

Referenced by ILIAS\MetaData\Services\DataHelper\DataHelper\__construct(), and ILIAS\MetaData\Services\DataHelper\DataHelperTest\getDataHelper().

---

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

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