ILIAS\Data\Description\DMap Class Reference

Inheritance diagram for ILIAS\Data\Description\DMap:

Collaboration diagram for ILIAS\Data\Description\DMap:

Public Member Functions
	__construct (Text\SimpleDocumentMarkdown $description, protected DValue $key_type, protected Description $value_type)
	getPrimitiveRepresentation (mixed $data)
	Each of the types that can be described has a canonical representation created from primitive PHP types. More...
	getKeyType ()
	getValueType ()
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 DMap.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\Description\DMap::__construct	(	Text\SimpleDocumentMarkdown	$description,
		protected DValue	$key_type,
		protected Description	$value_type
	)

Definition at line 29 of file DMap.php.

      {
        parent::__construct($description);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

getKeyType()

ILIAS\Data\Description\DMap::getKeyType

(

)

Definition at line 72 of file DMap.php.

                                : DValue
    {
        return $this->key_type;
    }

getPrimitiveRepresentation()

ILIAS\Data\Description\DMap::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 37 of file DMap.php.

                                                           : mixed
    {
        if (!is_array($data)) {
            return fn() => yield "Expected an array.";
        }
 
        $repr = [];
        $errors = [];
 
        foreach ($data as $k => $v) {
            $key = $this->key_type->getPrimitiveRepresentation($k);
            $value = $this->value_type->getPrimitiveRepresentation($v);
 
            $key_is_error = $key instanceof \Closure;
            $value_is_error = $value instanceof \Closure;
 
            if ($key_is_error) {
                $errors[] = $key;
            }
            if ($value_is_error) {
                $errors[] = $value;
            }
 
            if (!$key_is_error && !$value_is_error) {
                $repr[$key] = $value;
            }
        }
 
        if ($errors) {
            return $this->mergeErrors($errors);
        }
 
        return $repr;
    }

References $data.

getValueType()

ILIAS\Data\Description\DMap::getValueType

(

)

Definition at line 77 of file DMap.php.

                                  : Description
    {
        return $this->value_type;
    }

---

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

• components/ILIAS/Data/src/Description/DMap.php