Merge pull request #4708 from jitendrapurohit/CRM-15662
[civicrm-core.git] / CRM / Contact / Import / Field.php
index 8ece7ad54bd651f0ea4cc1a2887a5ce63f19de7b..247ad9863384e3b6c4d9034d1711b9a4330146ec 100644 (file)
@@ -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.                                    |
  |                                                                    |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
 */
+
+/**
+ * Class CRM_Contact_Import_Field
+ */
 class CRM_Contact_Import_Field {
 
   /**#@+
@@ -125,6 +129,20 @@ class CRM_Contact_Import_Field {
    */
   public $_relatedContactPhoneType;
 
+  /**
+   * @param $name
+   * @param $title
+   * @param int $type
+   * @param string $columnPattern
+   * @param string $dataPattern
+   * @param null $hasLocationType
+   * @param null $phoneType
+   * @param null $related
+   * @param null $relatedContactType
+   * @param null $relatedContactDetails
+   * @param null $relatedContactLocType
+   * @param null $relatedContactPhoneType
+   */
   function __construct($name, $title, $type = CRM_Utils_Type::T_INT, $columnPattern = '//', $dataPattern = '//', $hasLocationType = NULL, $phoneType = NULL, $related = NULL, $relatedContactType = NULL, $relatedContactDetails = NULL, $relatedContactLocType = NULL, $relatedContactPhoneType = NULL) {
     $this->_name = $name;
     $this->_title = $title;
@@ -154,6 +172,9 @@ class CRM_Contact_Import_Field {
     $this->_value = $value;
   }
 
+  /**
+   * @return bool
+   */
   function validate() {
     //  echo $this->_value."===========<br>";
     $message = '';