assignfeedback_editpdf\comments_quick_list Class Reference

This class performs crud operations on a users quicklist comments. More...

Static Public Member Functions
static	add_comment ($commenttext, $width, $colour)
	Add a comment to the quick list.
static	get_comment ($commentid)
	Get a single comment by id.
static	get_comments ()
	Get all comments for the current user.
static	remove_comment ($commentid)
	Remove a comment from the quick list.

Detailed Description

This class performs crud operations on a users quicklist comments.

No capability checks are done - they should be done by the calling class.

Copyright

2012 Davo Smith

License

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

Member Function Documentation

add_comment()

static assignfeedback_editpdf\comments_quick_list::add_comment ( $commenttext, $width, $colour )

static

Add a comment to the quick list.

Parameters

string	$commenttext
int	$width
string	$colour

Return values

stdClass

- the comment record (with new id set)

get_comment()

static assignfeedback_editpdf\comments_quick_list::get_comment ( $commentid )

static

Get a single comment by id.

Parameters

int

$commentid

Return values

comment

or false

get_comments()

static assignfeedback_editpdf\comments_quick_list::get_comments ( )

static

Get all comments for the current user.

Return values

array(comment)

remove_comment()

static assignfeedback_editpdf\comments_quick_list::remove_comment ( $commentid )

static

Remove a comment from the quick list.

Parameters

int

$commentid

Return values

bool

---

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

• mod/assign/feedback/editpdf/classes/comments_quick_list.php