Integrating the Comment Engine - Revision history

Tom: /* Comment Submission Queue */

2013-01-02T19:45:22Z

‎Comment Submission Queue

Dirk: plugin_savecomment and the comment submission queue

2009-11-21T17:46:46Z

plugin_savecomment and the comment submission queue

Dirk: Typos

2009-05-23T20:07:52Z

Typos

Dirk: Fixed formatting

2009-05-06T08:03:00Z

Fixed formatting

Show changes

Dirk: added Category:Plugin Developers Handbook

2009-05-05T08:45:54Z

added Category:Plugin Developers Handbook

LWC: /* V1.4.0-present */

2008-06-30T00:15:39Z

‎V1.4.0-present

LWC: /* V1.4.0-present */

2008-06-30T00:12:22Z

‎V1.4.0-present

LWC: /* The functions */ For efficiency

2008-06-30T00:10:59Z

‎The functions: For efficiency

LWC: /* Saving/deleting the comments */ Another 1.4 function

2008-06-29T19:56:00Z

‎Saving/deleting the comments: Another 1.4 function

LWC: Old 1.3 instructions

2008-06-29T00:05:31Z

Old 1.3 instructions

@@ Line 64: / Line 64: @@
      if ($ret > 0) {
          // error handling goes here
      } else { // success
          $msg = '';

@@ Line 52: / Line 52: @@
 |-
 |}
 ==== V1.3.7-1.3.X ====

@@ Line 1: / Line 1: @@
 This section describes and documents how to enable your plugin to use the
-Geeklog comment engine. This is a key feature or plugin functionality for many developers and  not very difficult to integrate into your project. The Geeklog developers have made this very straight forward and enabled the API calls into comment related core programs.
+Geeklog comment engine. This is a key feature or plugin functionality for many developers and  not very difficult to integrate into your project. The Geeklog developers have made this very straightforward and enabled the API calls into comment related core programs.
 '''NOTE: '''You will need to use Geeklog version 1.3.7 or above. Otherwise you'd have to apply [[#Outdated versions|the new comment features]] yourself.
@@ Line 9: / Line 9: @@
 === Displaying the commentbar within the plugin ===
-The plugin simply needs to pass the right parameters to CMT_userComments. Until v1.3.0 it was called COM_userComments. For backward compatibility, COM_userComments still exists now now as a redirect function. Nevertheless, CMT_userComments accepts one more parameter (comments allowed: yes/no/closed) than COM_userComments, so it's best to do:
+The plugin simply needs to pass the right parameters to CMT_userComments. Until v1.3.0 it was called COM_userComments. For backward compatibility, COM_userComments still exists now as a redirect function. Nevertheless, CMT_userComments accepts one more parameter (comments allowed: yes/no/closed) than COM_userComments, so it's best to do:
 <pre>
      if (floatval (VERSION) < 1.4) {

@@ Line 1: / Line 1: @@
 This section describes and documents how to enable your plugin to use the
-Geeklog comment engine. This is a key feature or plugin functionality for many
+Geeklog comment engine. This is a key feature or plugin functionality for many developers and  not very difficult to integrate into your project. The Geeklog developers have made this very straight forward and enabled the API calls into comment related core programs.
 '''NOTE: '''You will need to use Geeklog version 1.3.7 or above. Otherwise you'd have to apply [[#Outdated versions|the new comment features]] yourself.
@@ Line 69: / Line 66: @@
 |plugin_commentparent_&lt;plugin name&gt;
 ||Optional function which can be called from your plugin_commentform function to  display the plugin parent record above the comments. This is how Geeklog articles are displayed with the story and then the comment bar and associated comments.
-<br><b>Note:</b> this function is not called by the GeekLog core; use of it is solely within the plugin.
+<br><b>Note:</b> this function is not called by the Geeklog core; use of it is solely within the plugin.
 |-
 |}
@@ Line 98: / Line 95: @@
 comment engine was initially designed around articles and stories; but no fear,
 the integration will be clean.&nbsp; The ID that our plugin uses as a reference
-will be passed thru comment.php to your plugin comment functions.
+will be passed through comment.php to your plugin comment functions.
 The following is a second example of enabling comment to the Journal Plugin.
@@ Line 163: / Line 160: @@
 </pre>
-) The''''' handlecomment''''' function is called by comment.php to
+) The ''''' handlecomment''''' function is called by comment.php to
 update your plugin record's field for total number of comments. You will need to
 add a field in your plugins record but this is useful to quickly determine if
@@ Line 199: / Line 196: @@
 comment bar.
-The comment count for this plugin related record is retrieved to determine if this is the first
+The comment count for this plugin related record is retrieved to determine if this is the first comment for this plugin item.
-*If this is the first comment then redirect execution to comment.php and pass a valid''' sid''' set to the unique plugin item id, the plugin key for this comment  and '''type''' set to the plugin name.
+* If this is the first comment then redirect execution to comment.php and pass a valid''' sid''' set to the unique plugin item id, the plugin key for this comment  and '''type''' set to the plugin name.
-*If this is not the first comment then you call COM_userComments. You can additionally call a function to display the plugin record above the comment bar and comments. In the example function, the return variable is being assigned the formatted HTML of the siteHeader, the plugin record and the results of the comments and finally the site footer. In the comment display, the user has access to the comment bar to start a new comment or use the reply links under any comment.
+* If this is not the first comment then you call COM_userComments. You can additionally call a function to display the plugin record above the comment bar and comments. In the example function, the return variable is being assigned the formatted HTML of the siteHeader, the plugin record and the results of the comments and finally the site footer. In the comment display, the user has access to the comment bar to start a new comment or use the reply links under any comment.
 <pre>
