Changeset 31558 for main/trunk/greenstone3/web/interfaces/default/js/user_comments.js

Timestamp:

2017-03-31T19:42:22+13:00 (7 years ago)

Author:

ak19

Message:

1. gs.functions should not be declared as new Array() as its array features are not being used (and if it were an array, declare using the array literal notation =[] which is faster). gs.functions is now declared as a JavaScript object since that's how it's being used with functions getting attached to gs.functions as properties. 2. callMetadataServer and helper functions are now getting attached to the gs.functions object by being declared as gs.functions.callMetadataServer, instead of being global functions attached to the browser window object. 3. Similarly, user_comments.js attaches its functions to gs.usercomments rather than leaving them global as before.

File:

• main/trunk/greenstone3/web/interfaces/default/js/user_comments.js (modified) (12 diffs)

main/trunk/greenstone3/web/interfaces/default/js/user_comments.js

@@ -5 +5 @@
 // http://stackoverflow.com/questions/8714472/cant-pass-event-to-addeventlistener-closure-issue
 // https://www.sitepoint.com/demystifying-javascript-closures-callbacks-iifes/
+// http://stackoverflow.com/questions/4869712/new-without-delete-on-same-variable-in-javascript
+// http://stackoverflow.com/questions/7375120/why-is-arr-faster-than-arr-new-array
+// http://stackoverflow.com/questions/874205/what-is-the-difference-between-an-array-and-an-object
+// http://stackoverflow.com/questions/33514915/what-s-the-difference-between-and-while-declaring-a-javascript-array
+// http://www.nfriedly.com/techblog/2009/06/advanced-javascript-objects-arrays-and-array-like-objects/
 
 /***************
 * USER COMMENTS
 ****************/
+
+gs.usercomments = {};
+
 // http://stackoverflow.com/questions/6312993/javascript-seconds-to-time-with-format-hhmmss
 // Call as: alert(timestamp.printTime());
-function formatTime(timestamp) {
+gs.usercomments.formatTime = function(timestamp) {
     var int_timestamp    = parseInt(timestamp, 10); // don't forget the second param
     var date = new Date(int_timestamp);
@@ -17 +25 @@
 }
 
-function loadUserComments() {
+gs.usercomments.loadUserComments = function() {
 
     // don't bother loading comments if we're not on a document page (in which case there's no docid)
@@ -74 +82 @@
     //var json_result_str = gs.functions.getMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "index");
 
-    gs.functions.getMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "index", loadedUserComments, false); // false for asynchronous
-}
-
-function loadedUserComments(data)
+    gs.functions.getMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "index", gs.usercomments.loadedUserComments, false); // false for asynchronous
+}
+
+gs.usercomments.loadedUserComments = function(data)
 {
     // don't bother displaying comments if we're not on a document page
@@ -141 +149 @@
         
         // for each usercomment, create a child div with the username, timestamp and comment
-        displayInUserCommentList(usercommentdiv, username, timestamp, comment);
+        gs.usercomments.displayInUserCommentList(usercommentdiv, username, timestamp, comment);
         
         i++;
@@ -155 +163 @@
 
 
-function displayInUserCommentList(usercommentdiv, username, timestamp, comment) {
+gs.usercomments.displayInUserCommentList = function(usercommentdiv, username, timestamp, comment) {
     
     //alert("Comment: " + username + " " + timestamp + " " + comment);
@@ -174 +182 @@
     
     divgroup.appendChild(divtime);
-    txt=document.createTextNode(formatTime(timestamp)); // format timestamp for date/time display
+    txt=document.createTextNode(gs.usercomments.formatTime(timestamp)); // format timestamp for date/time display
     divtime.appendChild(txt);
     
@@ -193 +201 @@
 // Unused. Replaced in favour of call to escape() in setMetaArray function that calls urlPostSync
 // http://stackoverflow.com/questions/6020714/escape-html-using-jquery
-function safeHTML(str) {
+gs.usercomments.safeHTML = function(str) {
     return str.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;").replace('"',"&quot;").replace("'","&#x27;").replace("/", "&#x2F;"); //"\\""
-} 
-
-
-function addUserComment(_username, _comment, _docid, doc) {
+}
+
+
+gs.usercomments.addUserComment = function(_username, _comment, _docid, doc) {
     
     // don't add empty strings for name/comment     
@@ -287 +295 @@
     
     //var result = gs.functions.setMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "accumulate", "import|archives|index");
-    gs.functions.setMetadataArray(gs.variables["c"], gs.variables["site"], docArray, "accumulate", "import|archives|index", function(ajaxResult) { return doneUpdatingMetatada(ajaxResult, _username, _timestamp, _comment); }, false); // false for asynchronous, 
+    gs.functions.setMetadataArray(gs.variables["c"],
+    gs.variables["site"],
+    docArray, "accumulate",
+    "import|archives|index",
+    function(ajaxResult) { return gs.usercomments.doneUpdatingMetatada(ajaxResult, _username, _timestamp, _comment); },
+    false); // false for asynchronous, 
     // this is ok since we're disabling the comment submit button, so no further set-meta-array calls can be
     // made until the ajax call returns and the callback is called which re-enables the submit button
@@ -296 +309 @@
 }
 
-function doneUpdatingMetatada(data, _username, _timestamp, _comment)
+gs.usercomments.doneUpdatingMetatada = function(data, _username, _timestamp, _comment)
 {
 
@@ -339 +352 @@
     var usercommentdiv = document.getElementById("usercomments");
     if(usercommentdiv != undefined) {
-        displayInUserCommentList(usercommentdiv, _username, _timestamp, _comment);
+        gs.usercomments.displayInUserCommentList(usercommentdiv, _username, _timestamp, _comment);
         }
     }
@@ -348 +361 @@
 }
 
-function commentAreaSetup() {
-    loadUserComments();
+gs.usercomments.commentAreaSetup = function() {
+    gs.usercomments.loadUserComments();
 
     //$("div#commentarea").html("<textarea required=\"required\" name=\"comment\" rows=\"10\" cols=\"64\" placeholder=\"Add your comment here...\"></textarea>");
@@ -361 +374 @@
 // This way we ensure we don't replace any other onLoad() functions, but append the loadUserComments() 
 // function to the existing set of eventhandlers called onDocReady
-$(document).ready(commentAreaSetup);
-
+$(document).ready(gs.usercomments.commentAreaSetup);
+