Rewrite Comment API

2021-06-15T13:31:16Z

Mgauk: Created page with "{{Infobox Project |name = Rewrite Comment API |state = Development in progress |tracker = MDL-71935 |discussion = https://moodle.org/mod/forum/discuss.php?d=423482 |assignee =..."

{{Infobox Project
|name = Rewrite Comment API
|state = Development in progress
|tracker = MDL-71935
|discussion = https://moodle.org/mod/forum/discuss.php?d=423482
|assignee = Martin Gauk and Lars Bonczek (TU Berlin, innoCampus)
}}
{{Moodle_4.0}}

This is a project to rewrite the Comment API.

== Database Structure ==
=== comments ===

This table keeps information about posted comments.

{| border="1" cellpadding="2" cellspacing="0"
|'''Field'''
|'''Type'''
|'''Default'''
|'''Info'''
|-
|'''id'''
|int(10)
|
|autoincrementing
|-
|'''contextid'''
|int(10)
|
|the id of the context this was posted in
|-
|'''component'''
|varchar(100)
|<center>NULL</center>
|the plugin this comment belongs to
|-
|'''commentarea'''
|varchar(100)
|
|the comment area this was posted in
|-
|'''itemid'''
|int(10)
|
|the itemid this belongs to
|-
|'''content'''
|text
|
|this comment's text content
|-
|'''format'''
|int(2)
|
|the text format
|-
|'''userid'''
|int(10)
|
|the id of the user who posted this comment
|-
|'''usermodified'''
|int(10)
|
|the id of the user who last modified this comment
|-
|'''pseudonym'''
|varchar(100)
|<center>NULL</center>
|the pseudonym specified when the comment was posted
|-
|'''timecreated'''
|int(10)
|
|the time when this comment was posted
|-
|'''timemodified'''
|int(10)
|
|the time when this comment was last modified
|-
|'''replytoid'''
|int(10)
|<center>NULL</center>
|the id of the comment this is a reply to
|-
|'''replies'''
|int(10)
|0
|the number of replies to this comment
|-
|'''upvotes'''
|int(10)
|0
|the number of upvotes on this comment
|-
|'''customdata'''
|text
|
|the JSON-encoded custom data associated with this comment
|}

=== comments_queue ===

This table keeps track of comments that will be mailed in digest form.

{| border="1" cellpadding="2" cellspacing="0"
|'''Field'''
|'''Type'''
|'''Default'''
|'''Info'''
|-
|'''id'''
|int(10)
|
|autoincrementing
|-
|'''userid'''
|int(10)
|
|the id of the user to notify
|-
|'''commentid'''
|int(10)
|
|the id of the comment to notify about
|-
|'''timemodified'''
|int(10)
|
|the timestamp when this record was last modified
|}

=== comments_subscriptions ===

This table keeps track of subscriptions to comments or comment sections.

{| border="1" cellpadding="2" cellspacing="0"
|'''Field'''
|'''Type'''
|'''Default'''
|'''Info'''
|-
|'''id'''
|int(10)
|
|autoincrementing
|-
|'''userid'''
|int(10)
|
|the id of the user to notify
|-
|'''contextid'''
|int(10)
|
|subscribe to comments in this context
|-
|'''component'''
|varchar(100)
|
|subscribe to comments belonging to this component
|-
|'''commentarea'''
|varchar(100)
|
|subscribe to comments belonging to this commentarea
|-
|'''itemid'''
|int(10)
|<center>NULL</center>
|subscribe to comments with this itemid
|-
|'''commentid'''
|int(10)
|<center>NULL</center>
|subscribe to replies to this comment
|-
|'''subscription'''
|int(2)
|
|the subscription type (0 off, 1 immediate, 2 digests, -1 default)
|-
|'''timemodified'''
|int(10)
|
|the timestamp when this record was last modified
|}

=== comments_votes ===

This table keeps track of votes on comments.

{| border="1" cellpadding="2" cellspacing="0"
|'''Field'''
|'''Type'''
|'''Default'''
|'''Info'''
|-
|'''id'''
|int(10)
|
|autoincrementing
|-
|'''userid'''
|int(10)
|
|the id of the user who voted
|-
|'''commentid'''
|int(10)
|
|the id of the comment that was voted for
|-
|'''vote'''
|int(2)
|
|the vote (0 no vote, 1 upvote)
|}

MoodleDocs - User contributions [en]

Rewrite Comment API