local_middag\framework\domain\entity\item

class item extends abstract_entity implements item_interface

Domain entity: Item.

Represents an item stored in middag_items. This is an immutable entity designed for DDD. Changes must be done via with_* methods which return a new instance of the entity.

Traits

has_metadata

Trait has_metadata.

has_relations

Trait has_relations.

has_status

Trait has_status.

has_url

Trait has_url.

Constants

TYPE	Default type for generic items (extensions override this).

Properties

array<string,mixed>	$metadata	Expected property on the consuming class.	from has_metadata
string	$status	Expected property on the using class.	from has_status

Methods

mixed

__get(string $name)

Property-style access: $item->parent.

from has_relations

bool

__isset(string $name)

Check presence of a relation.

from has_relations

void

__set(string $name, mixed $value)

Magic setter.

from abstract_entity

array

jsonSerialize()

Serializes the object to a value that can be natively serialized by json_encode().

from abstract_entity

mixed

__call(string $method, array $arguments)

Magic call handler for metadata getters and withers.

from has_metadata

mixed

get_meta(string $key, mixed $default = null)

Retrieve a metadata value by key.

from has_metadata

bool

has_meta(string $key)

Check if a metadata key exists.

from has_metadata

array

get_all_meta()

Get all metadata.

from has_metadata

has_metadata

with_meta(string $key, mixed $value)

Return a new instance with the updated metadata (Immutable).

from has_metadata

has_metadata

with_all_meta(array $metadata)

Return a new instance replacing all metadata.

from has_metadata

void

set_relation(string $name, mixed $value)

Set a relation value.

from has_relations

mixed

get_relation(string $name)

Public accessor for relations using snake_case.

from has_relations

bool

has_relation(string $name)

Returns TRUE if the relation was defined (even if value is null).

from has_relations

array

get_all_relations()

Get all currently loaded relations.

from has_relations

bool

is_status(item_status|string $value)

Check if the current status matches a specific value or Enum case.

from has_status

bool

is_draft()

Determine if the item is in draft state.

from has_status

bool

is_published()

Determine if the item is published.

from has_status

bool

is_archived()

Determine if the item is archived.

from has_status

bool

is_deleted()

Determine if the item is marked as deleted.

from has_status

bool

is_active()

Check if the item is active.

from has_status

bool

is_inactive()

Check if the item is inactive.

from has_status

bool

is_enabled()

Check if the item is enabled.

from has_status

bool

is_disabled()

Check if the item is disabled.

from has_status

bool

is_pending()

Check if the item awaits processing.

from has_status

bool

is_approved()

Check if the item is approved.

from has_status

bool

is_rejected()

Check if the item was rejected.

from has_status

bool

is_not_started()

Check if the item has not started.

from has_status

bool

is_in_progress()

Check if the item is in progress.

from has_status

bool

is_completed()

Check if the item is completed.

from has_status

bool

is_failed()

Check if the item has failed.

from has_status

bool

is_expired()

Check if the item is expired.

from has_status

bool

is_canceled()

Check if the item is canceled.

from has_status

bool

is_paused()

Check if the item is paused.

from has_status

bool

is_queued()

Check if the item is queued.

from has_status

bool

is_running()

Check if the item is running.

from has_status

bool

is_syncing()

Check if the item is syncing.

from has_status

bool

is_synced()

Check if the item finished syncing.

from has_status

bool

is_error()

Check if the item is in an error state.

from has_status

moodle_url

get_url(string $action = 'view', array $params = [])

Get the URL for a specific action on this entity.

from has_url

moodle_url

get_view_url()

Shortcut for the view URL.

from has_url

moodle_url

get_edit_url()

Shortcut for the edit URL.

from has_url

moodle_url

get_webhook_url(string $action, array $params = [])

Generate a webhook URL specific to this entity.

from has_url

Item constructor (immutable).

static array

metadata_schema()

Define the metadata schema for this item type.

int|null

get_id()

Get the item database identifier.

string

get_type()

Get the logical type identifier.

int|null

get_contextid()

Get the Moodle context ID.

item

with_contextid(int|null $contextid)

Create a new instance with the provided context ID.

int|null

get_courseid()

Get the related course ID.

item

with_courseid(int|null $courseid)

Create a new instance with the provided course ID.

int|null

get_userid()

Get the author/owner user ID.

item

with_userid(int|null $userid)

Create a new instance with the provided user ID.

int|null

get_parent()

Get the parent item ID when hierarchical.

item

with_parent(int|null $parent)

Create a new instance with the provided parent ID.

