Comment fixes and function clean-up for CRM/Activity directory.
[civicrm-core.git] / CRM / Activity / Import / Form / MapField.php
index e20f6eecb3e60e1bc7b5853366ae26d7132013b5..5545264c2c1dbfbfc73e7d83e76a3cb32b256af5 100644 (file)
@@ -55,7 +55,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
     if ($skipColumnHeader) {
       $this->assign('skipColumnHeader', $skipColumnHeader);
       $this->assign('rowDisplayCount', 3);
-      /* if we had a column header to skip, stash it for later */
+      // If we had a column header to skip, stash it for later.
 
       $this->_columnHeaders = $this->_dataValues[0];
     }
@@ -80,7 +80,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
    * Build the form object.
    */
   public function buildQuickForm() {
-    //to save the current mappings
+    // To save the current mappings.
     if (!$this->get('savedMapping')) {
       $saveDetailsName = ts('Save this field mapping');
       $this->applyFilter('saveMappingName', 'trim');
@@ -89,11 +89,11 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
     }
     else {
       $savedMapping = $this->get('savedMapping');
-      //mapping is to be loaded from database
+      // Mapping is to be loaded from database.
 
       list($mappingName, $mappingContactType, $mappingLocation, $mappingPhoneType, $mappingRelation) = CRM_Core_BAO_Mapping::getMappingFields($savedMapping);
 
-      //get loaded Mapping Fields
+      // Get loaded Mapping Fields.
       $mappingName = CRM_Utils_Array::value('1', $mappingName);
       $mappingContactType = CRM_Utils_Array::value('1', $mappingContactType);
       $mappingLocation = CRM_Utils_Array::value('1', $mappingLocation);
@@ -131,7 +131,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
     $dataPatterns = $this->get('dataPatterns');
     $hasLocationTypes = $this->get('fieldTypes');
 
-    /* Initialize all field usages to false */
+    // Initialize all field usages to false.
 
     foreach ($mapperKeys as $key) {
       $this->_fieldUsed[$key] = FALSE;
@@ -144,7 +144,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
     $js = "<script type='text/javascript'>\n";
     $formName = 'document.forms.' . $this->_name;
 
-    //used to warn for mismatch column count or mismatch mapping
+    // Used to warn for mismatch column count or mismatch mapping.
     $warning = 0;
 
     for ($i = 0; $i < $this->_columnCount; $i++) {
@@ -196,7 +196,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
             $defaults["mapper[$i]"] = array($this->defaultFromData($dataPatterns, $i));
           }
         }
-        //end of load mapping
+        // End of load mapping.
       }
       else {
         $js .= "swapOptions($formName, 'mapper[$i]', 0, 3, 'hs_mapper_" . $i . "_');\n";
@@ -206,7 +206,6 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
             $this->defaultFromHeader($this->_columnHeaders[$i],
               $headerPatterns
             ),
-            //                     $defaultLocationType->id
             0,
           );
         }
@@ -214,7 +213,6 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
           // Otherwise guess the default from the form of the data
           $defaults["mapper[$i]"] = array(
             $this->defaultFromData($dataPatterns, $i),
-            //                     $defaultLocationType->id
             0,
           );
         }
@@ -225,7 +223,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
     $js .= "</script>\n";
     $this->assign('initHideBoxes', $js);
 
-    //set warning if mismatch in more than
+    // Set warning if mismatch in more than.
     if (isset($mappingName)) {
       if (($this->_columnCount != count($mappingName))) {
         $warning++;
@@ -370,7 +368,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
    */
   public function postProcess() {
     $params = $this->controller->exportValues('MapField');
-    //reload the mapfield if load mapping is pressed
+    // Reload the mapfield if load mapping is pressed.
     if (!empty($params['savedMapping'])) {
       $this->set('savedMapping', $params['savedMapping']);
       $this->controller->resetPage($this->_name);
@@ -415,7 +413,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
       $this->set('loadMappingId', $params['mappingId']);
     }
 
-    //Updating Mapping Records
+    // Updating Mapping Records.
     if (!empty($params['updateMapping'])) {
 
       $mappingFields = new CRM_Core_DAO_MappingField();
@@ -440,7 +438,7 @@ class CRM_Activity_Import_Form_MapField extends CRM_Import_Form_MapField {
       }
     }
 
-    //Saving Mapping Details and Records
+    // Saving Mapping Details and Records.
     if (!empty($params['saveMapping'])) {
       $mappingParams = array(
         'name' => $params['saveMappingName'],