Moodle PHP Documentation 5.1
Moodle 5.1dev (Build: 20250605) (9223e346c3e)
tool_policy\output\user_agreement Class Reference

List of users and their acceptances. More...

Inheritance diagram for tool_policy\output\user_agreement:

Public Member Functions

 __construct ($userid, array $accepted, array $declined, moodle_url $pageurl, $versions, $onbehalf=false, $canaccept=null, $canrevoke=null)
 user_agreement constructor
 
 export_for_download ()
 Describe the status with a plain text for downloading purposes.
 
 export_for_template (\renderer_base $output)
 Export data to be rendered.
 

Protected Attributes

array $accepted
 
bool $canaccept
 
bool $canrevoke
 
array $declined
 
bool $onbehalf
 
moodle_url $pageurl
 
int $userid
 
array $versions
 

Detailed Description

List of users and their acceptances.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Constructor & Destructor Documentation

◆ __construct()

tool_policy\output\user_agreement::__construct ( $userid,
array $accepted,
array $declined,
moodle_url $pageurl,
$versions,
$onbehalf = false,
$canaccept = null,
$canrevoke = null )

user_agreement constructor

Parameters
int$userid
array$acceptedlist of ids of accepted versions
array$declinedlist of ids of declined versions
moodle_url$pageurl
array$versionslist of versions (id=>name)
bool$onbehalfwhether at least one version was accepted by somebody else on behalf of the user
bool$canacceptdoes the current user have permission to accept/decline the policy on behalf of user $userid
bool$canrevokedoes the current user have permission to revoke the policy on behalf of user $userid

Member Function Documentation

◆ export_for_download()

tool_policy\output\user_agreement::export_for_download ( )

Describe the status with a plain text for downloading purposes.

Return values
string

◆ export_for_template()

tool_policy\output\user_agreement::export_for_template ( \renderer_base $output)

Export data to be rendered.

Parameters
renderer_base$output
Return values
stdClass

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