string|null

get_fullname()

Get the full display name.

item

with_fullname(string $fullname)

Create a new instance with the provided full name.

string|null

get_shortname()

Get the abbreviated name.

item

with_shortname(string|null $shortname)

Create a new instance with the provided short name.

string|null

get_idnumber()

Get the external idnumber.

item

with_idnumber(string|null $idnumber)

Create a new instance with the provided idnumber.

string|null

get_description()

Get the description text.

item

with_description(string|null $description)

Create a new instance with the provided description.

int

get_descriptionformat()

Get the Moodle format constant for the description.

item

with_descriptionformat(int $descriptionformat)

Create a new instance with the provided description format.

string

get_status()

Get the current status identifier.

item

with_status(string $status)

Create a new instance with the provided status.

int

get_visible()

Get the raw visibility flag.

bool

is_visible()

Domain logic: Is this item visible? Wraps the raw integer logic into a boolean.

item

with_visible(int $visible)

Create a new instance with the provided visibility flag.

string|null

get_guid()

Get the GUID reference if present.

int

get_sortorder()

Get the ordering value.

item

with_sortorder(int $sortorder)

Create a new instance with the provided sort order.

string|null

get_version()

Get the semantic version string if tracked.

item

with_version(string|null $version)

Create a new instance with the provided version.

int

get_timecreated()

Get creation timestamp.

int

get_timemodified()

Get last modification timestamp.

item

with_timemodified(int $time)

Create a new instance with the provided modification time.

int|null

get_usermodified()

Get the user ID of the last modifier.

item

with_usermodified(int $userid)

Create a new instance with the provided last modifier.

array

to_array()

Convert entity to array.

Details

in has_relations at line 40
`mixed __get(string $name)`

Property-style access: $item->parent.

Convenience wrapper for get_relation().

Parameters

string

$name

Return Value

mixed

in has_relations at line 52
`bool __isset(string $name)`

Check presence of a relation.

Parameters

string

$name

Return Value

bool

in abstract_entity at line 66
`void __set(string $name, mixed $value)`

Magic setter.

Parameters

string	$name	Property name
mixed	$value	Value

Return Value

void

in abstract_entity at line 80
`array jsonSerialize()`

Serializes the object to a value that can be natively serialized by json_encode().

Return Value

array

in has_metadata at line 46
`mixed __call(string $method, array $arguments)`

Magic call handler for metadata getters and withers.

Allows accessing metadata like $item->get_price() or $item->with_price(10).

Parameters

string	$method
array	$arguments

Return Value

mixed

in has_metadata at line 79
`mixed get_meta(string $key, mixed $default = null)`

Retrieve a metadata value by key.

Parameters

string	$key
mixed	$default

Return Value

mixed

in has_metadata at line 95
`bool has_meta(string $key)`

Check if a metadata key exists.

Parameters

string

$key

Return Value

bool

in has_metadata at line 109
`array get_all_meta()`

Get all metadata.

Return Value

array

in has_metadata at line 124
`has_metadata with_meta(string $key, mixed $value)`

Return a new instance with the updated metadata (Immutable).

Parameters

string	$key
mixed	$value

Return Value

has_metadata

in has_metadata at line 144
`has_metadata with_all_meta(array $metadata)`

Return a new instance replacing all metadata.

Parameters

array

$metadata

Return Value

has_metadata

in has_relations at line 72
`void set_relation(string $name, mixed $value)`

internal

Set a relation value.

INTERNAL API used by loader and the query engine. Use Repository/Loader to set these during hydration.

Architecture Note: This mutates the internal state of the entity. In a strict immutable context, this might return a clone, but for hydration performance (lazy loading relations), direct mutation is acceptable here.

Parameters

string	$name
mixed	$value

Return Value

void

in has_relations at line 84
`mixed get_relation(string $name)`

Public accessor for relations using snake_case.

Parameters

string

$name

Return Value

mixed

in has_relations at line 96
`bool has_relation(string $name)`

Returns TRUE if the relation was defined (even if value is null).

Parameters

string

$name

Return Value

bool

in has_relations at line 106
`array get_all_relations()`

Get all currently loaded relations.

Return Value

array

in has_status at line 39
`bool is_status(item_status|string $value)`

Check if the current status matches a specific value or Enum case.

Parameters

item_status|string

$value

Return Value

bool

in has_status at line 61
`bool is_draft()`

Determine if the item is in draft state.

Return Value

bool

in has_status at line 69
`bool is_published()`

Determine if the item is published.

Return Value

bool

in has_status at line 77
`bool is_archived()`

