Merge pull request #7011 from saurabhbatra96/comment-fixes-financial

Comment fixes and function clean-up for CRM/Financial directory.

CRM/Financial/BAO/ExportFormat.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
@@ -104,14 +102,6 @@ public function getFileExtension() {
     return 'txt';
   }
 
-  /**
-   * Override this if appropriate.
-   * @return null
-   */
-  public function getTemplateFileName() {
-    return NULL;
-  }
-
   /**
    * @return object
    */
@@ -150,7 +140,7 @@ public static function format($s, $type = 'string') {
 
   public function initiateDownload() {
     $config = CRM_Core_Config::singleton();
-    //zip files if more than one.
+    // zip files if more than one.
     if (count($this->_downloadFile) > 1) {
       $zip = $config->customFileUploadDir . 'Financial_Transactions_' . date('YmdHis') . '.zip';
       $result = $this->createZip($this->_downloadFile, $zip, TRUE);
@@ -204,7 +194,7 @@ public static function createActivityExport($batchIds, $fileName) {
       $subject .= ' ' . ts('Count') . '[' . $values['item_count'] . '],';
     }
 
-    //create activity.
+    // create activity.
     $subject .= ' ' . ts('Batch') . '[' . $values['title'] . ']';
     $activityTypes = CRM_Core_PseudoConstant::activityType(TRUE, FALSE, FALSE, 'name');
     $activityParams = array(
@@ -235,14 +225,14 @@ public static function createActivityExport($batchIds, $fileName) {
    * @return bool
    */
   public function createZip($files = array(), $destination = NULL, $overwrite = FALSE) {
-    //if the zip file already exists and overwrite is false, return false
+    // if the zip file already exists and overwrite is false, return false
     if (file_exists($destination) && !$overwrite) {
       return FALSE;
     }
     $valid_files = array();
     if (is_array($files)) {
       foreach ($files as $file) {
-        //make sure the file exists
+        // make sure the file exists
         if (file_exists($file)) {
           $validFiles[] = $file;
         }

CRM/Financial/BAO/ExportFormat/CSV.php

@@ -29,17 +29,19 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
  * @link http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation
  */
 class CRM_Financial_BAO_ExportFormat_CSV extends CRM_Financial_BAO_ExportFormat {
 
-  // For this phase, we always output these records too so that there isn't data referenced in the journal entries that isn't defined anywhere.
-  // Possibly in the future this could be selected by the user.
+  /**
+   * For this phase, we always output these records too so that there isn't data
+   * referenced in the journal entries that isn't defined anywhere.
+   *
+   * Possibly in the future this could be selected by the user.
+   */
   public static $complementaryTables = array(
     'ACCNT',
     'CUST',
@@ -58,17 +60,14 @@ public function __construct() {
   public function export($exportParams) {
     $export = parent::export($exportParams);
 
-    // Save the file in the public directory
+    // Save the file in the public directory.
     $fileName = self::putFile($export);
 
     foreach (self::$complementaryTables as $rct) {
       $func = "export{$rct}";
       $this->$func();
     }
 
-    // now do general journal entries
-    $this->exportTRANS();
-
     $this->output($fileName);
   }
 
@@ -243,13 +242,4 @@ public function getFileExtension() {
     return 'csv';
   }
 
-  public function exportACCNT() {
-  }
-
-  public function exportCUST() {
-  }
-
-  public function exportTRANS() {
-  }
-
 }

CRM/Financial/BAO/ExportFormat/IIF.php

@@ -29,21 +29,25 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
  * @link http://wiki.civicrm.org/confluence/display/CRM/CiviAccounts+Specifications+-++Batches#CiviAccountsSpecifications-Batches-%C2%A0Overviewofimplementation
  */
 class CRM_Financial_BAO_ExportFormat_IIF extends CRM_Financial_BAO_ExportFormat {
 
-  // Tab character. Some people's editors replace tabs with spaces so I'm scared to use actual tabs.
-  // Can't set it here using chr() because static. Same thing if a const. So it's set in constructor.
+  /**
+   * Tab character. Some people's editors replace tabs with spaces so I'm scared to use actual tabs.
+   * Can't set it here using chr() because static. Same thing if a const. So it's set in constructor.
+   */
   static $SEPARATOR;
 
-  // For this phase, we always output these records too so that there isn't data referenced in the journal entries that isn't defined anywhere.
-  // Possibly in the future this could be selected by the user.
+  /**
+   * For this phase, we always output these records too so that there isn't data
+   * referenced in the journal entries that isn't defined anywhere.
+   *
+   * Possibly in the future this could be selected by the user.
+   */
   public static $complementaryTables = array(
     'ACCNT',
     'CUST',

CRM/Financial/BAO/FinancialAccount.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Financial_BAO_FinancialAccount extends CRM_Financial_DAO_FinancialAccount {
 
@@ -121,7 +119,7 @@ public static function add(&$params, &$ids = array()) {
    * @param int $financialAccountId
    */
   public static function del($financialAccountId) {
-    //checking if financial type is present
+    // checking if financial type is present
     $check = FALSE;
 
     //check dependencies
@@ -144,7 +142,7 @@ public static function del($financialAccountId) {
       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/financial/financialAccount', "reset=1&action=browse"));
     }
 
-    //delete from financial Type table
+    // delete from financial Type table
     $financialAccount = new CRM_Financial_DAO_FinancialAccount();
     $financialAccount->id = $financialAccountId;
     $financialAccount->delete();

CRM/Financial/BAO/FinancialItem.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Financial_BAO_FinancialItem extends CRM_Financial_DAO_FinancialItem {
 
@@ -209,7 +207,7 @@ public static function createEntityTrxn($params) {
   public static function retrieveEntityFinancialTrxn($params, $maxId = FALSE) {
     $financialItem = new CRM_Financial_DAO_EntityFinancialTrxn();
     $financialItem->copyValues($params);
-    //retrieve last entry from civicrm_entity_financial_trxn
+    // retrieve last entry from civicrm_entity_financial_trxn
     if ($maxId) {
       $financialItem->orderBy('id DESC');
       $financialItem->limit(1);

CRM/Financial/BAO/FinancialType.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Financial_BAO_FinancialType extends CRM_Financial_DAO_FinancialType {
 
@@ -144,7 +142,7 @@ public static function del($financialTypeId) {
     // tables to ingore checks for financial_type_id
     $ignoreTables = array('CRM_Financial_DAO_EntityFinancialAccount');
 
-    //TODO: if (!$financialType->find(true)) {
+    // TODO: if (!$financialType->find(true)) {
 
     // ensure that we have no objects that have an FK to this financial type id TODO: that cannot be null
     $occurrences = $financialType->findReferences();
@@ -166,7 +164,7 @@ public static function del($financialTypeId) {
       }
     }
 
-    //delete from financial Type table
+    // delete from financial Type table
     $financialType->delete();
 
     $entityFinancialType = new CRM_Financial_DAO_EntityFinancialAccount();

CRM/Financial/BAO/FinancialTypeAccount.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Financial_BAO_FinancialTypeAccount extends CRM_Financial_DAO_EntityFinancialAccount {
 
@@ -107,12 +105,12 @@ public static function add(&$params, &$ids = NULL) {
    *
    */
   public static function del($financialTypeAccountId, $accountId = NULL) {
-    //checking if financial type is present
+    // check if financial type is present
     $check = FALSE;
     $relationValues = CRM_Core_PseudoConstant::get('CRM_Financial_DAO_EntityFinancialAccount', 'account_relationship');
 
     $financialTypeId = CRM_Core_DAO::getFieldValue('CRM_Financial_DAO_EntityFinancialAccount', $financialTypeAccountId, 'entity_id');
-    //check dependencies
+    // check dependencies
     // FIXME more table containing financial_type_id to come
     $dependency = array(
       array('Contribute', 'Contribution'),
@@ -146,7 +144,7 @@ public static function del($financialTypeAccountId, $accountId = NULL) {
       return CRM_Utils_System::redirect(CRM_Utils_System::url('civicrm/admin/financial/financialType/accounts', "reset=1&action=browse&aid={$accountId}"));
     }
 
-    //delete from financial Type table
+    // delete from financial Type table
     $financialType = new CRM_Financial_DAO_EntityFinancialAccount();
     $financialType->id = $financialTypeAccountId;
     $financialType->find(TRUE);

CRM/Financial/BAO/PaymentProcessor.php

@@ -433,7 +433,7 @@ public static function getProcessorForEntity($entityID, $component = 'contribute
     ) {
       return $result;
     }
-    //FIXME:
+
     if ($component == 'membership') {
       $sql = "
     SELECT cr.payment_processor_id as ppID1, cp.payment_processor as ppID2, con.is_test
@@ -459,7 +459,7 @@ public static function getProcessorForEntity($entityID, $component = 'contribute
      WHERE cr.id = %1";
     }
 
-    //we are interesting in single record.
+    // We are interested in a single record.
     $sql .= ' LIMIT 1';
 
     $params = array(1 => array($entityID, 'Integer'));

CRM/Financial/BAO/PaymentProcessorType.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 class CRM_Financial_BAO_PaymentProcessorType extends CRM_Financial_DAO_PaymentProcessorType {
 
@@ -54,7 +52,7 @@ public function __construct() {
    * @param array $defaults
    *   (reference ) an assoc array to hold the flattened values.
    *
-   * @return CRM_Core_BAO_LocaationType|null
+   * @return CRM_Core_BAO_LocationType|null
    *   object on success, null otherwise
    */
   public static function retrieve(&$params, &$defaults) {

CRM/Financial/Form/BatchTransaction.php

@@ -29,13 +29,10 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
  * This class generates form components for Financial Type
- *
  */
 class CRM_Financial_Form_BatchTransaction extends CRM_Contribute_Form {
   static $_links = NULL;
@@ -77,8 +74,6 @@ public function preProcess() {
 
   /**
    * Build the form object.
-   *
-   * @return void
    */
   public function buildQuickForm() {
     if ($this->_batchStatusId == 2) {

CRM/Financial/Form/Export.php

@@ -29,8 +29,6 @@
  *
  * @package CRM
  * @copyright CiviCRM LLC (c) 2004-2015
- * $Id$
- *
  */
 
 /**
@@ -64,16 +62,14 @@ class CRM_Financial_Form_Export extends CRM_Core_Form {
 
   /**
    * Build all the data structures needed to build the form.
-   *
-   * @return void
    */
   public function preProcess() {
     $this->_id = CRM_Utils_Request::retrieve('id', 'Positive', $this);
 
     // this mean it's a batch action
     if (!$this->_id) {
       if (!empty($_GET['batch_id'])) {
-        //validate batch ids
+        // validate batch ids
         $batchIds = explode(',', $_GET['batch_id']);
         foreach ($batchIds as $batchId) {
           CRM_Utils_Type::validate($batchId, 'Positive');
@@ -96,7 +92,7 @@ public function preProcess() {
     $allBatchStatus = CRM_Core_PseudoConstant::get('CRM_Batch_DAO_Batch', 'status_id');
     $this->_exportStatusId = CRM_Utils_Array::key('Exported', $allBatchStatus);
 
-    //check if batch status is valid, do not allow exported batches to export again
+    // check if batch status is valid, do not allow exported batches to export again
     $batchStatus = CRM_Batch_BAO_Batch::getBatchStatuses($this->_batchIds);
 
     foreach ($batchStatus as $batchStatusId) {
@@ -112,8 +108,6 @@ public function preProcess() {
 
   /**
    * Build the form object.
-   *
-   * @return void
    */
   public function buildQuickForm() {
     // this mean it's a batch action
@@ -151,8 +145,6 @@ public function buildQuickForm() {
 
   /**
    * Process the form after the input has been submitted and validated.
-   *
-   * @return void
    */
   public function postProcess() {
     if (!$this->_exportFormat) {