Changeset 8007

Timestamp:

02/28/2014 09:46:51 PM (11 years ago)

Author:

djpaul

Message:

Members + Templates: code standards improvement for the profile field "clear" button JS. Also adds jsdoc.

Location:

trunk

Files:

• bp-members/admin/js/admin.js (modified) (1 diff)
• bp-templates/bp-legacy/js/buddypress.js (modified) (1 diff)

trunk/bp-members/admin/js/admin.js

@@ -32 +32 @@
 
 
-function clear(container) {
-    if( !document.getElementById(container) ) return;
+/**
+ * Deselects any select options or input options for the specified field element.
+ *
+ * @param {String} container HTML ID of the field
+ * @since BuddyPress (1.0.0)
+ */
+function clear( container ) {
+    container = document.getElementById( container );
+    if ( ! container ) {
+        return;
+    }
 
-    var container = document.getElementById(container);
+    var radioButtons = container.getElementsByTagName( 'INPUT' ),
+        options = container.getElementsByTagName( 'OPTION' ),
+        i       = 0;
 
-    if ( radioButtons = container.getElementsByTagName('INPUT') ) {
-        for(var i=0; i<radioButtons.length; i++) {
+    if ( radioButtons ) {
+        for ( i = 0; i < radioButtons.length; i++ ) {
             radioButtons[i].checked = '';
         }
     }
 
-    if ( options = container.getElementsByTagName('OPTION') ) {
-        for(var i=0; i<options.length; i++) {
+    if ( options ) {
+        for ( i = 0; i < options.length; i++ ) {
             options[i].selected = false;
         }
     }
-
-    return;
 }

trunk/bp-templates/bp-legacy/js/buddypress.js

@@ -1697 +1697 @@
 }
 
-function clear(container) {
-    if( !document.getElementById(container) ) return;
-
-    var container = document.getElementById(container);
-
-    if ( radioButtons = container.getElementsByTagName('INPUT') ) {
-        for(var i=0; i<radioButtons.length; i++) {
+/**
+ * Deselects any select options or input options for the specified field element.
+ *
+ * @param {String} container HTML ID of the field
+ * @since BuddyPress (1.2.0)
+ */
+function clear( container ) {
+    container = document.getElementById( container );
+    if ( ! container ) {
+        return;
+    }
+
+    var radioButtons = container.getElementsByTagName( 'INPUT' ),
+        options = container.getElementsByTagName( 'OPTION' ),
+        i       = 0;
+
+    if ( radioButtons ) {
+        for ( i = 0; i < radioButtons.length; i++ ) {
             radioButtons[i].checked = '';
         }
     }
 
-    if ( options = container.getElementsByTagName('OPTION') ) {
-        for(var i=0; i<options.length; i++) {
+    if ( options ) {
+        for ( i = 0; i < options.length; i++ ) {
             options[i].selected = false;
         }
     }
-
-    return;
 }