MIDDAG for Moodle

group extends abstract_moodle_entity

Group Entity (Moodle Native).

Table of Contents

Properties

$courseid  : int
$description  : string|null
$descriptionformat  : int
$enrolmentkey  : string|null
$id  : int
$idnumber  : string
$name  : string
$participation  : int
$picture  : int
$timecreated  : int
$timemodified  : int
$visibility  : 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_courseid()  : int
get_description()  : null|string
get_descriptionformat()  : int
get_enrolmentkey()  : null|string
get_id()  : null|int
Get the entity unique identifier.
get_idnumber()  : string
get_name()  : string
get_participation()  : int
get_picture()  : int
get_table()  : string
Returns the Moodle database table name.
get_timecreated()  : int
Get entity creation timestamp.
get_timemodified()  : int
Get entity modification timestamp.
get_visibility()  : int
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_courseid()  : self
with_description()  : self
with_descriptionformat()  : self
with_enrolmentkey()  : self
with_id()  : $this
Set entity identifier.
with_idnumber()  : self
with_name()  : self
with_participation()  : self
with_picture()  : self
with_timecreated()  : $this
Set entity creation timestamp.
with_timemodified()  : $this
Set entity modification timestamp.
with_visibility()  : self

Properties

$courseid

protected int $courseid = 0

$description

protected string|null $description = null

$descriptionformat

protected int $descriptionformat = 0

$enrolmentkey

protected string|null $enrolmentkey = null

$idnumber

protected string $idnumber = ''

$name

protected string $name = ''

$participation

protected int $participation = 1

$picture

protected int $picture = 0

$visibility

protected int $visibility = 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_courseid()

public get_courseid() : int
Return values
int

get_description()

public get_description() : null|string
Return values
null|string

get_descriptionformat()

public get_descriptionformat() : int
Return values
int

get_enrolmentkey()

public get_enrolmentkey() : null|string
Return values
null|string

get_idnumber()

public get_idnumber() : string
Return values
string

get_name()

public get_name() : string
Return values
string

get_participation()

public get_participation() : int
Return values
int

get_picture()

public get_picture() : 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

get_visibility()

public get_visibility() : 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_courseid()

public with_courseid(int $courseid) : self
Parameters
$courseid : int
Return values
self

with_description()

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

with_descriptionformat()

public with_descriptionformat(int $descriptionformat) : self
Parameters
$descriptionformat : int
Return values
self

with_enrolmentkey()

public with_enrolmentkey(string|null $enrolmentkey) : self
Parameters
$enrolmentkey : string|null
Return values
self

with_id()

Set entity identifier.

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

with_idnumber()

public with_idnumber(string $idnumber) : self
Parameters
$idnumber : string
Return values
self

with_name()

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

with_participation()

public with_participation(int $participation) : self
Parameters
$participation : int
Return values
self

with_picture()

public with_picture(int $picture) : self
Parameters
$picture : 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

with_visibility()

public with_visibility(int $visibility) : self
Parameters
$visibility : int
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results