Comment API - Revision history

Mits: ja link

2023-05-19T15:08:41Z

ja link

← Older revision		Revision as of 15:08, 19 May 2023
Line 195:		Line 195:

	[[Category:API]]		[[Category:API]]

			[[ja:コメントAPI]]

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T13:26:59Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 13:26, 14 July 2021
				
Line 76:
Line 76:
For example, using the following code in the forum module will add a comment icon to every post: For example, using the following code in the forum module will add a comment icon to every post:



<code php> <syntaxhighlight lang="php">
$cmt = new stdclass; $cmt = new stdclass;
$cmt->contextid = $modcontext->id; $cmt->contextid = $modcontext->id;
Line 87:
Line 87:
===Use comment class=== ===Use comment class===
To use Comment API elsewhere, using following code: To use Comment API elsewhere, using following code:
<code php> <syntaxhighlight lang="php">
$options->area    = 'database_entry'; $options->area    = 'database_entry';
$options->context = $context; $options->context = $context;



Mudrd8mz: Text replacement - "class="nicetable"" to "class="wikitable""
2021-07-14T13:22:30Z
Text replacement - "class="nicetable"" to "class="wikitable""

				
				
				
				
				
				← Older revision
				Revision as of 13:22, 14 July 2021
				
Line 20:
Line 20:
==Comment API database table== ==Comment API database table==



{| class="nicetable" {| class="wikitable"
|- |-
! Field ! Field

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T13:06:58Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 13:06, 14 July 2021
Line 83:		Line 83:
	$options->comments = $cmt;		$options->comments = $cmt;
	echo format_text($post->message, $post->messageformat, $options, $course->id)."<hr />";		echo format_text($post->message, $post->messageformat, $options, $course->id)."<hr />";
	</~~code~~>		</syntaxhighlight>

	===Use comment class===		===Use comment class===
Line 95:		Line 95:
	$comment = new comment($options);		$comment = new comment($options);
	$comment->output(false);		$comment->output(false);
	</~~code~~>		</syntaxhighlight>

	==Comment API overview==		==Comment API overview==

FMCorz: Adding component to example.

2015-10-16T06:26:14Z

Adding component to example.

← Older revision		Revision as of 06:26, 16 October 2015
Line 87:		Line 87:
	===Use comment class===		===Use comment class===
	To use Comment API elsewhere, using following code:		To use Comment API elsewhere, using following code:
	~~<code php>~~
	~~$options->area = 'database_entry';~~
	~~$options->context = $context;~~
	~~$options->itemid = $record->id;~~
	~~$options->showcount = true;~~
	~~$comment = new comment($options);~~
	~~$comment->output(false);~~
	~~</code>~~
	~~If you are using Comment API in module context, you'd better add component option, it will help comment API find callback functions faster:~~
	<code php>		<code php>
	$options->area = 'database_entry';		$options->area = 'database_entry';
Line 105:		Line 96:
	$comment->output(false);		$comment->output(false);
	</code>		</code>

	==Comment API overview==		==Comment API overview==

Damyon: /* Backup and Restore */

2012-02-17T02:36:17Z

Backup and Restore

← Older revision		Revision as of 02:36, 17 February 2012
Line 189:		Line 189:
	The template must have 4 embedding variables, ___id___, ___content___, ___time___, ___name___, they will be replaced with html id, comments content, comment time and commenter name		The template must have 4 embedding variables, ___id___, ___content___, ___time___, ___name___, they will be replaced with html id, comments content, comment time and commenter name

	=== Backup and Restore ===		== Backup and Restore ==
	Comments will automatically be included in the activity/course backups and restored provided the itemids can be updated during the restore process. To do this either:		Comments will automatically be included in the activity/course backups and restored provided the itemids can be updated during the restore process. To do this either:

Line 196:		Line 196:
	* override the function "get_comment_mapping_itemname" in the restore activity class		* override the function "get_comment_mapping_itemname" in the restore activity class

	If you do not do one of these the comments will be silently ignored on restore.		If you do not do one of these the comments will be silently ignored on restore.


	==See also==		==See also==

Damyon: Notes on backup and restore for comments api

2012-02-17T02:35:54Z

Notes on backup and restore for comments api

@@ Line 188: / Line 188: @@
 Modules can implement a function named '''pluginname_comment_template''', which allow modules define a comment template.
 The template must have 4 embedding variables, ___id___, ___content___, ___time___, ___name___, they will be replaced with html id, comments content, comment time and commenter name
 ==See also==

Dougiamas: /* See also */

2012-01-25T08:55:12Z

Gerrywastaken: Undo revision 31238 by Gerrywastaken (talk)

2012-01-11T09:02:46Z

Undo revision 31238 by Gerrywastaken (talk)

Show changes

Gerrywastaken: Adding template for documentation

2012-01-11T09:01:42Z

Adding template for documentation