Development:Comments 2.0 - Revision history

Dongsheng: /* Moodle modules callback */

2011-05-04T12:14:29Z

Moodle modules callback

← Older revision		Revision as of 12:14, 4 May 2011
Line 146:		Line 146:
	== Moodle modules callback ==		== Moodle modules callback ==
	Comments API allows modules/blocks/blog to decide how comments display.		Comments API allows modules/blocks/blog to decide how comments display.

			=== Data validation ===
			Plugins must implement pluginname_comment_validate callback to validate comments parameters, it must return true to pass validation.

	===Permission control===		===Permission control===
	Modules ~~can~~ implement a function ~~named~~ '''~~modname_comment_permissions~~''' to ~~control~~ post and view permission.		Modules must implement function '''pluginname_comment_permissions''' to return post and view permission.

	Blocks need to overwrite '''~~comment_permissions~~''' function of block_base.		Blocks need to overwrite '''blockname_comment_permissions''' function of block_base.

	Blog need to implement '''blog_comment_permissions''' function.		Blog need to implement '''blog_comment_permissions''' function.
Line 163:		Line 166:
	Modules can implement a function named '''modname_comment_add'''.		Modules can implement a function named '''modname_comment_add'''.

	Blocks need to overwrite '''~~comment_add~~''' function.		Blocks need to overwrite '''blockname_comment_add''' function.

	Blog need to implement '''blog_comment_add''' function.		Blog need to implement '''blog_comment_add''' function.
Line 172:		Line 175:
	This callback allows modules check/format comments when user request to display comments.		This callback allows modules check/format comments when user request to display comments.

	It takes the same arguments as ~~modname_comment_add~~		It takes the same arguments as pluginname_comment_add

	Modules can implement a function named '''~~modname_comment_display~~'''.		Modules can implement a function named '''pluginname_comment_display'''.

	Blocks need to overwrite '''~~comment_display~~''' function.		Blocks need to overwrite '''blockname_comment_display''' function.

	Blog need to implement '''blog_comment_display''' function.		Blog need to implement '''blog_comment_display''' function.
Line 183:		Line 186:

	=== Define a comment template ===		=== Define a comment template ===
	Modules can implement a function named '''~~modname_comment_template~~''', which allow modules define a comment template.		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		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==		==See also==
	* MDL-19118 - Comments 2.0 issue		* MDL-19118 - Comments 2.0 issue

Dongsheng at 07:17, 25 August 2010

2010-08-25T07:17:22Z

← Older revision		Revision as of 07:17, 25 August 2010
Line 101:		Line 101:
	$options->context = $context;		$options->context = $context;
	$options->itemid = $record->id;		$options->itemid = $record->id;
			$options->component = 'mod_data';
	$options->showcount = true;		$options->showcount = true;
	$comment = new comment($options);		$comment = new comment($options);

Tsala: {{Moodle 2.0}}

2010-08-09T13:47:10Z

← Older revision		Revision as of 13:47, 9 August 2010
Line 1:		Line 1:
	==Objectives==		{{Moodle 2.0}}==Objectives==

	The goals of comments 2.0:		The goals of comments 2.0:

Dongsheng at 03:21, 11 May 2010

2010-05-11T03:21:04Z

← Older revision		Revision as of 03:21, 11 May 2010
Line 95:		Line 95:
	$comment->output(false);		$comment->output(false);
	</code>		</code>
			If you are using comments API in module context, you'd better add pluginname option, it will help comments API find callback functions faster:
			<code php>
			$options->area = 'database_entry';
			$options->pluginname = 'data';
			$options->context = $context;
			$options->itemid = $record->id;
			$options->showcount = true;
			$comment = new comment($options);
			$comment->output(false);
			</code>
	==Comments API overview==		==Comments API overview==

