ilTermsOfServiceAcceptanceHistoryCriteriaBag Class Reference

Class ilTermsOfServiceAcceptanceHistoryCriteriaBag. More...

Inheritance diagram for ilTermsOfServiceAcceptanceHistoryCriteriaBag:

Collaboration diagram for ilTermsOfServiceAcceptanceHistoryCriteriaBag:

Public Member Functions
	__construct ($data=[])
	ilTermsOfServiceAcceptanceHistoryCriteriaBag constructor. More...
	toJson ()
	fromJson (string $json)
	jsonSerialize ()

Private Member Functions
	ensureValidArrayTypes (array $data)
	ensureValidInternalTypes (array $data)

Detailed Description

Class ilTermsOfServiceAcceptanceHistoryCriteriaBag.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 25 of file class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php.

Constructor & Destructor Documentation

__construct()

ilTermsOfServiceAcceptanceHistoryCriteriaBag::__construct

(

$data = []

)

ilTermsOfServiceAcceptanceHistoryCriteriaBag constructor.

Parameters

string|ilTermsOfServiceEvaluableCriterion[]

$data

Exceptions

ilTermsOfServiceUnexpectedCriteriaBagContentException

Definition at line 32 of file class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php.

References $data, ILIAS\GlobalScreen\Provider\__construct(), ensureValidArrayTypes(), fromJson(), ilTermsOfServiceEvaluableCriterion\getCriterionId(), and ilTermsOfServiceEvaluableCriterion\getCriterionValue().

    {
        if (is_array($data)) {
            $this->ensureValidArrayTypes($data);

            parent::__construct(array_values(array_map(static function (
                ilTermsOfServiceEvaluableCriterion $criterionAssignment
            ): array {
                return [
                    'id' => $criterionAssignment->getCriterionId(),
                    'value' => $criterionAssignment->getCriterionValue()
                ];
            }, $data)));
        } else {
            parent::__construct([]);

            if (is_string($data)) {
                $this->fromJson($data);
            }
        }
    }

Here is the call graph for this function:

Member Function Documentation

ensureValidArrayTypes()

ilTermsOfServiceAcceptanceHistoryCriteriaBag::ensureValidArrayTypes ( array  $data )

private

Definition at line 54 of file class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php.

Referenced by __construct().

                                                       : void
    {
        array_walk($data, static function ($value): void {
            if (!($value instanceof ilTermsOfServiceEvaluableCriterion)) {
                throw new ilTermsOfServiceUnexpectedCriteriaBagContentException(sprintf(
                    "Unexpected element found, given %s, expected instanceof '%s'",
                    var_export($value, true),
                    ilTermsOfServiceEvaluableCriterion::class
                ));
            }
        });
    }

Here is the caller graph for this function:

ensureValidInternalTypes()

ilTermsOfServiceAcceptanceHistoryCriteriaBag::ensureValidInternalTypes ( array  $data )

private

Definition at line 67 of file class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php.

Referenced by fromJson().

                                                          : void
    {
        array_walk($data, static function ($value): void {
            if (!is_array($value)) {
                throw new ilTermsOfServiceUnexpectedCriteriaBagContentException(sprintf(
                    'Unexpected element found, given %s, expected array',
                    var_export($value, true)
                ));
            }

            if (!array_key_exists('id', $value) || !array_key_exists('value', $value) || count($value) !== 2) {
                throw new ilTermsOfServiceUnexpectedCriteriaBagContentException(sprintf(
                    "Unexpected element found, given %s, expected array with keys 'id' and 'value'",
                    var_export($value, true)
                ));
            }
        });
    }

Here is the caller graph for this function:

fromJson()

ilTermsOfServiceAcceptanceHistoryCriteriaBag::fromJson

(

string

$json

)

Exceptions

ilTermsOfServiceUnexpectedCriteriaBagContentException

Implements ilTermsOfServiceJsonDeserialization.

Definition at line 95 of file class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php.

References $data, and ensureValidInternalTypes().

Referenced by __construct().

                                          : void
    {
        $data = json_decode($json, true, 512, JSON_THROW_ON_ERROR);

        if (!is_array($data)) {
            throw new ilTermsOfServiceUnexpectedCriteriaBagContentException(sprintf(
                'Unexpected element found, given %s, expected array',
                var_export($data, true)
            ));
        }

        $this->ensureValidInternalTypes($data);

        $this->exchangeArray($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

jsonSerialize()

ilTermsOfServiceAcceptanceHistoryCriteriaBag::jsonSerialize

(

)

Definition at line 111 of file class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php.

                                   : array
    {
        return $this->getArrayCopy();
    }

toJson()

ilTermsOfServiceAcceptanceHistoryCriteriaBag::toJson

(

)

Implements ilTermsOfServiceJsonSerialization.

Definition at line 86 of file class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php.

Referenced by ilTermsOfServiceAcceptanceHistoryCriteriaBagTest\testCriteriaCanBePassedAsString().

                            : string
    {
        return json_encode($this, JSON_THROW_ON_ERROR);
    }

Here is the caller graph for this function:

---

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

• Services/TermsOfService/classes/History/class.ilTermsOfServiceAcceptanceHistoryCriteriaBag.php