Merge pull request #22360 from braders/import-field-docblock-improvem…

…ents [NFC] docblock improvements to Import_Field classes
civicrm · Jan 3, 2022 · 056d0b3 · 056d0b3
2 parents dd0aaff + 5ebfe76
commit 056d0b3
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 23 deletions.
diff --git 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 @@ public function resetValue() {
   /**
    * 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
@@ -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 @@ public function resetValue() {
    * 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
@@ -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 @@ public function resetValue() {
    * 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
@@ -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 @@ public function validate() {
 
     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
@@ -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 @@ public function resetValue() {
    * 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 @@ public function validate() {
 
     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':