Determine if the item is archived.

Return Value

bool

in has_status at line 85
`bool is_deleted()`

Determine if the item is marked as deleted.

Return Value

bool

in has_status at line 97
`bool is_active()`

Check if the item is active.

Return Value

bool

in has_status at line 105
`bool is_inactive()`

Check if the item is inactive.

Return Value

bool

in has_status at line 113
`bool is_enabled()`

Check if the item is enabled.

Return Value

bool

in has_status at line 121
`bool is_disabled()`

Check if the item is disabled.

Return Value

bool

in has_status at line 133
`bool is_pending()`

Check if the item awaits processing.

Return Value

bool

in has_status at line 141
`bool is_approved()`

Check if the item is approved.

Return Value

bool

in has_status at line 149
`bool is_rejected()`

Check if the item was rejected.

Return Value

bool

in has_status at line 161
`bool is_not_started()`

Check if the item has not started.

Return Value

bool

in has_status at line 169
`bool is_in_progress()`

Check if the item is in progress.

Return Value

bool

in has_status at line 177
`bool is_completed()`

Check if the item is completed.

Return Value

bool

in has_status at line 185
`bool is_failed()`

Check if the item has failed.

Return Value

bool

in has_status at line 193
`bool is_expired()`

Check if the item is expired.

Return Value

bool

in has_status at line 201
`bool is_canceled()`

Check if the item is canceled.

Return Value

bool

in has_status at line 209
`bool is_paused()`

Check if the item is paused.

Return Value

bool

in has_status at line 221
`bool is_queued()`

Check if the item is queued.

Return Value

bool

in has_status at line 229
`bool is_running()`

Check if the item is running.

Return Value

bool

in has_status at line 237
`bool is_syncing()`

Check if the item is syncing.

Return Value

bool

in has_status at line 245
`bool is_synced()`

Check if the item finished syncing.

Return Value

bool

in has_status at line 257
`bool is_error()`

Check if the item is in an error state.

Return Value

bool

in has_url at line 46
`moodle_url get_url(string $action = 'view', array $params = [])`

Get the URL for a specific action on this entity.

Convention: Route name is "middag.{type}.{action}" Example: $item->get_url('edit') -> route('middag.generic.edit', ['id' => 123])

Parameters

string	$action	the action suffix (view, edit, delete) or full route name
array	$params	additional parameters

Return Value

moodle_url

in has_url at line 71
`moodle_url get_view_url()`

Shortcut for the view URL.

Return Value

moodle_url

in has_url at line 79
`moodle_url get_edit_url()`

Shortcut for the edit URL.

Return Value

moodle_url

in has_url at line 92
`moodle_url get_webhook_url(string $action, array $params = [])`

Generate a webhook URL specific to this entity.

Parameters

string	$action
array	$params

Return Value

moodle_url

at line 70
__construct(int|null $id = null, string $type = self::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 $descriptionformat = 0, string $status = 'draft', int $visible = 1, string|null $guid = null, int $sortorder = 0, string|null $version = null, int $timecreated = 0, int $timemodified = 0, int|null $usermodified = null, array $metadata = [])

Item constructor (immutable).

Parameters

int\|null	$id
string	$type
int\|null	$contextid
int\|null	$courseid
int\|null	$userid
int\|null	$parent
string\|null	$fullname
string\|null	$shortname
string\|null	$idnumber
string\|null	$description
int	$descriptionformat
string	$status
int	$visible
string\|null	$guid
int	$sortorder
string\|null	$version
int	$timecreated
int	$timemodified
int\|null	$usermodified
array	$metadata	Initial metadata

at line 103
`static array metadata_schema()`

Define the metadata schema for this item type.

Override this in subclasses to define typed metadata fields or validation rules.

Return Value

array

Map of key => Type/Rule

at line 113
`int|null get_id()`

Get the item database identifier.

Return Value

int|null

at line 121
`string get_type()`

Get the logical type identifier.

Return Value

string

at line 129
`int|null get_contextid()`

Get the Moodle context ID.

Return Value

int|null

at line 141
`item with_contextid(int|null $contextid)`

Create a new instance with the provided context ID.

Parameters

int|null

$contextid

Context identifier

Return Value

item

at line 152
`int|null get_courseid()`

Get the related course ID.

Return Value

int|null

at line 164
`item with_courseid(int|null $courseid)`

Create a new instance with the provided course ID.

Parameters

int|null

$courseid

Course identifier

Return Value

item

at line 175
`int|null get_userid()`

Get the author/owner user ID.

