1. class
  2. local_middag
  3. \
  4. framework
  5. \
  6. shared
  7. \
  8. dto
  9. \
  10. item
  11. \
  12. item_dto

item_dto

class item_dto extends abstract_dto implements item_dto_interface

internal  
 

Data Transfer Object (DTO) for items.

A unified input model for creating and updating items. It is intentionally mutable to support form hydration and stepwise population.

Rules:

  • When creating: id = null
  • When updating: id != null
  • Any field set to null will not override existing entity values (Partial Update)
  • Only metadata keys provided here will be merged/updated

Methods

array
jsonSerialize()

Default implementation to serialize to JSON using the array representation.

from  abstract_dto
__construct(int|null $id = null, string|null $type = item::TYPE, int|null $contextid = null, int|null $courseid = null, int|null $userid = null, int|null $parent = null, string|null $fullname = null, string|null $shortname = null, string|null $idnumber = null, string|null $description = null, int|null $descriptionformat = 0, string|null $status = 'draft', int|null $visible = 1, string|null $guid = null, int|null $sortorder = 0, string|null $version = null, int|null $usermodified = null, array $metadata = [])

DTO constructor.

static item_dto
from_array(array $data)

Create a DTO from an associative array (e.g. form data or JSON).

array
to_array()

Convert DTO to an array, filtering out null values.

Details

in abstract_dto at line 38
array jsonSerialize()

Default implementation to serialize to JSON using the array representation.

Return Value

array

at line 64
__construct(int|null $id = null, string|null $type = item::TYPE, int|null $contextid = null, int|null $courseid = null, int|null $userid = null, int|null $parent = null, string|null $fullname = null, string|null $shortname = null, string|null $idnumber = null, string|null $description = null, int|null $descriptionformat = 0, string|null $status = 'draft', int|null $visible = 1, string|null $guid = null, int|null $sortorder = 0, string|null $version = null, int|null $usermodified = null, array $metadata = [])

DTO constructor.

All fields are nullable to support partial updates (PATCH-like behavior).

Parameters

int|null $id

Item ID (null for creation)
string|null $type

Logical TYPE identifier
int|null $contextid

Moodle context ID
int|null $courseid

Course ID
int|null $userid

Entity owner (creator)
int|null $parent

Parent item ID
string|null $fullname

Full name/title
string|null $shortname

Short/abbreviated label
string|null $idnumber

External reference
string|null $description

Long description (HTML/text)
int|null $descriptionformat

Moodle text format
string|null $status

Logical workflow/status
int|null $visible

Visibility flag (0/1)
string|null $guid

External unique identifier
int|null $sortorder

Ordering index
string|null $version

Arbitrary version tag
int|null $usermodified

User performing the operation
array $metadata

Arbitrary key/value metadata

at line 96
static item_dto from_array(array $data)

Create a DTO from an associative array (e.g. form data or JSON).

Keys not present in the array will remain null (not updated). Unknown keys are ignored.

Parameters

array $data

Return Value

item_dto

at line 127
array to_array()

Convert DTO to an array, filtering out null values.

Useful for repository methods that should receive only changed fields.

Return Value

array