Merge pull request #4664 from aydun/CRM-15681-master

[civicrm-core.git] / CRM / Custom / Import / Parser.php

diff --git a/CRM/Custom/Import/Parser.php b/CRM/Custom/Import/Parser.php
index 93a40eb759938761f3beef14c88c8e0ffe44b84c..0b73ed91d28494530e804b5d6c1c51d4babbaf3a 100644 (file)
--- a/CRM/Custom/Import/Parser.php
+++ b/CRM/Custom/Import/Parser.php
@@ -1,9 +1,9 @@
 <?php
 /*
  +--------------------------------------------------------------------+
- | CiviCRM version 4.4                                                |
+ | CiviCRM version 4.5                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013                                |
+ | Copyright CiviCRM LLC (c) 2004-2014                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -28,7 +28,7 @@
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
  * $Id$
  *
  */
@@ -44,27 +44,39 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser {
    */
 
   /**
-   * imported file size
+   * Imported file size
    */
   protected $_fileSize;
 
   /**
-   * separator being used
+   * Separator being used
    */
   protected $_separator;
 
   /**
-   * total number of lines in file
+   * Total number of lines in file
    */
   protected $_lineCount;
 
   /**
-   * whether the file has a column header or not
+   * Whether the file has a column header or not
    *
    * @var boolean
    */
   protected $_haveColumnHeader;
 
+  /**
+   * @param string $fileName
+   * @param string $separator
+   * @param int $mapper
+   * @param bool $skipColumnHeader
+   * @param int|string $mode
+   * @param int|string $contactType
+   * @param int $onDuplicate
+   *
+   * @return mixed
+   * @throws Exception
+   */
   function run($fileName,
     $separator = ',',
     &$mapper,
@@ -297,7 +309,7 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser {
   }
 
   /**
-   * function to format the field values for input to the api
+   * Format the field values for input to the api
    *
    * @return array (reference ) associative array of name/value pairs
    * @access public
@@ -320,6 +332,8 @@ abstract class CRM_Custom_Import_Parser extends CRM_Contact_Import_Parser {
    *
    * @param CRM_Core_Session $store
    *
+   * @param int $mode
+   *
    * @return void
    * @access public
    */