Moodle PHP Documentation 4.3
Moodle 4.3.5 (Build: 20240610) (7dcfaa79f78)
assignsubmission_comments

Namespaces

namespace  assignsubmission_comments\event
  
 
namespace  assignsubmission_comments\privacy
  
 

Classes

class  assign_submission_comments
 Library class for comment submission plugin extending submission plugin base class. More...
 
class  assignsubmission_comments\event\comment_created
 The assignsubmission_comments comment created event class. More...
 
class  assignsubmission_comments\event\comment_deleted
 The assignsubmission_comments comment deleted event. More...
 
class  assignsubmission_comments\privacy\provider
 Privacy class for requesting user data. More...
 

Functions

 assignsubmission_comments_comment_add (stdClass $comment, stdClass $param)
 Callback to force the userid for all comments to be the userid of the submission and NOT the global $USER->id.
 
 assignsubmission_comments_comment_display ($comments, $options)
 Callback called by comment\get_comments() and comment\add().
 
 assignsubmission_comments_comment_permissions (stdClass $options)
 Permission control method for submission plugin -— required method for AJAXmoodle based comment API.
 
 assignsubmission_comments_comment_validate (stdClass $options)
 Callback method for data validation-— required method for AJAXmoodle based comment API.
 
 xmldb_assignsubmission_comments_install ()
 Code run after the module database tables have been created.
 
 xmldb_assignsubmission_comments_upgrade ($oldversion)
 Stub for upgrade code.
 

Variables

 $capabilities
 
 $plugin = 2023100400
 
$plugin component = 'assignsubmission_comments'
 
$plugin version = 2023100900
 

Detailed Description

Function Documentation

◆ assignsubmission_comments_comment_add()

assignsubmission_comments_comment_add ( stdClass $comment,
stdClass $param )

Callback to force the userid for all comments to be the userid of the submission and NOT the global $USER->id.

This is required by the upgrade code. Note the comment area is used to identify upgrades.

Parameters
stdClass$comment
stdClass$param

◆ assignsubmission_comments_comment_display()

assignsubmission_comments_comment_display ( $comments,
$options )

Callback called by comment\get_comments() and comment\add().

Gives an opportunity to enforce blind-marking.

Parameters
array$comments
stdClass$options
Return values
array
Exceptions
comment_exception

◆ assignsubmission_comments_comment_permissions()

assignsubmission_comments_comment_permissions ( stdClass $options)

Permission control method for submission plugin -— required method for AJAXmoodle based comment API.

Parameters
stdClass$options
Return values
array

◆ assignsubmission_comments_comment_validate()

assignsubmission_comments_comment_validate ( stdClass $options)

Callback method for data validation-— required method for AJAXmoodle based comment API.

Parameters
stdClass$options
Return values
bool

◆ xmldb_assignsubmission_comments_install()

xmldb_assignsubmission_comments_install ( )

Code run after the module database tables have been created.

Moves the comments plugin to the bottom

Return values
bool

◆ xmldb_assignsubmission_comments_upgrade()

xmldb_assignsubmission_comments_upgrade ( $oldversion)

Stub for upgrade code.

Parameters
int$oldversion
Return values
bool

Variable Documentation

◆ $capabilities

$capabilities
Initial value:
= array(
)