Inheritance diagram for ILIAS\Data\Description\DValue:

Collaboration diagram for ILIAS\Data\Description\DValue:

Public Member Functions
	__construct (Text\SimpleDocumentMarkdown $description, protected ValueType $type,)

	getType ()

	getPrimitiveRepresentation (mixed $data)
	Each of the types that can be described has a canonical representation created from primitive PHP types. More...

Public Member Functions inherited from ILIAS\Data\Description\Description
	__construct (protected ?Text\SimpleDocumentMarkdown $description,)

	getDescription ()

	getPrimitiveRepresentation (mixed $data)
	Each of the types that can be described has a canonical representation created from primitive PHP types. More...

	matches (mixed $data)

Detailed Description

Definition at line 25 of file DValue.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Data\Description\DValue::__construct	(	Text\SimpleDocumentMarkdown	$description,
		protected ValueType	$type
	)

Definition at line 27 of file DValue.php.

      {
        parent::__construct($description);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ getPrimitiveRepresentation()

ILIAS\Data\Description\DValue::getPrimitiveRepresentation ( mixed $data )

Each of the types that can be described has a canonical representation created from primitive PHP types.

This attempts to transform the provided data into such a representation.

If this returns a \Closure, the data cannot be transformed into such a representation and the \Closure will produce a generator that provides a list of defects where $data does not match the description. If this does return something else it will be plain old php data according to the description.

Reimplemented from ILIAS\Data\Description\Description.

Definition at line 39 of file DValue.php.

                                                           : mixed
    {
        switch ($this->type) {
            case ValueType::INT:
                if (!is_int($data)) {
                    return fn() => yield "Expected an integer.";
                }
                return $data;
 
            case ValueType::FLOAT:
                if (!is_float($data)) {
                    return fn() => yield "Expected a float.";
                }
                return $data;
 
            case ValueType::STRING:
                if (!is_string($data)) {
                    return fn() => yield "Expected a string.";
                }
                return $data;
 
            case ValueType::DATETIME:
                if (!$data instanceof \DateTimeImmutable) {
                    return fn() => yield "Expected a \\DateTimeImmutable.";
                }
                return $data;
 
            case ValueType::BOOL:
                if (!is_bool($data)) {
                    return fn() => yield "Expected a bool.";
                }
                return $data;
 
            case ValueType::NULL:
                if (!is_null($data)) {
                    return fn() => yield "Expected null.";
                }
                return $data;
 
            default:
                throw new \LogicException("Unmatch type.");
        }
    }

References $data, and ILIAS\Data\Description\NULL.

◆ getType()

ILIAS\Data\Description\DValue::getType ( )

Definition at line 34 of file DValue.php.

                             : ValueType
    {
        return $this->type;
    }

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