3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.3 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2013 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
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. |
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. |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2013
35 class CRM_Contribute_Import_Field
{
48 * title of the field to be used in display
59 * is this field required
65 * data to be carried for use by a derived class
71 * regexp to match the CSV header of this column/field
74 public $_headerPattern;
77 * regexp to match the pattern of data from various column/fields
89 * this is soft credit field
92 public $_softCreditField;
94 function __construct($name, $title, $type = CRM_Utils_Type
::T_INT
, $headerPattern = '//', $dataPattern = '//', $softCreditField = NULL) {
96 $this->_title
= $title;
98 $this->_headerPattern
= $headerPattern;
99 $this->_dataPattern
= $dataPattern;
100 $this->_softCreditField
= $softCreditField;
101 $this->_value
= NULL;
104 function resetValue() {
105 $this->_value
= NULL;
109 * the value is in string format. convert the value to the type of this field
110 * and set the field value with the appropriate type
112 function setValue($value) {
113 $this->_value
= $value;
116 function validate() {
118 if (CRM_Utils_System
::isNull($this->_value
)) {
122 switch ($this->_name
) {
124 // note: we validate extistence of the contact in API, upon
125 // insert (it would be too costlty to do a db call here)
126 return CRM_Utils_Rule
::integer($this->_value
);
131 case 'thankyou_date':
132 return CRM_Utils_Rule
::date($this->_value
);
134 case 'non_deductible_amount':
138 return CRM_Utils_Rule
::money($this->_value
);
141 static $seenTrxnIds = array();
142 if (in_array($this->_value
, $seenTrxnIds)) {
145 elseif ($this->_value
) {
146 $seenTrxnIds[] = $this->_value
;
150 $this->_value
= NULL;
156 return CRM_Utils_Rule
::currencyCode($this->_value
);
158 case 'financial_type':
159 static $contributionTypes = NULL;
160 if (!$contributionTypes) {
161 $contributionTypes = CRM_Contribute_PseudoConstant
::financialType();
163 if (in_array($this->_value
, $contributionTypes)) {
171 case 'payment_instrument':
172 static $paymentInstruments = NULL;
173 if (!$paymentInstruments) {
174 $paymentInstruments = CRM_Contribute_PseudoConstant
::paymentInstrument();
176 if (in_array($this->_value
, $paymentInstruments)) {
188 // check whether that's a valid custom field id
189 // and if so, check the contents' validity
190 if ($customFieldID = CRM_Core_BAO_CustomField
::getKeyID($this->_name
)) {
191 static $customFields = NULL;
192 if (!$customFields) {
193 $customFields = CRM_Core_BAO_CustomField
::getFields('Contribution');
195 if (!array_key_exists($customFieldID, $customFields)) {
198 return CRM_Core_BAO_CustomValue
::typecheck($customFields[$customFieldID]['data_type'], $this->_value
);