Merge pull request #4820 from kurund/CRM-15705

[civicrm-core.git] / CRM / Financial / BAO / ExportFormat.php

diff --git a/CRM/Financial/BAO/ExportFormat.php b/CRM/Financial/BAO/ExportFormat.php
index f91d1f2c7a7f35cbbf02dc4e5de1e35b8c63d181..727d1d93166abd2cdb51fb493e104beb9ec4f4be 100644 (file)
--- a/CRM/Financial/BAO/ExportFormat.php
+++ b/CRM/Financial/BAO/ExportFormat.php
@@ -1,7 +1,7 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.5                                             |
+ | CiviCRM version 4.6                                             |
  +--------------------------------------------------------------------+
  | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
@@ -52,21 +52,29 @@ class CRM_Financial_BAO_ExportFormat {
   static protected $_template;
 
   /**
-   * class constructor
+   * Class constructor
    */
-  function __construct() {
+  public function __construct() {
     if ( !isset( self::$_template ) ) {
       self::$_template = CRM_Core_Smarty::singleton();
     }
   }
 
   // Override to assemble the appropriate subset of financial data for the specific export format
-  function export($exportParams) {
+  /**
+   * @param array $exportParams
+   *
+   * @return mixed
+   */
+  public function export($exportParams) {
     $this->_exportParams = $exportParams;
     return $exportParams;
   }
 
-  function output($fileName = NULL) {
+  /**
+   * @param null $fileName
+   */
+  public function output($fileName = NULL) {
     switch ($this->getFileExtension()) {
       case 'csv':
         self::createActivityExport($this->_batchIds, $fileName);
@@ -81,24 +89,40 @@ class CRM_Financial_BAO_ExportFormat {
     }
   }
 
-  function getMimeType() {
+  /**
+   * @return string
+   */
+  public function getMimeType() {
     return 'text/plain';
   }
 
-  function getFileExtension() {
+  /**
+   * @return string
+   */
+  public function getFileExtension() {
     return 'txt';
   }
 
   // Override this if appropriate
-  function getTemplateFileName() {
+  /**
+   * @return null
+   */
+  public function getTemplateFileName() {
     return null;
   }
 
-  static function &getTemplate() {
+  /**
+   * @return object
+   */
+  public static function &getTemplate() {
     return self::$_template;
   }
 
-  function assign($var, $value = NULL) {
+  /**
+   * @param $var
+   * @param null $value
+   */
+  public function assign($var, $value = NULL) {
     self::$_template->assign($var, $value);
   }
 
@@ -108,7 +132,13 @@ class CRM_Financial_BAO_ExportFormat {
    * Depending on the output format might want to override this, e.g. for IIF tabs need to be escaped etc,
    * but for CSV it doesn't make sense because php has built in csv output functions.
    */
-  static function format($s, $type = 'string') {
+  /**
+   * @param $s
+   * @param string $type
+   *
+   * @return null
+   */
+  public static function format($s, $type = 'string') {
     if (!empty($s)) {
       return $s;
     }
@@ -117,7 +147,7 @@ class CRM_Financial_BAO_ExportFormat {
     }
   }
 
-  function initiateDownload() {
+  public function initiateDownload() {
     $config = CRM_Core_Config::singleton();
     //zip files if more than one.
     if (count($this->_downloadFile)>1) {
@@ -145,7 +175,13 @@ class CRM_Financial_BAO_ExportFormat {
     }
   }
 
-  static function createActivityExport($batchIds, $fileName) {
+  /**
+   * @param $batchIds
+   * @param string $fileName
+   *
+   * @throws CRM_Core_Exception
+   */
+  public static function createActivityExport($batchIds, $fileName) {
     $session = CRM_Core_Session::singleton();
     $values = array();
     $params = array('id' => $batchIds);
@@ -158,7 +194,7 @@ class CRM_Financial_BAO_ExportFormat {
       $paymentInstrument = array_flip(CRM_Contribute_PseudoConstant::paymentInstrument('label'));
       $values['payment_instrument_id'] = array_search($values['payment_instrument_id'], $paymentInstrument);
     }
-    $details = '<p>' . ts('Record: ') . $values['title'] . '</p><p>' . ts('Description: ') . '</p><p>' . ts('Created By: ') . $createdBy . '</p><p>' . ts('Created Date: ') . $values['created_date'] . '</p><p>' . ts('Last Modified By: ') . $modifiedBy . '</p><p>' . ts('Payment Instrument: ') . $values['payment_instrument_id'] . '</p>';
+    $details = '<p>' . ts('Record:') . ' ' . $values['title'] . '</p><p>' . ts('Description:') . '</p><p>' . ts('Created By:') . " $createdBy" . '</p><p>' . ts('Created Date:') . ' ' . $values['created_date'] . '</p><p>' . ts('Last Modified By:') . ' ' . $modifiedBy . '</p><p>' . ts('Payment Instrument:') . ' ' . $values['payment_instrument_id'] . '</p>';
     $subject = '';
     if (!empty($values['total'])) {
       $subject .= ts('Total') . '['. CRM_Utils_Money::format($values['total']) .'],';
@@ -190,7 +226,14 @@ class CRM_Financial_BAO_ExportFormat {
     CRM_Activity_BAO_Activity::create($activityParams);
   }
 
-  function createZip($files = array(), $destination = NULL, $overwrite = FALSE) {
+  /**
+   * @param array $files
+   * @param null $destination
+   * @param bool $overwrite
+   *
+   * @return bool
+   */
+  public function createZip($files = array(), $destination = NULL, $overwrite = FALSE) {
     //if the zip file already exists and overwrite is false, return false
     if (file_exists($destination) && !$overwrite) {
       return FALSE;