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

Represents the user planner tool. More...

Inheritance diagram for workshop_user_plan:
renderable

Public Member Functions

 __construct (workshop $workshop, $userid)
 Prepare an individual workshop plan for the given user.
 
 get_examples ()
 Returns example submissions to be assessed by the owner of the planner.
 

Public Attributes

array $phases = array()
 of (stdclass)tasks
 
int $userid
 id of the user this plan is for
 
workshop $workshop
 

Protected Attributes

null array $examples = null
 of example submissions to be assessed by the planner owner
 

Detailed Description

Represents the user planner tool.

Planner contains list of phases. Each phase contains list of tasks. Task is a simple object with title, link and completed (true/false/null logic).

Constructor & Destructor Documentation

◆ __construct()

workshop_user_plan::__construct ( workshop $workshop,
$userid )

Prepare an individual workshop plan for the given user.

Parameters
workshop$workshopinstance
int$useridwhom the plan is prepared for

Member Function Documentation

◆ get_examples()

workshop_user_plan::get_examples ( )

Returns example submissions to be assessed by the owner of the planner.

This is here to cache the DB query because the same list is needed later in view.php

See also
workshop\get_examples_for_reviewer() for the format of returned value
Return values
array

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