Return Value

int|null

at line 187
`item with_userid(int|null $userid)`

Create a new instance with the provided user ID.

Parameters

int|null

$userid

User identifier

Return Value

item

at line 198
`int|null get_parent()`

Get the parent item ID when hierarchical.

Return Value

int|null

at line 210
`item with_parent(int|null $parent)`

Create a new instance with the provided parent ID.

Parameters

int|null

$parent

Parent item identifier

Return Value

item

at line 221
`string|null get_fullname()`

Get the full display name.

Return Value

string|null

at line 233
`item with_fullname(string $fullname)`

Create a new instance with the provided full name.

Parameters

string

$fullname

Full display name

Return Value

item

at line 244
`string|null get_shortname()`

Get the abbreviated name.

Return Value

string|null

at line 256
`item with_shortname(string|null $shortname)`

Create a new instance with the provided short name.

Parameters

string|null

$shortname

Short display name

Return Value

item

at line 267
`string|null get_idnumber()`

Get the external idnumber.

Return Value

string|null

at line 279
`item with_idnumber(string|null $idnumber)`

Create a new instance with the provided idnumber.

Parameters

string|null

$idnumber

External identifier

Return Value

item

at line 290
`string|null get_description()`

Get the description text.

Return Value

string|null

at line 302
`item with_description(string|null $description)`

Create a new instance with the provided description.

Parameters

string|null

$description

Description text

Return Value

item

at line 313
`int get_descriptionformat()`

Get the Moodle format constant for the description.

Return Value

int

at line 325
`item with_descriptionformat(int $descriptionformat)`

Create a new instance with the provided description format.

Parameters

int

$descriptionformat

Moodle format constant

Return Value

item

at line 336
`string get_status()`

Get the current status identifier.

Return Value

string

at line 348
`item with_status(string $status)`

Create a new instance with the provided status.

Parameters

string

$status

Status identifier

Return Value

item

at line 359
`int get_visible()`

Get the raw visibility flag.

Return Value

int

at line 368
`bool is_visible()`

Domain logic: Is this item visible? Wraps the raw integer logic into a boolean.

Return Value

bool

at line 380
`item with_visible(int $visible)`

Create a new instance with the provided visibility flag.

Parameters

int

$visible

Visibility flag (0/1)

Return Value

item

at line 391
`string|null get_guid()`

Get the GUID reference if present.

Return Value

string|null

at line 401
`int get_sortorder()`

Get the ordering value.

Return Value

int

at line 413
`item with_sortorder(int $sortorder)`

Create a new instance with the provided sort order.

Parameters

int

$sortorder

Ordering value

Return Value

item

at line 424
`string|null get_version()`

Get the semantic version string if tracked.

Return Value

string|null

at line 436
`item with_version(string|null $version)`

Create a new instance with the provided version.

Parameters

string|null

$version

Semantic version string

Return Value

item

at line 447
`int get_timecreated()`

Get creation timestamp.

Return Value

int

at line 457
`int get_timemodified()`

Get last modification timestamp.

Return Value

int

at line 469
`item with_timemodified(int $time)`

Create a new instance with the provided modification time.

Parameters

int

$time

Unix timestamp

Return Value

item

at line 480
`int|null get_usermodified()`

Get the user ID of the last modifier.

Return Value

int|null

at line 492
`item with_usermodified(int $userid)`

Create a new instance with the provided last modifier.

Parameters

int

$userid

User identifier

Return Value

item

at line 506
`array to_array()`

Convert entity to array.

Useful for DTO conversion or serialization.

Return Value

array

item

Traits

Constants

Properties

Methods

Details

in has_relations at line 40 mixed __get(string $name)

Parameters

Return Value

in has_relations at line 52 bool __isset(string $name)

Parameters

Return Value

in abstract_entity at line 66 void __set(string $name, mixed $value)

Parameters

Return Value

in abstract_entity at line 80 array jsonSerialize()

Return Value

in has_metadata at line 46 mixed __call(string $method, array $arguments)

Parameters

Return Value

in has_metadata at line 79 mixed get_meta(string $key, mixed $default = null)

Parameters

Return Value

in has_metadata at line 95 bool has_meta(string $key)

Parameters

Return Value

in has_metadata at line 109 array get_all_meta()

Return Value

in has_metadata at line 124 has_metadata with_meta(string $key, mixed $value)

Parameters

Return Value

in has_metadata at line 144 has_metadata with_all_meta(array $metadata)

Parameters

Return Value

in has_relations at line 72 void set_relation(string $name, mixed $value)

