CRM/Financial/DAO/FinancialType.php

   1 <?php
   2 /*
   3 +--------------------------------------------------------------------+
   4 | CiviCRM version 4.7                                                |
   5 +--------------------------------------------------------------------+
   6 | Copyright CiviCRM LLC (c) 2004-2016                                |
   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  * @package CRM
  29  * @copyright CiviCRM LLC (c) 2004-2016
  30  *
  31  * Generated from xml/schema/CRM/Financial/FinancialType.xml
  32  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
  33  * (GenCodeChecksum:70310c419681152b59c27bc1b3e013d9)
  34  */
  35 require_once 'CRM/Core/DAO.php';
  36 require_once 'CRM/Utils/Type.php';
  37 class CRM_Financial_DAO_FinancialType extends CRM_Core_DAO {
  38   /**
  39    * static instance to hold the table name
  40    *
  41    * @var string
  42    */
  43   static $_tableName = 'civicrm_financial_type';
  44   /**
  45    * static value to see if we should log any modifications to
  46    * this table in the civicrm_log table
  47    *
  48    * @var boolean
  49    */
  50   static $_log = true;
  51   /**
  52    * ID of original financial_type so you can search this table by the financial_type.id and then select the relevant version based on the timestamp
  53    *
  54    * @var int unsigned
  55    */
  56   public $id;
  57   /**
  58    * Financial Type Name.
  59    *
  60    * @var string
  61    */
  62   public $name;
  63   /**
  64    * Financial Type Description.
  65    *
  66    * @var string
  67    */
  68   public $description;
  69   /**
  70    * Is this financial type tax-deductible? If true, contributions of this type may be fully OR partially deductible - non-deductible amount is stored in the Contribution record.
  71    *
  72    * @var boolean
  73    */
  74   public $is_deductible;
  75   /**
  76    * Is this a predefined system object?
  77    *
  78    * @var boolean
  79    */
  80   public $is_reserved;
  81   /**
  82    * Is this property active?
  83    *
  84    * @var boolean
  85    */
  86   public $is_active;
  87   /**
  88    * class constructor
  89    *
  90    * @return civicrm_financial_type
  91    */
  92   function __construct() {
  93     $this->__table = 'civicrm_financial_type';
  94     parent::__construct();
  95   }
  96   /**
  97    * Returns all the column names of this table
  98    *
  99    * @return array
 100    */
 101   static function &fields() {
 102     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 103       Civi::$statics[__CLASS__]['fields'] = array(
 104         'id' => array(
 105           'name' => 'id',
 106           'type' => CRM_Utils_Type::T_INT,
 107           'title' => ts('Financial Type ID') ,
 108           'description' => 'ID of original financial_type so you can search this table by the financial_type.id and then select the relevant version based on the timestamp',
 109           'required' => true,
 110         ) ,
 111         'financial_type' => array(
 112           'name' => 'name',
 113           'type' => CRM_Utils_Type::T_STRING,
 114           'title' => ts('Financial Type') ,
 115           'description' => 'Financial Type Name.',
 116           'required' => true,
 117           'maxlength' => 64,
 118           'size' => CRM_Utils_Type::BIG,
 119           'import' => true,
 120           'where' => 'civicrm_financial_type.name',
 121           'headerPattern' => '/(finan(cial)?)?type/i',
 122           'dataPattern' => '/donation|member|campaign/i',
 123           'export' => true,
 124         ) ,
 125         'description' => array(
 126           'name' => 'description',
 127           'type' => CRM_Utils_Type::T_STRING,
 128           'title' => ts('Description') ,
 129           'description' => 'Financial Type Description.',
 130           'maxlength' => 255,
 131           'size' => CRM_Utils_Type::HUGE,
 132         ) ,
 133         'is_deductible' => array(
 134           'name' => 'is_deductible',
 135           'type' => CRM_Utils_Type::T_BOOLEAN,
 136           'title' => ts('Is Tax Deductible?') ,
 137           'description' => 'Is this financial type tax-deductible? If true, contributions of this type may be fully OR partially deductible - non-deductible amount is stored in the Contribution record.',
 138           'default' => '1',
 139         ) ,
 140         'is_reserved' => array(
 141           'name' => 'is_reserved',
 142           'type' => CRM_Utils_Type::T_BOOLEAN,
 143           'title' => ts('Financial Type is Reserved?') ,
 144           'description' => 'Is this a predefined system object?',
 145         ) ,
 146         'is_active' => array(
 147           'name' => 'is_active',
 148           'type' => CRM_Utils_Type::T_BOOLEAN,
 149           'title' => ts('Financial Type Is Active?') ,
 150           'description' => 'Is this property active?',
 151         ) ,
 152       );
 153       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 154     }
 155     return Civi::$statics[__CLASS__]['fields'];
 156   }
 157   /**
 158    * Return a mapping from field-name to the corresponding key (as used in fields()).
 159    *
 160    * @return array
 161    *   Array(string $name => string $uniqueName).
 162    */
 163   static function &fieldKeys() {
 164     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 165       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 166     }
 167     return Civi::$statics[__CLASS__]['fieldKeys'];
 168   }
 169   /**
 170    * Returns the names of this table
 171    *
 172    * @return string
 173    */
 174   static function getTableName() {
 175     return self::$_tableName;
 176   }
 177   /**
 178    * Returns if this table needs to be logged
 179    *
 180    * @return boolean
 181    */
 182   function getLog() {
 183     return self::$_log;
 184   }
 185   /**
 186    * Returns the list of fields that can be imported
 187    *
 188    * @param bool $prefix
 189    *
 190    * @return array
 191    */
 192   static function &import($prefix = false) {
 193     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'financial_type', $prefix, array());
 194     return $r;
 195   }
 196   /**
 197    * Returns the list of fields that can be exported
 198    *
 199    * @param bool $prefix
 200    *
 201    * @return array
 202    */
 203   static function &export($prefix = false) {
 204     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'financial_type', $prefix, array());
 205     return $r;
 206   }
 207 }