Line 135:		Line 144:

	== Moodle modules callback ==		== Moodle modules callback ==
	Comments API allows modules/blocks/blog to how comments display.		Comments API allows modules/blocks/blog to decide how comments display.

	===Permission control===		===Permission control===
Line 148:		Line 157:
	=== Check new added comment ===		=== Check new added comment ===
	The callback function allows you to change the comment content before inserting into database or reject this comment.		The callback function allows you to change the comment content before inserting into database or reject this comment.

			It takes two arguments, the comment object which contains comment details, and $params which contains context and course information.

	Modules can implement a function named '''modname_comment_add'''.		Modules can implement a function named '''modname_comment_add'''.
Line 154:		Line 165:

	Blog need to implement '''blog_comment_add''' function.		Blog need to implement '''blog_comment_add''' function.

			This function should return a boolean value.

	=== Filter/format comments ===		=== Filter/format comments ===
	This callback allows modules check/format comments when user request to display comments.		This callback allows modules check/format comments when user request to display comments.

			It takes the same arguments as modname_comment_add

	Modules can implement a function named '''modname_comment_display'''.		Modules can implement a function named '''modname_comment_display'''.
Line 164:		Line 179:
	Blog need to implement '''blog_comment_display''' function.		Blog need to implement '''blog_comment_display''' function.

			It will return the comment object.

	=== Define a comment template ===		=== Define a comment template ===

Dongsheng at 07:49, 15 March 2010

2010-03-15T07:49:00Z

Show changes

Dongsheng at 04:19, 24 July 2009

2009-07-24T04:19:30Z

← Older revision		Revision as of 04:19, 24 July 2009
Line 105:		Line 105:
	====delete($id)====		====delete($id)====
	delete a comment		delete a comment

	~~====edit($id, $content)====~~
	~~Edit a comment~~

	==Javascript API==		==Javascript API==
