Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
workshop_submission Class Reference

Renderable object containing all the information needed to display the submission. More...

Inheritance diagram for workshop_submission:
workshop_submission_summary renderable workshop_submission_base renderable

Public Member Functions

 anonymize ()
 Unsets all author-related properties so that the renderer does not have access to them.
 
 is_anonymous ()
 Does the submission object contain author-related information?
 

Public Attributes

array $attachment
 
string $authoralternatename
 
string $authoremail
 
string $authorfirstname
 
string $authorfirstnamephonetic
 
int $authorid
 
string $authorimagealt
 
string $authorlastname
 
string $authorlastnamephonetic
 
string $authormiddlename
 
int $authorpicture
 
string $content
 
int $contentformat
 
bool $contenttrust
 
int $id
 
string $status
 graded|notgraded
 
int $timecreated
 
int $timemodified
 
string $title
 
moodle_url $url
 to display submission
 

Protected Attributes

bool $anonymous
 is the submission anonymous (i.e.
 
array $fields
 of columns from workshop_submissions that are assigned as properties of instances of this class
 
workshop $workshop
 

Detailed Description

Renderable object containing all the information needed to display the submission.

See also
workshop_renderer\render_workshop_submission()

Member Function Documentation

◆ anonymize()

workshop_submission_base::anonymize ( )
inherited

Unsets all author-related properties so that the renderer does not have access to them.

Usually this is called by the contructor but can be called explicitely, too.

◆ is_anonymous()

workshop_submission_base::is_anonymous ( )
inherited

Does the submission object contain author-related information?

Return values
null|boolean

Reimplemented in workshop_example_submission_summary.

Member Data Documentation

◆ $anonymous

bool workshop_submission_base::$anonymous
protectedinherited

is the submission anonymous (i.e.

contains author information)

◆ $fields

array workshop_submission::$fields
protected
Initial value:
= array(
'id', 'title', 'timecreated', 'timemodified', 'content', 'contentformat', 'contenttrust',
'attachment', 'authorid', 'authorfirstname', 'authorlastname', 'authorfirstnamephonetic', 'authorlastnamephonetic',
'authormiddlename', 'authoralternatename', 'authorpicture', 'authorimagealt', 'authoremail')

of columns from workshop_submissions that are assigned as properties of instances of this class


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