CRM/Activity/Import/Field.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 5                                                  |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2019                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26  */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2019
  32  */
  33 class CRM_Activity_Import_Field {
  34
  35   /**
  36    * @var string
  37    *   Name of the field
  38    */
  39   public $_name;
  40
  41   /**
  42    * Title of the field to be used in display
  43    * @var string
  44    */
  45   public $_title;
  46
  47   /**
  48    * Type of field
  49    * @var enum
  50    */
  51   public $_type;
  52
  53   /**
  54    * Is this field required
  55    * @var bool
  56    */
  57   public $_required;
  58
  59   /**
  60    * Data to be carried for use by a derived class
  61    * @var object
  62    */
  63   public $_payload;
  64
  65   /**
  66    * Regexp to match the CSV header of this column/field
  67    * @var string
  68    */
  69   public $_headerPattern;
  70
  71   /**
  72    * Regexp to match the pattern of data from various column/fields
  73    * @var string
  74    */
  75   public $_dataPattern;
  76
  77   /**
  78    * Value of this field
  79    * @var object
  80    */
  81   public $_value;
  82
  83   /**
  84    * @param string $name
  85    * @param $title
  86    * @param int $type
  87    * @param string $headerPattern
  88    * @param string $dataPattern
  89    */
  90   public function __construct($name, $title, $type = CRM_Utils_Type::T_INT, $headerPattern = '//', $dataPattern = '//') {
  91     $this->_name = $name;
  92     $this->_title = $title;
  93     $this->_type = $type;
  94     $this->_headerPattern = $headerPattern;
  95     $this->_dataPattern = $dataPattern;
  96
  97     $this->_value = NULL;
  98   }
  99
 100   public function resetValue() {
 101     $this->_value = NULL;
 102   }
 103
 104   /**
 105    * The value is in string format. convert the value to the type of this field
 106    * and set the field value with the appropriate type
 107    * @param $value
 108    */
 109   public function setValue($value) {
 110     $this->_value = $value;
 111   }
 112
 113   /**
 114    * @return bool
 115    */
 116   public function validate() {
 117
 118     if (CRM_Utils_System::isNull($this->_value)) {
 119       return TRUE;
 120     }
 121     return TRUE;
 122   }
 123
 124 }