ILIAS\Data\Description\DObject Class Reference

Inheritance diagram for ILIAS\Data\Description\DObject:

Collaboration diagram for ILIAS\Data\Description\DObject:

Public Member Functions
	__construct (Text\SimpleDocumentMarkdown $description, Field ... $fields)
	getFields ()
	getPrimitiveRepresentation (mixed $data)
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)

Protected Member Functions
	possibleMethodNames (string $name)
	possiblePropertyNames (string $name)
	camelCased (string $name)
	snakeCased (string $name)

Protected Attributes
array	$fields

Detailed Description

Definition at line 25 of file DObject.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Data\Description\DObject::__construct	(	Text\SimpleDocumentMarkdown	$description,
		Field ...	$fields
	)

Definition at line 31 of file DObject.php.

References ILIAS\Data\Description\DObject\$fields, and ILIAS\GlobalScreen\Provider\__construct().

      {
        parent::__construct($description);
        $this->fields = $fields;
    }

Here is the call graph for this function:

Member Function Documentation

camelCased()

ILIAS\Data\Description\DObject::camelCased ( string  $name )

protected

Definition at line 121 of file DObject.php.

Referenced by ILIAS\Data\Description\DObject\possibleMethodNames(), and ILIAS\Data\Description\DObject\possiblePropertyNames().

                                               : string
    {
        return preg_replace_callback("/_(\w)/", fn($v) => strtoupper($v[1]), $name);
    }

Here is the caller graph for this function:

getFields()

ILIAS\Data\Description\DObject::getFields

(

)

Definition at line 39 of file DObject.php.

                               : \Generator
    {
        foreach ($this->fields as $field) {
            yield $field;
        }
    }

getPrimitiveRepresentation()

ILIAS\Data\Description\DObject::getPrimitiveRepresentation

(

mixed

$data

)

Definition at line 46 of file DObject.php.

References null, ILIAS\Data\Description\DObject\possibleMethodNames(), and ILIAS\Data\Description\DObject\possiblePropertyNames().

                                                           : mixed
    {
        if (!is_object($data)) {
            return fn() => yield "Expected an object.";
        }

        $repr = new \StdClass();
        $errors = [];

        foreach ($this->fields as $field) {
            $name = $field->getName();
            $found = false;
            $value = null;
            foreach ($this->possibleMethodNames($name) as $method) {
                if (method_exists($data, $method)) {
                    $found = true;
                    $value = $data->$method();
                    break;
                }
            }
            if (!$found) {
                foreach ($this->possiblePropertyNames($name) as $property) {
                    if (property_exists($data, $property)) {
                        $found = true;
                        $value = $data->$property;
                        break;
                    }
                }
            }
            if (!$found) {
                $errors[] = fn() => yield "Object does not have property \"$name\".";
                continue;
            }

            $value = $field->getType()->getPrimitiveRepresentation($value);
            if ($value instanceof \Closure) {
                $errors[] = $value;
            } else {
                $repr->$name = $value;
            }

        }

        if ($errors) {
            die("foo");
            return $this->mergeErrors($errors);
        }

        return $repr;
    }

Here is the call graph for this function:

possibleMethodNames()

ILIAS\Data\Description\DObject::possibleMethodNames ( string  $name )

protected

Definition at line 97 of file DObject.php.

References ILIAS\Data\Description\DObject\camelCased(), and ILIAS\Data\Description\DObject\snakeCased().

Referenced by ILIAS\Data\Description\DObject\getPrimitiveRepresentation().

                                                        : \Generator
    {
        $camel_cased = $this->camelCased($name);
        $snake_cased = $this->snakeCased($name);

        yield "get" . ucfirst($name);
        yield "get_" . $name;
        yield "get" . $camel_cased;
        yield "get_" . $snake_cased;
        yield "is" . ucfirst($name);
        yield "is_" . $name;
        yield "is" . $camel_cased;
        yield "is_" . $snake_cased;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

possiblePropertyNames()

ILIAS\Data\Description\DObject::possiblePropertyNames ( string  $name )

protected

Definition at line 112 of file DObject.php.

References ILIAS\Data\Description\DObject\camelCased(), and ILIAS\Data\Description\DObject\snakeCased().

Referenced by ILIAS\Data\Description\DObject\getPrimitiveRepresentation().

                                                          : \Generator
    {
        yield $name;
        yield ucfirst($name);
        yield $this->camelCased($name);
        yield $this->snakeCased($name);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

snakeCased()

ILIAS\Data\Description\DObject::snakeCased ( string  $name )

protected

Definition at line 126 of file DObject.php.

Referenced by ILIAS\Data\Description\DObject\possibleMethodNames(), and ILIAS\Data\Description\DObject\possiblePropertyNames().

                                               : string
    {
        return preg_replace_callback("/[A-Z]/", fn($v) => "_" . strtolower($v[0]), $name);
    }

Here is the caller graph for this function:

Field Documentation

$fields

array ILIAS\Data\Description\DObject::$fields

protected

Definition at line 29 of file DObject.php.

Referenced by ILIAS\Data\Description\DObject\__construct().

---

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

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