MIDDAG for Moodle

role extends abstract_moodle_entity

Role Entity (Moodle Native).

Table of Contents

Properties

$archetype  : string
$description  : string
$id  : int
$name  : string
$shortname  : string
$sortorder  : int
$timecreated  : int
$timemodified  : int

Methods

__call()  : mixed
Magic accessor to support get_* and with_* helpers for entity properties.
__get()  : mixed
Magic getter to allow reading protected properties.
__isset()  : bool
Magic isset to allow checking protected properties.
__set()  : void
Magic setter.
as_std_class()  : stdClass
Returns the entity as stdClass (alias for to_record).
from_record()  : static
Factory method to create an entity from a Moodle record.
get_archetype()  : string
get_description()  : string
get_id()  : null|int
Get the entity unique identifier.
get_name()  : string
get_shortname()  : string
get_sortorder()  : int
get_table()  : string
Returns the Moodle database table name.
get_timecreated()  : int
Get entity creation timestamp.
get_timemodified()  : int
Get entity modification timestamp.
jsonSerialize()  : array<string, mixed>
Serializes the object to a value that can be natively serialized by json_encode().
to_array()  : array<string, mixed>
Implementation for entity_interface.
to_record()  : stdClass
Converts the entity to a stdClass record for Moodle APIs.
with_archetype()  : self
with_description()  : self
with_id()  : $this
Set entity identifier.
with_name()  : self
with_shortname()  : self
with_sortorder()  : self
with_timecreated()  : $this
Set entity creation timestamp.
with_timemodified()  : $this
Set entity modification timestamp.

Properties

$archetype

protected string $archetype = ''

$description

protected string $description = ''

$name

protected string $name = ''

$shortname

protected string $shortname = ''

$sortorder

protected int $sortorder = 0

Methods

__call()

Magic accessor to support get_* and with_* helpers for entity properties.

public __call(string $name, array<string|int, mixed> $arguments) : mixed
Parameters
$name : string
$arguments : array<string|int, mixed>

__get()

Magic getter to allow reading protected properties.

public __get(string $name) : mixed
Parameters
$name : string

Property name

__isset()

Magic isset to allow checking protected properties.

public __isset(string $name) : bool
Parameters
$name : string

Property name

Return values
bool

__set()

Magic setter.

public __set(string $name, mixed $value) : void
Parameters
$name : string

Property name

$value : mixed

Value

as_std_class()

Returns the entity as stdClass (alias for to_record).

public as_std_class() : stdClass
Return values
stdClass

from_record()

Factory method to create an entity from a Moodle record.

public static from_record(array<string|int, mixed>|stdClass $record) : static

Automatically casts values to match property types (int, string, etc.) since Moodle's database layer often returns numeric values as strings.

Parameters
$record : array<string|int, mixed>|stdClass
Return values
static

get_archetype()

public get_archetype() : string
Return values
string

get_description()

public get_description() : string
Return values
string

get_name()

public get_name() : string
Return values
string

get_shortname()

public get_shortname() : string
Return values
string

get_sortorder()

public get_sortorder() : int
Return values
int

get_table()

Returns the Moodle database table name.

public static get_table() : string
Return values
string

get_timecreated()

Get entity creation timestamp.

public get_timecreated() : int
Return values
int

get_timemodified()

Get entity modification timestamp.

public get_timemodified() : int
Return values
int

jsonSerialize()

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

public jsonSerialize() : array<string, mixed>
Tags
noinspection

PhpMethodNamingConventionInspection

Return values
array<string, mixed>

to_array()

Implementation for entity_interface.

public to_array() : array<string, mixed>
Return values
array<string, mixed>

to_record()

Converts the entity to a stdClass record for Moodle APIs.

public to_record() : stdClass
Return values
stdClass

with_archetype()

public with_archetype(string $archetype) : self
Parameters
$archetype : string
Return values
self

with_description()

public with_description(string $description) : self
Parameters
$description : string
Return values
self

with_id()

Set entity identifier.

public with_id(null|int $id) : $this
Parameters
$id : null|int
Return values
$this

with_name()

public with_name(string $name) : self
Parameters
$name : string
Return values
self

with_shortname()

public with_shortname(string $shortname) : self
Parameters
$shortname : string
Return values
self

with_sortorder()

public with_sortorder(int $sortorder) : self
Parameters
$sortorder : int
Return values
self

with_timecreated()

Set entity creation timestamp.

public with_timecreated(int $timecreated) : $this
Parameters
$timecreated : int
Return values
$this

with_timemodified()

Set entity modification timestamp.

public with_timemodified(int $timemodified) : $this
Parameters
$timemodified : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results