From 5ebfe76b5f80e030bd842abc55b38a7028683e2e Mon Sep 17 00:00:00 2001
From: Bradley Taylor <hello@brad-taylor.co.uk>
Date: Mon, 3 Jan 2022 17:20:07 +0000
Subject: [PATCH] docblock improvements to Import_Field classes

---
 CRM/Activity/Import/Field.php   |  8 ++++----
 CRM/Contact/Import/Field.php    |  8 ++++----
 CRM/Contribute/Import/Field.php |  8 ++++----
 CRM/Event/Import/Field.php      | 10 +++++-----
 CRM/Member/Import/Field.php     | 12 ++++++------
 5 files changed, 23 insertions(+), 23 deletions(-)

diff --git a/CRM/Activity/Import/Field.php b/CRM/Activity/Import/Field.php
index 7061cc1c63..b3d4cbed04 100644
--- a/CRM/Activity/Import/Field.php
+++ b/CRM/Activity/Import/Field.php
@@ -30,7 +30,7 @@ class CRM_Activity_Import_Field {
 
   /**
    * Type of field
-   * @var enum
+   * @var int
    */
   public $_type;
 
@@ -60,13 +60,13 @@ class CRM_Activity_Import_Field {
 
   /**
    * Value of this field
-   * @var object
+   * @var string|null
    */
   public $_value;
 
   /**
    * @param string $name
-   * @param $title
+   * @param string $title
    * @param int $type
    * @param string $headerPattern
    * @param string $dataPattern
@@ -88,7 +88,7 @@ class CRM_Activity_Import_Field {
   /**
    * The value is in string format. convert the value to the type of this field
    * and set the field value with the appropriate type
-   * @param $value
+   * @param string $value
    */
   public function setValue($value) {
     $this->_value = $value;
diff --git a/CRM/Contact/Import/Field.php b/CRM/Contact/Import/Field.php
index 914a0e2031..20d75656f9 100644
--- a/CRM/Contact/Import/Field.php
+++ b/CRM/Contact/Import/Field.php
@@ -33,7 +33,7 @@ class CRM_Contact_Import_Field {
 
   /**
    * Type of field
-   * @var enum
+   * @var int
    */
   public $_type;
 
@@ -81,7 +81,7 @@ class CRM_Contact_Import_Field {
 
   /**
    * Value of this field
-   * @var object
+   * @var string|null
    */
   public $_value;
 
@@ -117,7 +117,7 @@ class CRM_Contact_Import_Field {
 
   /**
    * @param string $name
-   * @param $title
+   * @param string $title
    * @param int $type
    * @param string $columnPattern
    * @param string $dataPattern
@@ -156,7 +156,7 @@ class CRM_Contact_Import_Field {
    * Convert the value to the type of this field
    * and set the field value with the appropriate type
    *
-   * @param mixed $value
+   * @param string $value
    */
   public function setValue($value) {
     $this->_value = $value;
diff --git a/CRM/Contribute/Import/Field.php b/CRM/Contribute/Import/Field.php
index fec6a56cb7..cd69b469a5 100644
--- a/CRM/Contribute/Import/Field.php
+++ b/CRM/Contribute/Import/Field.php
@@ -35,7 +35,7 @@ class CRM_Contribute_Import_Field {
 
   /**
    * Type of field
-   * @var enum
+   * @var int
    */
   public $_type;
 
@@ -66,7 +66,7 @@ class CRM_Contribute_Import_Field {
 
   /**
    * Value of this field
-   * @var object
+   * @var string|null
    */
   public $_value;
 
@@ -78,7 +78,7 @@ class CRM_Contribute_Import_Field {
 
   /**
    * @param string $name
-   * @param $title
+   * @param string $title
    * @param int $type
    * @param string $headerPattern
    * @param string $dataPattern
@@ -104,7 +104,7 @@ class CRM_Contribute_Import_Field {
    * The value is in string format. Convert the value to the type of this field
    * and set the field value with the appropriate type
    *
-   * @param $value
+   * @param string $value
    */
   public function setValue($value) {
     $this->_value = $value;
diff --git a/CRM/Event/Import/Field.php b/CRM/Event/Import/Field.php
index 8bba7e00f1..a3062a2ec0 100644
--- a/CRM/Event/Import/Field.php
+++ b/CRM/Event/Import/Field.php
@@ -33,7 +33,7 @@ class CRM_Event_Import_Field {
 
   /**
    * Type of field
-   * @var enum
+   * @var int
    */
   public $_type;
 
@@ -51,13 +51,13 @@ class CRM_Event_Import_Field {
 
   /**
    * Value of this field
-   * @var object
+   * @var string|null
    */
   public $_value;
 
   /**
    * @param string $name
-   * @param $title
+   * @param string $title
    * @param int $type
    * @param string $headerPattern
    * @param string $dataPattern
@@ -95,8 +95,8 @@ class CRM_Event_Import_Field {
 
     switch ($this->_name) {
       case 'contact_id':
-        // note: we validate extistence of the contact in API, upon
-        // insert (it would be too costlty to do a db call here)
+        // note: we validate existence of the contact in API, upon
+        // insert (it would be too costly to do a db call here)
         return CRM_Utils_Rule::integer($this->_value);
 
       case 'register_date':
diff --git a/CRM/Member/Import/Field.php b/CRM/Member/Import/Field.php
index c1898d66e3..e4f44e5b3d 100644
--- a/CRM/Member/Import/Field.php
+++ b/CRM/Member/Import/Field.php
@@ -35,7 +35,7 @@ class CRM_Member_Import_Field {
 
   /**
    * Type of field
-   * @var enum
+   * @var int
    */
   public $_type;
 
@@ -65,13 +65,13 @@ class CRM_Member_Import_Field {
 
   /**
    * Value of this field
-   * @var object
+   * @var string|null
    */
   public $_value;
 
   /**
    * @param string $name
-   * @param $title
+   * @param string $title
    * @param int $type
    * @param string $headerPattern
    * @param string $dataPattern
@@ -94,7 +94,7 @@ class CRM_Member_Import_Field {
    * The value is in string format. convert the value to the type of this field
    * and set the field value with the appropriate type
    *
-   * @param $value
+   * @param string $value
    */
   public function setValue($value) {
     $this->_value = $value;
@@ -111,8 +111,8 @@ class CRM_Member_Import_Field {
 
     switch ($this->_name) {
       case 'contact_id':
-        // note: we validate extistence of the contact in API, upon
-        // insert (it would be too costlty to do a db call here)
+        // note: we validate existence of the contact in API, upon
+        // insert (it would be too costly to do a db call here)
         return CRM_Utils_Rule::integer($this->_value);
 
       case 'receive_date':
-- 
2.25.1