Line 115:		Line 112:
	Submit a comment		Submit a comment

	===~~display_comments~~(~~event~~, contextid, comment_area, itemid, page~~, client_id~~)===		===view_comments(client_id, contextid, comment_area, itemid, page)===
	Display comments, will call get_cmt to load comments.		Display comments, will call get_cmt to load comments.

	===get_comments(ctx, area, itemid, page~~, client_id~~)===		===get_comments(client_id, ctx, area, itemid, page)===
	Load comments by AJAX		Load comments by AJAX

	== Moodle modules callback ==		== Moodle modules callback ==
	Comments API ~~needs to allow~~ modules controlling comments		Comments API allows modules/blocks/blog controlling comments

	===Permission control===		===Permission control===
	Modules can implement a function named '''modname_comment_permissions''' to control post and view permission.		Modules can implement a function named '''modname_comment_permissions''' to control post and view permission.

			Blocks need to overwrite '''comment_permissions''' function of block_base.

			Blog need to implement '''blog_comment_permissions''' function.

	This function will return an array: array('post'=>true, 'view'=>true)		This function will return an array: array('post'=>true, 'view'=>true)

	=== Check new added~~/edited~~ comment ===		=== Check new added comment ===
	Modules can implement a function named '''modname_comment_add'''~~, comments~~ API will pass the comment to this function which allow modules check/modify comments content, or reject this comment.		Modules can implement a function named '''modname_comment_add'''.

			Blocks need to overwrite '''comment_add''' function.

			Blog need to implement '''blog_comment_add''' function.

			Comments API will pass the comment to this function which allow modules check/modify comments content, or reject this comment.

	=== Filter/format comments ===		=== Filter/format comments ===
	Modules can implement a function named '''modname_comment_display'''~~, which allow~~ modules check/format comments when user request to display comments.		Modules can implement a function named '''modname_comment_display'''.

			Blocks need to overwrite '''comment_display''' function.

			Blog need to implement '''blog_comment_display''' function.

			This callback allows modules check/format comments when user request to display comments.

	=== Define a comment template ===		=== Define a comment template ===
	Modules can implement a function named '''modname_comment_template''', which allow modules define a comment template.		Modules can implement a function named '''modname_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		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


			=== get original url ===


	==Interface==		==Interface==

Dongsheng at 10:19, 10 July 2009

2009-07-10T10:19:47Z

← Older revision		Revision as of 10:19, 10 July 2009
Line 112:		Line 112:
	Can be found in lib/comment.js		Can be found in lib/comment.js

	===~~post_cmt~~(client_id)===		===post_comment(client_id)===
	Submit a comment		Submit a comment

	===~~display_cmt~~(event, contextid, comment_area, itemid, page, client_id)===		===display_comments(event, contextid, comment_area, itemid, page, client_id)===
	Display comments, will call get_cmt to load comments.		Display comments, will call get_cmt to load comments.

	===~~get_cmt~~(ctx, area, itemid, page, client_id)===		===get_comments(ctx, area, itemid, page, client_id)===
	Load comments by AJAX		Load comments by AJAX

Dongsheng at 06:37, 10 July 2009

2009-07-10T06:37:29Z

← Older revision		Revision as of 06:37, 10 July 2009
Line 112:		Line 112:
	Can be found in lib/comment.js		Can be found in lib/comment.js

	===~~do_comment~~(client_id)===		===post_cmt(client_id)===
	Submit a comment		Submit a comment

	===~~show_comments~~(event, contextid, comment_area, itemid, page, client_id)===		===display_cmt(event, contextid, comment_area, itemid, page, client_id)===
	Display comments, will call get_cmt to load comments.		Display comments, will call get_cmt to load comments.

Line 125:		Line 125:

	===Permission control===		===Permission control===
	Modules can implement a function named '''~~modname_check_comment_permissions~~''' to control post and view permission.		Modules can implement a function named '''modname_comment_permissions''' to control post and view permission.
	This function will return an array: array('post'=>true, 'view'=>true)		This function will return an array: array('post'=>true, 'view'=>true)

Line 132:		Line 132:

	=== Filter/format comments ===		=== Filter/format comments ===
	Modules can implement a function named '''~~modname_comments_filter~~''', which allow modules check/format comments when user request to display comments.		Modules can implement a function named '''modname_comment_display''', which allow modules check/format comments when user request to display comments.

	=== Define a comment template ===		=== Define a comment template ===

Dongsheng: /* Moodle modules callback */

2009-07-08T06:48:33Z

Moodle modules callback

← Older revision		Revision as of 06:48, 8 July 2009
Line 128:		Line 128:
	This function will return an array: array('post'=>true, 'view'=>true)		This function will return an array: array('post'=>true, 'view'=>true)

	=== Check new added comment ===		=== Check new added/edited comment ===
	Modules can implement a function named '''modname_comment_add''', comments API will pass the comment to this function which allow modules check/modify comments content, or reject this comment.		Modules can implement a function named '''modname_comment_add''', comments API will pass the comment to this function which allow modules check/modify comments content, or reject this comment.

Dongsheng: /* Moodle modules callback */

2009-07-08T06:04:18Z

Moodle modules callback

← Older revision		Revision as of 06:04, 8 July 2009
Line 125:		Line 125:

	===Permission control===		===Permission control===
	Modules can implement ~~two~~ function named '''~~modname_check_comment_post''' and '''modname_check_comment_view~~''' to control post and view permission ~~respectively~~.		Modules can implement a function named '''modname_check_comment_permissions''' to control post and view permission.
			This function will return an array: array('post'=>true, 'view'=>true)

	=== Check new added comment ===		=== Check new added comment ===
Line 133:		Line 134:
	Modules can implement a function named '''modname_comments_filter''', which allow modules check/format comments when user request to display comments.		Modules can implement a function named '''modname_comments_filter''', which allow modules check/format comments when user request to display comments.

			=== Define a comment template ===
			Modules can implement a function named '''modname_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

	==Interface==		==Interface==