CRM/Contribute/Import/Field.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35 class CRM_Contribute_Import_Field {
  36
  37   /**#@+
  38    * @var string
  39    */
  40
  41   /**
  42    * Name of the field
  43    */
  44   public $_name;
  45
  46   /**
  47    * Title of the field to be used in display
  48    */
  49   public $_title;
  50
  51   /**
  52    * Type of field
  53    * @var enum
  54    */
  55   public $_type;
  56
  57   /**
  58    * Is this field required
  59    * @var boolean
  60    */
  61   public $_required;
  62
  63   /**
  64    * Data to be carried for use by a derived class
  65    * @var object
  66    */
  67   public $_payload;
  68
  69   /**
  70    * Regexp to match the CSV header of this column/field
  71    * @var string
  72    */
  73   public $_headerPattern;
  74
  75   /**
  76    * Regexp to match the pattern of data from various column/fields
  77    * @var string
  78    */
  79   public $_dataPattern;
  80
  81   /**
  82    * Value of this field
  83    * @var object
  84    */
  85   public $_value;
  86
  87   /**
  88    * This is soft credit field
  89    * @var string
  90    */
  91   public $_softCreditField;
  92
  93   /**
  94    * @param string $name
  95    * @param $title
  96    * @param int $type
  97    * @param string $headerPattern
  98    * @param string $dataPattern
  99    * @param null $softCreditField
 100    */
 101   public function __construct($name, $title, $type = CRM_Utils_Type::T_INT, $headerPattern = '//', $dataPattern = '//', $softCreditField = NULL) {
 102     $this->_name = $name;
 103     $this->_title = $title;
 104     $this->_type = $type;
 105     $this->_headerPattern = $headerPattern;
 106     $this->_dataPattern = $dataPattern;
 107     $this->_softCreditField = $softCreditField;
 108     $this->_value = NULL;
 109   }
 110
 111   public function resetValue() {
 112     $this->_value = NULL;
 113   }
 114
 115   /**
 116    * The value is in string format. convert the value to the type of this field
 117    * and set the field value with the appropriate type
 118    */
 119   public function setValue($value) {
 120     $this->_value = $value;
 121   }
 122
 123   /**
 124    * @return bool
 125    */
 126   public function validate() {
 127
 128     if (CRM_Utils_System::isNull($this->_value)) {
 129       return TRUE;
 130     }
 131
 132     switch ($this->_name) {
 133       case 'contact_id':
 134         // note: we validate existence of the contact in API, upon
 135         // insert (it would be too costly to do a db call here)
 136         return CRM_Utils_Rule::integer($this->_value);
 137
 138       case 'receive_date':
 139       case 'cancel_date':
 140       case 'receipt_date':
 141       case 'thankyou_date':
 142         return CRM_Utils_Rule::date($this->_value);
 143
 144       case 'non_deductible_amount':
 145       case 'total_amount':
 146       case 'fee_amount':
 147       case 'net_amount':
 148         return CRM_Utils_Rule::money($this->_value);
 149
 150       case 'trxn_id':
 151         static $seenTrxnIds = array();
 152         if (in_array($this->_value, $seenTrxnIds)) {
 153           return FALSE;
 154         }
 155         elseif ($this->_value) {
 156           $seenTrxnIds[] = $this->_value;
 157           return TRUE;
 158         }
 159         else {
 160           $this->_value = NULL;
 161           return TRUE;
 162         }
 163         break;
 164
 165       case 'currency':
 166         return CRM_Utils_Rule::currencyCode($this->_value);
 167
 168       case 'financial_type':
 169         static $contributionTypes = NULL;
 170         if (!$contributionTypes) {
 171           $contributionTypes = CRM_Contribute_PseudoConstant::financialType();
 172         }
 173         if (in_array($this->_value, $contributionTypes)) {
 174           return TRUE;
 175         }
 176         else {
 177           return FALSE;
 178         }
 179         break;
 180
 181       case 'payment_instrument':
 182         static $paymentInstruments = NULL;
 183         if (!$paymentInstruments) {
 184           $paymentInstruments = CRM_Contribute_PseudoConstant::paymentInstrument();
 185         }
 186         if (in_array($this->_value, $paymentInstruments)) {
 187           return TRUE;
 188         }
 189         else {
 190           return FALSE;
 191         }
 192         break;
 193
 194       default:
 195         break;
 196     }
 197
 198     // check whether that's a valid custom field id
 199     // and if so, check the contents' validity
 200     if ($customFieldID = CRM_Core_BAO_CustomField::getKeyID($this->_name)) {
 201       static $customFields = NULL;
 202       if (!$customFields) {
 203         $customFields = CRM_Core_BAO_CustomField::getFields('Contribution');
 204       }
 205       if (!array_key_exists($customFieldID, $customFields)) {
 206         return FALSE;
 207       }
 208       return CRM_Core_BAO_CustomValue::typecheck($customFields[$customFieldID]['data_type'], $this->_value);
 209     }
 210
 211     return TRUE;
 212   }
 213
 214 }