Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.11.x will end 14 Nov 2022 (12 months plus 6 months extension).
  • Bug fixes for security issues in 3.11.x will end 13 Nov 2023 (18 months plus 12 months extension).
  • PHP version: minimum PHP 7.3.0 Note: minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is supported too.

Differences Between: [Versions 311 and 402] [Versions 311 and 403]

This file contains the functions for managing a users comments quicklist.

Copyright: 2012 Davo Smith
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 94 lines (3 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

comments_quick_list:: (4 methods):
  get_comments()
  add_comment()
  get_comment()
  remove_comment()


Class: comments_quick_list  - X-Ref

This class performs crud operations on a users quicklist comments.

No capability checks are done - they should be done by the calling class.
get_comments()   X-Ref
Get all comments for the current user.

return: array(comment)

add_comment($commenttext, $width, $colour)   X-Ref
Add a comment to the quick list.

param: string $commenttext
param: int $width
param: string $colour
return: stdClass - the comment record (with new id set)

get_comment($commentid)   X-Ref
Get a single comment by id.

param: int $commentid
return: comment or false

remove_comment($commentid)   X-Ref
Remove a comment from the quick list.

param: int $commentid
return: bool