autogenerate missing comments
[civicrm-core.git] / CRM / Contribute / Import / Parser.php
index a81b4de3c8ad2c7a3b070e48adf88d12acb63555..a0ede60f2375607d537ad63b7e5bc330c84890c7 100644 (file)
@@ -115,6 +115,18 @@ abstract class CRM_Contribute_Import_Parser extends CRM_Import_Parser {
    */
   protected $_haveColumnHeader;
 
+  /**
+   * @param $fileName
+   * @param string $seperator
+   * @param $mapper
+   * @param bool $skipColumnHeader
+   * @param int $mode
+   * @param int $contactType
+   * @param int $onDuplicate
+   *
+   * @return mixed
+   * @throws Exception
+   */
   function run($fileName,
     $seperator = ',',
     &$mapper,
@@ -414,12 +426,18 @@ pppp   * @return void
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldSoftCredit($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_softCreditField = $elements[$i];
     }
   }
 
+  /**
+   * @param $elements
+   */
   function setActiveFieldSoftCreditType($elements) {
     for ($i = 0; $i < count($elements); $i++) {
       $this->_activeFields[$i]->_softCreditType = $elements[$i];
@@ -455,6 +473,13 @@ pppp   * @return void
     return $params;
   }
 
+  /**
+   * @param $name
+   * @param $title
+   * @param int $type
+   * @param string $headerPattern
+   * @param string $dataPattern
+   */
   function addField($name, $title, $type = CRM_Utils_Type::T_INT, $headerPattern = '//', $dataPattern = '//') {
     if (empty($name)) {
       $this->_fields['doNotImport'] = new CRM_Contribute_Import_Field($name, $title, $type, $headerPattern, $dataPattern);
@@ -477,6 +502,8 @@ pppp   * @return void
    *
    * @param CRM_Core_Session $store
    *
+   * @param int $mode
+   *
    * @return void
    * @access public
    */
@@ -543,10 +570,11 @@ pppp   * @return void
   /**
    * Export data to a CSV file
    *
-   * @param string $filename
+   * @param $fileName
    * @param array $header
    * @param data $data
    *
+   * @internal param string $filename
    * @return void
    * @access public
    */
@@ -580,6 +608,18 @@ pppp   * @return void
     fclose($fd);
   }
 
+  /**
+   * Determines the file extension based on error code
+   *
+   * @var $type error code constant
+   * @return string
+   * @static
+   */
+  /**
+   * @param error $type
+   *
+   * @return string
+   */
   static function errorFileName($type) {
     $fileName = NULL;
     if (empty($type)) {
@@ -606,6 +646,18 @@ pppp   * @return void
     return $fileName;
   }
 
+  /**
+   * Determines the file name based on error code
+   *
+   * @var $type error code constant
+   * @return string
+   * @static
+   */
+  /**
+   * @param error $type
+   *
+   * @return string
+   */
   static function saveFileName($type) {
     $fileName = NULL;
     if (empty($type)) {