@@ Line 234: / Line 230: @@
 were used for the Journal Plugin:
-In this example, the commentparent function was not required as the existing
+In this example, the commentparent function was not required as the existing Journal logic to display the Journal record was already written as a function - printjournalentry($id)
-Ensure that you replace $type in the plugin_commentform() function with the
+Ensure that you replace $type in the plugin_commentform() function with the plugin name.
 <pre>
@@ Line 275: / Line 268: @@
 ====Outdated versions====
-In v1.3.7, Geeklog got the new API function PLG_callCommentForm in lib-plugins and had relevant changes in
+In v1.3.7, Geeklog got the new API function PLG_callCommentForm in lib-plugins and had relevant changes in comment.php and article.php (all of which were dropped in v1.4.0 in favor of better API).
 This section describes how to enable comment support manually if you want a plugin to have comments enabled in your Geeklog version that is below 1.3.7.
@@ Line 282: / Line 274: @@
 ''(anyone who reads this can feel free to add this part).''
 [[Category:Plugin Development]]

@@ Line 38: / Line 38: @@
 |align="center"| 3
 || function plugin_displaycomment__&lt;plugin name&gt;($id, $cid, $title, $order, $format, $page, $view)
-|| This function is called when Geeklog is asked to display a direct comment URL (when the user directly clicked a comment's link). If you put [[#Displaying the commentbar|Displaying the commentbar]] inside an internal function, you can make function plugin_displaycomment__&lt;plugin name&gt; nothing but a redirect (with the addition of a $cid>0) to your internal function.
+|| This function is called when Geeklog is asked to display a direct comment URL (when the user directly clicked a comment's link).
 |-
 |}

@@ Line 19: / Line 19: @@
+      }
 ====V1.4.0-present====
-It is best to put the following code inside the already needed [[#V1.4.0-present_2|function plugin_displaycomment__&lt;plugin name&gt;]], and just call that function from within the plugin (or better yet, function PLG_displayComment) whenever the following code is needed.
+It is best to put the following code inside the already needed [[#V1.4.0-present_2|function plugin_displaycomment__&lt;plugin name&gt;]], and just call that function from within the plugin - or better yet, function PLG_displayComment($plugin, ...) - whenever the following code is needed.
 ===Saving/deleting/handling comments===
 ====V1.4.0-present====

@@ Line 8: / Line 8: @@
 ==The functions==
-===Displaying the commentbar===
+===Displaying the commentbar within the plugin===
 The plugin simply needs to pass the right parameters to CMT_userComments. Until v1.3.0 it was called COM_userComments. For backward compatibility, COM_userComments still exists now now as a redirect function. Nevertheless, CMT_userComments accepts one more parameter (comments allowed: yes/no/closed) than COM_userComments, so it's best to do:
      if (floatval (VERSION) < 1.4) {
@@ Line 18: / Line 18: @@
            $display .= CMT_userComments(..., !$this_plugin_accepts_comments);
+      }
+====V1.4.0-present====
 ===Saving/deleting/handling comments===
 ====V1.4.0-present====

@@ Line 19: / Line 19: @@
+      }
-===Saving/deleting the comments===
+===Saving/deleting/handling comments===
 ====V1.4.0-present====
-There are two (2) plugin functions that you need to have:
+There are three (3) plugin functions that you need to have:
 {| border=1
@@ Line 33: / Line 33: @@
 || function plugin_deletecomment_&lt;plugin name&gt;($cid, $id)
 || This function is called when Geeklog is asked to delete a comment from this plugin.
 |-
 |}

@@ Line 65: / Line 65: @@
 |}
-== How to call the Comment Engine ==
+===== How to call the Comment Engine =====
 After you implement the comment functions in your plugin, you will need to call
@@ Line 120: / Line 120: @@
 main comment that it is related to.
-== Plugin database changes ==
+===== Plugin database changes =====
 You will want to add a field in your plugin to keep track of the number of
@@ Line 126: / Line 126: @@
 used to quickly check if there are any comments.
-== Function details and examples ==
+===== Function details and examples =====
 This explanation of the plugin comment functions will use the FileMgmt plugin and step
@@ Line 220: / Line 220: @@
+}
 </pre>
 ) The '''''commentparent''''' function is plugin specific and is really code that you likely already have to display a single record for your plugin. You may even call one of your existing plugin functions and not have to create it in the functions.inc file.
@@ Line 267: / Line 266: @@
 </pre>
-==Outdated versions==
+====Outdated versions====
 In v1.3.7, Geeklog got the new API function PLG_callCommentForm in lib-plugins and had relevant changes in
-comment.php and article.php.
+comment.php and article.php (all of which were dropped in v1.4.0 in favor of better API).
-This section describes how to apply those changes manually if you want a plugin to have comments enabled in your Geeklog version that is below 1.3.7.
+This section describes how to enable comment support manually if you want a plugin to have comments enabled in your Geeklog version that is below 1.3.7.
 ''(anyone who reads this can feel free to add this part).''
 [[Category:Plugin Development]]