From: Steve Sutton <steve@gaslightmedia.com>
Date: Wed, 29 Nov 2017 19:28:22 +0000 (-0500)
Subject: Add docs in code
X-Git-Tag: v1.0.4^2~11
X-Git-Url: http://cvs2.gaslightmedia.com/gitweb/index.cgi?a=commitdiff_plain;h=953740eefb34f91f2182c981d7812493a04c0a44;p=WP-Plugins%2Fglm-member-db-fields.git

Add docs in code

Adding php docs.
---

diff --git a/classes/customFieldPluginSupport.php b/classes/customFieldPluginSupport.php
index 22f2395..7b0569c 100644
--- a/classes/customFieldPluginSupport.php
+++ b/classes/customFieldPluginSupport.php
@@ -12,9 +12,9 @@
  * @param mixed $entityID Id for the member info record
  *
  * @access public
- * @return void
+ * @return true / or failure array
  */
-function customFieldsSaveFields( $entityID ){   
+function customFieldsSaveFields( $entityID ){
     global $wpdb;
     $fieldFail = array();
     // If no data for custom field then return
@@ -33,22 +33,22 @@ function customFieldsSaveFields( $entityID ){
     );
     $sql = "SELECT * FROM " . GLM_MEMBERS_FIELDS_PLUGIN_DB_PREFIX  . "custom_fields WHERE required=1";
     $required = $wpdb->get_results($sql);
-    
+
     if(!empty($required)){
-        foreach($required as $req){ 
+        foreach($required as $req){
             $requiredFields[] = $req->id;
         }
-    
+
         foreach($_REQUEST['glm_custom_field'] as $fieldID =>$fieldValue){
             $cfData[$fieldID] = $fieldValue;
             if( in_array( $fieldID,$requiredFields )){
                 if($fieldValue  === ''){
                     $fieldFail['fieldFail'][$fieldID] = true;
-                } 
-            } 
+                }
+            }
         }
     }
-    if(!empty($fieldFail)){   
+    if(!empty($fieldFail)){
         $fieldFailData = $cfData + $fieldFail;
          return $fieldFailData;
     }
@@ -80,9 +80,21 @@ function customFieldsSaveFields( $entityID ){
             );
         }
     }
-    return true; 
+    return true;
 }
 
+/**
+ * customFieldsCloneFields
+ *
+ * Grabs the custom field data for an entity and setup those custom fields
+ * for a new id.
+ *
+ * @param mixed $oldId Old id
+ * @param mixed $newId New id
+
+ * @access public
+ * @return void
+ */
 function customFieldsCloneFields( $oldId, $newId )
 {
     global $wpdb;
@@ -156,7 +168,7 @@ function customFieldsGetFields( $entityID, $where = ' AND true ', $uid )
     if ( !$entityID) {
         return false;
     }
-    $data = array(); 
+    $data = array();
     $sql = "
     SELECT *
       FROM " . GLM_MEMBERS_FIELDS_PLUGIN_DB_PREFIX . "custom_fields