Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Files | Namespaces | Classes | Functions | Variables
assignsubmission_comments

Files

file  access.php
 Capability definitions for this module.
 
file  comment_created.php
 The assignsubmission_comments comment created event.
 
file  comment_deleted.php
 The assignsubmission_comments comment deleted event.
 
file  install.php
 Post-install code for the submission_comments module.
 
file  lib.php
 This file contains the moodle hooks for the submission comments plugin.
 
file  locallib.php
 This file contains the definition for the library class for online comment submission plugin.
 
file  provider.php
 Privacy class for requesting user data.
 
file  upgrade.php
 Upgrade code for install.
 
file  version.php
 This file contains the version information for the comments submission plugin.
 

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. More...
 
 assignsubmission_comments_comment_display ($comments, $options)
 Callback called by comment::get_comments() and comment::add(). More...
 
 assignsubmission_comments_comment_permissions (stdClass $options)
 Permission control method for submission plugin -— required method for AJAXmoodle based comment API. More...
 
 assignsubmission_comments_comment_validate (stdClass $options)
 Callback method for data validation-— required method for AJAXmoodle based comment API. More...
 
 xmldb_assignsubmission_comments_install ()
 Code run after the module database tables have been created. More...
 
 xmldb_assignsubmission_comments_upgrade ($oldversion)
 Stub for upgrade code. More...
 

Variables

 $capabilities
 
 $plugin = 2020060900
 
$plugin component = 'assignsubmission_comments'
 
$plugin version = 2020061500
 

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(
)