3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2017 |
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 +--------------------------------------------------------------------+
29 * @copyright CiviCRM LLC (c) 2004-2017
31 * Generated from xml/schema/CRM/Price/PriceField.xml
32 * DO NOT EDIT. Generated by CRM_Core_CodeGen
33 * (GenCodeChecksum:6ee89c3106c27af4ca96897826a2ef8c)
35 require_once 'CRM/Core/DAO.php';
36 require_once 'CRM/Utils/Type.php';
38 * CRM_Price_DAO_PriceField constructor.
40 class CRM_Price_DAO_PriceField
extends CRM_Core_DAO
{
42 * Static instance to hold the table name.
46 static $_tableName = 'civicrm_price_field';
48 * Should CiviCRM log any modifications to this table in the civicrm_log table.
60 * FK to civicrm_price_set
66 * Variable name/programmatic handle for this field.
72 * Text for form field label (also friendly name for administering this field).
83 * Enter a quantity for this field?
89 * Description and/or help text to display before this field.
95 * Description and/or help text to display after this field.
101 * Order in which the fields should appear
107 * Should the price be displayed next to the label for each option?
111 public $is_display_amounts;
113 * number of options per line for checkbox and radio
117 public $options_per_line;
119 * Is this price field active
125 * Is this price field required (value must be > 1)
131 * If non-zero, do not show this field before the date specified
137 * If non-zero, do not show this field after the date specified
143 * Optional scripting attributes for field
149 * Implicit FK to civicrm_option_group with name = 'visibility'
153 public $visibility_id;
157 function __construct() {
158 $this->__table
= 'civicrm_price_field';
159 parent
::__construct();
162 * Returns foreign keys and entity references.
165 * [CRM_Core_Reference_Interface]
167 static function getReferenceColumns() {
168 if (!isset(Civi
::$statics[__CLASS__
]['links'])) {
169 Civi
::$statics[__CLASS__
]['links'] = static ::createReferenceColumns(__CLASS__
);
170 Civi
::$statics[__CLASS__
]['links'][] = new CRM_Core_Reference_Basic(self
::getTableName() , 'price_set_id', 'civicrm_price_set', 'id');
171 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'links_callback', Civi
::$statics[__CLASS__
]['links']);
173 return Civi
::$statics[__CLASS__
]['links'];
176 * Returns all the column names of this table
180 static function &fields() {
181 if (!isset(Civi
::$statics[__CLASS__
]['fields'])) {
182 Civi
::$statics[__CLASS__
]['fields'] = array(
185 'type' => CRM_Utils_Type
::T_INT
,
186 'title' => ts('Price Field ID') ,
187 'description' => 'Price Field',
189 'table_name' => 'civicrm_price_field',
190 'entity' => 'PriceField',
191 'bao' => 'CRM_Price_BAO_PriceField',
194 'price_set_id' => array(
195 'name' => 'price_set_id',
196 'type' => CRM_Utils_Type
::T_INT
,
197 'title' => ts('Price Set') ,
198 'description' => 'FK to civicrm_price_set',
200 'table_name' => 'civicrm_price_field',
201 'entity' => 'PriceField',
202 'bao' => 'CRM_Price_BAO_PriceField',
204 'FKClassName' => 'CRM_Price_DAO_PriceSet',
208 'type' => CRM_Utils_Type
::T_STRING
,
209 'title' => ts('Name') ,
210 'description' => 'Variable name/programmatic handle for this field.',
213 'size' => CRM_Utils_Type
::HUGE
,
214 'table_name' => 'civicrm_price_field',
215 'entity' => 'PriceField',
216 'bao' => 'CRM_Price_BAO_PriceField',
224 'type' => CRM_Utils_Type
::T_STRING
,
225 'title' => ts('Label') ,
226 'description' => 'Text for form field label (also friendly name for administering this field).',
229 'size' => CRM_Utils_Type
::HUGE
,
230 'table_name' => 'civicrm_price_field',
231 'entity' => 'PriceField',
232 'bao' => 'CRM_Price_BAO_PriceField',
238 'html_type' => array(
239 'name' => 'html_type',
240 'type' => CRM_Utils_Type
::T_STRING
,
241 'title' => ts('Html Type') ,
244 'size' => CRM_Utils_Type
::TWELVE
,
245 'table_name' => 'civicrm_price_field',
246 'entity' => 'PriceField',
247 'bao' => 'CRM_Price_BAO_PriceField',
252 'pseudoconstant' => array(
253 'callback' => 'CRM_Price_BAO_PriceField::htmlTypes',
256 'is_enter_qty' => array(
257 'name' => 'is_enter_qty',
258 'type' => CRM_Utils_Type
::T_BOOLEAN
,
259 'title' => ts('Price Field Quantity Required?') ,
260 'description' => 'Enter a quantity for this field?',
261 'table_name' => 'civicrm_price_field',
262 'entity' => 'PriceField',
263 'bao' => 'CRM_Price_BAO_PriceField',
266 'type' => 'CheckBox',
270 'name' => 'help_pre',
271 'type' => CRM_Utils_Type
::T_TEXT
,
272 'title' => ts('Price Field Pre Text') ,
273 'description' => 'Description and/or help text to display before this field.',
276 'table_name' => 'civicrm_price_field',
277 'entity' => 'PriceField',
278 'bao' => 'CRM_Price_BAO_PriceField',
281 'type' => 'TextArea',
284 'help_post' => array(
285 'name' => 'help_post',
286 'type' => CRM_Utils_Type
::T_TEXT
,
287 'title' => ts('Price Field Post Text') ,
288 'description' => 'Description and/or help text to display after this field.',
291 'table_name' => 'civicrm_price_field',
292 'entity' => 'PriceField',
293 'bao' => 'CRM_Price_BAO_PriceField',
296 'type' => 'TextArea',
301 'type' => CRM_Utils_Type
::T_INT
,
302 'title' => ts('Order') ,
303 'description' => 'Order in which the fields should appear',
305 'table_name' => 'civicrm_price_field',
306 'entity' => 'PriceField',
307 'bao' => 'CRM_Price_BAO_PriceField',
313 'is_display_amounts' => array(
314 'name' => 'is_display_amounts',
315 'type' => CRM_Utils_Type
::T_BOOLEAN
,
316 'title' => ts('Price Field Show Amounts?') ,
317 'description' => 'Should the price be displayed next to the label for each option?',
319 'table_name' => 'civicrm_price_field',
320 'entity' => 'PriceField',
321 'bao' => 'CRM_Price_BAO_PriceField',
324 'type' => 'CheckBox',
327 'options_per_line' => array(
328 'name' => 'options_per_line',
329 'type' => CRM_Utils_Type
::T_INT
,
330 'title' => ts('Price Field Options per Row') ,
331 'description' => 'number of options per line for checkbox and radio',
333 'table_name' => 'civicrm_price_field',
334 'entity' => 'PriceField',
335 'bao' => 'CRM_Price_BAO_PriceField',
341 'is_active' => array(
342 'name' => 'is_active',
343 'type' => CRM_Utils_Type
::T_BOOLEAN
,
344 'title' => ts('Price Field Is Active?') ,
345 'description' => 'Is this price field active',
347 'table_name' => 'civicrm_price_field',
348 'entity' => 'PriceField',
349 'bao' => 'CRM_Price_BAO_PriceField',
352 'type' => 'CheckBox',
355 'is_required' => array(
356 'name' => 'is_required',
357 'type' => CRM_Utils_Type
::T_BOOLEAN
,
358 'title' => ts('Price Field is Required?') ,
359 'description' => 'Is this price field required (value must be > 1)',
361 'table_name' => 'civicrm_price_field',
362 'entity' => 'PriceField',
363 'bao' => 'CRM_Price_BAO_PriceField',
366 'type' => 'CheckBox',
369 'active_on' => array(
370 'name' => 'active_on',
371 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
372 'title' => ts('Price Field Start Date') ,
373 'description' => 'If non-zero, do not show this field before the date specified',
375 'table_name' => 'civicrm_price_field',
376 'entity' => 'PriceField',
377 'bao' => 'CRM_Price_BAO_PriceField',
380 'type' => 'CheckBox',
383 'expire_on' => array(
384 'name' => 'expire_on',
385 'type' => CRM_Utils_Type
::T_DATE + CRM_Utils_Type
::T_TIME
,
386 'title' => ts('Price Field End Date') ,
387 'description' => 'If non-zero, do not show this field after the date specified',
389 'table_name' => 'civicrm_price_field',
390 'entity' => 'PriceField',
391 'bao' => 'CRM_Price_BAO_PriceField',
394 'type' => 'Select Date',
397 'javascript' => array(
398 'name' => 'javascript',
399 'type' => CRM_Utils_Type
::T_STRING
,
400 'title' => ts('Price Field Javascript') ,
401 'description' => 'Optional scripting attributes for field',
403 'size' => CRM_Utils_Type
::HUGE
,
404 'table_name' => 'civicrm_price_field',
405 'entity' => 'PriceField',
406 'bao' => 'CRM_Price_BAO_PriceField',
412 'visibility_id' => array(
413 'name' => 'visibility_id',
414 'type' => CRM_Utils_Type
::T_INT
,
415 'title' => ts('Price Field Visibility') ,
416 'description' => 'Implicit FK to civicrm_option_group with name = \'visibility\'',
418 'table_name' => 'civicrm_price_field',
419 'entity' => 'PriceField',
420 'bao' => 'CRM_Price_BAO_PriceField',
425 'pseudoconstant' => array(
426 'optionGroupName' => 'visibility',
427 'optionEditPath' => 'civicrm/admin/options/visibility',
431 CRM_Core_DAO_AllCoreTables
::invoke(__CLASS__
, 'fields_callback', Civi
::$statics[__CLASS__
]['fields']);
433 return Civi
::$statics[__CLASS__
]['fields'];
436 * Return a mapping from field-name to the corresponding key (as used in fields()).
439 * Array(string $name => string $uniqueName).
441 static function &fieldKeys() {
442 if (!isset(Civi
::$statics[__CLASS__
]['fieldKeys'])) {
443 Civi
::$statics[__CLASS__
]['fieldKeys'] = array_flip(CRM_Utils_Array
::collect('name', self
::fields()));
445 return Civi
::$statics[__CLASS__
]['fieldKeys'];
448 * Returns the names of this table
452 static function getTableName() {
453 return CRM_Core_DAO
::getLocaleTableName(self
::$_tableName);
456 * Returns if this table needs to be logged
464 * Returns the list of fields that can be imported
466 * @param bool $prefix
470 static function &import($prefix = false) {
471 $r = CRM_Core_DAO_AllCoreTables
::getImports(__CLASS__
, 'price_field', $prefix, array());
475 * Returns the list of fields that can be exported
477 * @param bool $prefix
481 static function &export($prefix = false) {
482 $r = CRM_Core_DAO_AllCoreTables
::getExports(__CLASS__
, 'price_field', $prefix, array());
486 * Returns the list of indices
488 public static function indices($localize = TRUE) {
490 'index_name' => array(
491 'name' => 'index_name',
495 'localizable' => false,
496 'sig' => 'civicrm_price_field::0::name',
499 return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables
::multilingualize(__CLASS__
, $indices) : $indices;