qbank_comment

Directories
directory	backup

Files
file	access.php
	Capability definitions for this module.
file	backup_qbank_comment_plugin.class.php
	Provides the information to backup question comments.
file	behat_qbank_comment.php
	Commenting system steps definitions for question.
file	comment_count_column.php
	A column to show the number of comments.
file	comment_created.php
	qbank_comment comment created event.
file	comment_deleted.php
	qbank_comment comment deleted event.
file	lib.php
	Helper functions and callbacks.
file	plugin_feature.php
	Class plugin_features is the entrypoint for the columns.
file	provider.php
	Privacy Subsystem for qbank_comment.
file	renderer.php
	Class renderer for comment.
file	restore_qbank_comment_plugin.class.php
	Restore plugin class that provides the necessary information needed to restore comments for questions.
file	version.php
	Version information for qbank_comment.

Namespaces
namespace	qbank_comment
namespace	qbank_comment\event
namespace	qbank_comment\output
namespace	qbank_comment\privacy

Classes
class	backup_qbank_comment_plugin
class	behat_qbank_comment
	Steps definitions to deal with the commenting system in question. More...
class	qbank_comment\comment_count_column
class	qbank_comment\event\comment_created
class	qbank_comment\event\comment_deleted
class	qbank_comment\output\renderer
class	qbank_comment\plugin_feature
class	qbank_comment\privacy\provider
class	restore_qbank_comment_plugin

Functions
	qbank_comment_comment_display ($comments, $args)
	Validate comment data before displaying comments.
	qbank_comment_comment_permissions ($args)
	Running additional permission check on plugins.
	qbank_comment_comment_validate ($commentparam)
	Validate comment parameter before perform other comments actions.
	qbank_comment_output_fragment_question_comment ($args)
	Question comment fragment callback.
	qbank_comment_preview_display ($question, $courseid)
	Comment content for callbacks.

Variables
	$capabilities
	$plugin = 2023041800
$plugin	component = 'qbank_comment'
$plugin	maturity = MATURITY_STABLE
$plugin	version = 2023042400

Detailed Description

Function Documentation

qbank_comment_comment_display()

qbank_comment_comment_display	(		$comments,
			$args
	)

Validate comment data before displaying comments.

Parameters

array	$comments
stdClass	$args

Return values

array::$comments

qbank_comment_comment_permissions()

qbank_comment_comment_permissions

(

$args

)

Running additional permission check on plugins.

Parameters

stdClass

$args

Return values

array

qbank_comment_comment_validate()

qbank_comment_comment_validate

(

$commentparam

)

Validate comment parameter before perform other comments actions.

Parameters

stdClass

$commentparam

{ context => context the context object courseid => int course id cm => stdClass course module object commentarea => string comment area itemid => int itemid }

Return values

boolean

qbank_comment_output_fragment_question_comment()

qbank_comment_output_fragment_question_comment

(

$args

)

Question comment fragment callback.

Parameters

array

$args

Return values

string

rendered output

qbank_comment_preview_display()

qbank_comment_preview_display	(		$question,
			$courseid
	)

Comment content for callbacks.

Parameters

question_definition	$question
int	$courseid

Return values

string

Variable Documentation

$capabilities

$capabilities

Initial value:

= [
        
        'moodle/question:commentmine' => [
                'captype' => 'write',
                'contextlevel' => CONTEXT_COURSE,
                'archetypes' => [
                        'editingteacher' => CAP_ALLOW,
                        'manager' => CAP_ALLOW
                ],
                'clonepermissionsfrom' => 'moodle/question:editmine'
        ],
 
        
        'moodle/question:commentall' => [
                'captype' => 'write',
                'contextlevel' => CONTEXT_COURSE,
                'archetypes' => [
                        'editingteacher' => CAP_ALLOW,
                        'manager' => CAP_ALLOW
                ],
                'clonepermissionsfrom' => 'moodle/question:editall'
        ],
]