Parameters

Return Value

in has_relations at line 84 mixed get_relation(string $name)

Parameters

Return Value

in has_relations at line 96 bool has_relation(string $name)

Parameters

Return Value

in has_relations at line 106 array get_all_relations()

Return Value

in has_status at line 39 bool is_status(item_status|string $value)

Parameters

Return Value

in has_status at line 61 bool is_draft()

Return Value

in has_status at line 69 bool is_published()

Return Value

in has_status at line 77 bool is_archived()

Return Value

in has_status at line 85 bool is_deleted()

Return Value

in has_status at line 97 bool is_active()

Return Value

in has_status at line 105 bool is_inactive()

Return Value

in has_status at line 113 bool is_enabled()

Return Value

in has_status at line 121 bool is_disabled()

Return Value

in has_status at line 133 bool is_pending()

Return Value

in has_status at line 141 bool is_approved()

Return Value

in has_status at line 149 bool is_rejected()

Return Value

in has_status at line 161 bool is_not_started()

Return Value

in has_status at line 169 bool is_in_progress()

Return Value

in has_status at line 177 bool is_completed()

Return Value

in has_status at line 185 bool is_failed()

Return Value

in has_status at line 193 bool is_expired()

Return Value

in has_relations at line 40
`mixed __get(string $name)`

in has_relations at line 52
`bool __isset(string $name)`

in abstract_entity at line 66
`void __set(string $name, mixed $value)`

in abstract_entity at line 80
`array jsonSerialize()`

in has_metadata at line 46
`mixed __call(string $method, array $arguments)`

in has_metadata at line 79
`mixed get_meta(string $key, mixed $default = null)`

in has_metadata at line 95
`bool has_meta(string $key)`

in has_metadata at line 109
`array get_all_meta()`

in has_metadata at line 124
`has_metadata with_meta(string $key, mixed $value)`

in has_metadata at line 144
`has_metadata with_all_meta(array $metadata)`

in has_relations at line 72
`void set_relation(string $name, mixed $value)`

in has_relations at line 84
`mixed get_relation(string $name)`

in has_relations at line 96
`bool has_relation(string $name)`

in has_relations at line 106
`array get_all_relations()`

in has_status at line 39
`bool is_status(item_status|string $value)`

in has_status at line 61
`bool is_draft()`

in has_status at line 69
`bool is_published()`

in has_status at line 77
`bool is_archived()`

in has_status at line 85
`bool is_deleted()`

in has_status at line 97
`bool is_active()`

in has_status at line 105
`bool is_inactive()`

in has_status at line 113
`bool is_enabled()`

in has_status at line 121
`bool is_disabled()`

in has_status at line 133
`bool is_pending()`

in has_status at line 141
`bool is_approved()`

in has_status at line 149
`bool is_rejected()`

in has_status at line 161
`bool is_not_started()`

in has_status at line 169
`bool is_in_progress()`

in has_status at line 177
`bool is_completed()`

in has_status at line 185
`bool is_failed()`

in has_status at line 193
`bool is_expired()`

in has_status at line 201
`bool is_canceled()`

in has_status at line 209
`bool is_paused()`

in has_status at line 221
`bool is_queued()`

in has_status at line 229
`bool is_running()`

in has_status at line 237
`bool is_syncing()`

in has_status at line 245
`bool is_synced()`

in has_status at line 257
`bool is_error()`

in has_url at line 46
`moodle_url get_url(string $action = 'view', array $params = [])`

in has_url at line 71
`moodle_url get_view_url()`

in has_url at line 79
`moodle_url get_edit_url()`

in has_url at line 92
`moodle_url get_webhook_url(string $action, array $params = [])`

at line 103
`static array metadata_schema()`

at line 113
`int|null get_id()`

at line 121
`string get_type()`

at line 129
`int|null get_contextid()`

at line 141
`item with_contextid(int|null $contextid)`

at line 152
`int|null get_courseid()`

at line 164
`item with_courseid(int|null $courseid)`

at line 175
`int|null get_userid()`

at line 187
`item with_userid(int|null $userid)`

at line 198
`int|null get_parent()`

at line 210
`item with_parent(int|null $parent)`

at line 221
`string|null get_fullname()`

at line 233
`item with_fullname(string $fullname)`

at line 244
`string|null get_shortname()`

at line 256
`item with_shortname(string|null $shortname)`

at line 267
`string|null get_idnumber()`

at line 279
`item with_idnumber(string|null $idnumber)`

at line 290
`string|null get_description()`

at line 302
`item with_description(string|null $description)`