drupal-civicrm/sites/all/modules/civicrm/CRM/PCP/DAO/PCP.php
2018-01-14 13:10:16 +00:00

460 lines
14 KiB
PHP

<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2017 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM is distributed in the hope that it will be useful, but |
| WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the GNU Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
/**
* @package CRM
* @copyright CiviCRM LLC (c) 2004-2017
*
* Generated from xml/schema/CRM/PCP/PCP.xml
* DO NOT EDIT. Generated by CRM_Core_CodeGen
* (GenCodeChecksum:6913feaec692244b1d39e330ba00188c)
*/
require_once 'CRM/Core/DAO.php';
require_once 'CRM/Utils/Type.php';
/**
* CRM_PCP_DAO_PCP constructor.
*/
class CRM_PCP_DAO_PCP extends CRM_Core_DAO {
/**
* Static instance to hold the table name.
*
* @var string
*/
static $_tableName = 'civicrm_pcp';
/**
* Should CiviCRM log any modifications to this table in the civicrm_log table.
*
* @var boolean
*/
static $_log = true;
/**
* Personal Campaign Page ID
*
* @var int unsigned
*/
public $id;
/**
* FK to Contact ID
*
* @var int unsigned
*/
public $contact_id;
/**
*
* @var int unsigned
*/
public $status_id;
/**
*
* @var string
*/
public $title;
/**
*
* @var text
*/
public $intro_text;
/**
*
* @var text
*/
public $page_text;
/**
*
* @var string
*/
public $donate_link_text;
/**
* The Contribution or Event Page which triggered this pcp
*
* @var int unsigned
*/
public $page_id;
/**
* The type of PCP this is: contribute or event
*
* @var string
*/
public $page_type;
/**
* The pcp block that this pcp page was created from
*
* @var int unsigned
*/
public $pcp_block_id;
/**
*
* @var int unsigned
*/
public $is_thermometer;
/**
*
* @var int unsigned
*/
public $is_honor_roll;
/**
* Goal amount of this Personal Campaign Page.
*
* @var float
*/
public $goal_amount;
/**
* 3 character string, value from config setting or input via user.
*
* @var string
*/
public $currency;
/**
* Is Personal Campaign Page enabled/active?
*
* @var boolean
*/
public $is_active;
/**
* Notify owner via email when someone donates to page?
*
* @var boolean
*/
public $is_notify;
/**
* Class constructor.
*/
function __construct() {
$this->__table = 'civicrm_pcp';
parent::__construct();
}
/**
* Returns foreign keys and entity references.
*
* @return array
* [CRM_Core_Reference_Interface]
*/
static function getReferenceColumns() {
if (!isset(Civi::$statics[__CLASS__]['links'])) {
Civi::$statics[__CLASS__]['links'] = static ::createReferenceColumns(__CLASS__);
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contact_id', 'civicrm_contact', 'id');
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
}
return Civi::$statics[__CLASS__]['links'];
}
/**
* Returns all the column names of this table
*
* @return array
*/
static function &fields() {
if (!isset(Civi::$statics[__CLASS__]['fields'])) {
Civi::$statics[__CLASS__]['fields'] = array(
'pcp_id' => array(
'name' => 'id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Personal Campaign Page ID') ,
'description' => 'Personal Campaign Page ID',
'required' => true,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
) ,
'pcp_contact_id' => array(
'name' => 'contact_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Contact ID') ,
'description' => 'FK to Contact ID',
'required' => true,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'FKClassName' => 'CRM_Contact_DAO_Contact',
'html' => array(
'type' => 'EntityRef',
) ,
) ,
'status_id' => array(
'name' => 'status_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Personal Campaign Page Status') ,
'required' => true,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'Select',
) ,
'pseudoconstant' => array(
'optionGroupName' => 'pcp_status',
'optionEditPath' => 'civicrm/admin/options/pcp_status',
)
) ,
'title' => array(
'name' => 'title',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Personal Campaign Page Title') ,
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'default' => 'NULL',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'Text',
) ,
) ,
'intro_text' => array(
'name' => 'intro_text',
'type' => CRM_Utils_Type::T_TEXT,
'title' => ts('Intro Text') ,
'default' => 'NULL',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'TextArea',
) ,
) ,
'page_text' => array(
'name' => 'page_text',
'type' => CRM_Utils_Type::T_TEXT,
'title' => ts('Page Text') ,
'default' => 'NULL',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'TextArea',
) ,
) ,
'donate_link_text' => array(
'name' => 'donate_link_text',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Donate Link Text') ,
'maxlength' => 255,
'size' => CRM_Utils_Type::HUGE,
'default' => 'NULL',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'Text',
) ,
) ,
'page_id' => array(
'name' => 'page_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Contribution Page') ,
'description' => 'The Contribution or Event Page which triggered this pcp',
'required' => true,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
) ,
'page_type' => array(
'name' => 'page_type',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('PCP Page Type') ,
'description' => 'The type of PCP this is: contribute or event',
'maxlength' => 64,
'size' => CRM_Utils_Type::BIG,
'default' => 'contribute',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'Select',
) ,
) ,
'pcp_block_id' => array(
'name' => 'pcp_block_id',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('PCP Block') ,
'description' => 'The pcp block that this pcp page was created from',
'required' => true,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
) ,
'is_thermometer' => array(
'name' => 'is_thermometer',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Use Thermometer?') ,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'CheckBox',
) ,
) ,
'is_honor_roll' => array(
'name' => 'is_honor_roll',
'type' => CRM_Utils_Type::T_INT,
'title' => ts('Show Honor Roll?') ,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'CheckBox',
) ,
) ,
'goal_amount' => array(
'name' => 'goal_amount',
'type' => CRM_Utils_Type::T_MONEY,
'title' => ts('Goal Amount') ,
'description' => 'Goal amount of this Personal Campaign Page.',
'precision' => array(
20,
2
) ,
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'Text',
) ,
) ,
'currency' => array(
'name' => 'currency',
'type' => CRM_Utils_Type::T_STRING,
'title' => ts('Currency') ,
'description' => '3 character string, value from config setting or input via user.',
'maxlength' => 3,
'size' => CRM_Utils_Type::FOUR,
'default' => 'NULL',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'Select',
) ,
'pseudoconstant' => array(
'table' => 'civicrm_currency',
'keyColumn' => 'name',
'labelColumn' => 'full_name',
'nameColumn' => 'name',
)
) ,
'is_active' => array(
'name' => 'is_active',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Enabled?') ,
'description' => 'Is Personal Campaign Page enabled/active?',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'CheckBox',
) ,
) ,
'is_notify' => array(
'name' => 'is_notify',
'type' => CRM_Utils_Type::T_BOOLEAN,
'title' => ts('Notify Owner?') ,
'description' => 'Notify owner via email when someone donates to page?',
'table_name' => 'civicrm_pcp',
'entity' => 'PCP',
'bao' => 'CRM_PCP_BAO_PCP',
'localizable' => 0,
'html' => array(
'type' => 'CheckBox',
) ,
) ,
);
CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
}
return Civi::$statics[__CLASS__]['fields'];
}
/**
* Return a mapping from field-name to the corresponding key (as used in fields()).
*
* @return array
* Array(string $name => string $uniqueName).
*/
static function &fieldKeys() {
if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
}
return Civi::$statics[__CLASS__]['fieldKeys'];
}
/**
* Returns the names of this table
*
* @return string
*/
static function getTableName() {
return self::$_tableName;
}
/**
* Returns if this table needs to be logged
*
* @return boolean
*/
function getLog() {
return self::$_log;
}
/**
* Returns the list of fields that can be imported
*
* @param bool $prefix
*
* @return array
*/
static function &import($prefix = false) {
$r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'pcp', $prefix, array());
return $r;
}
/**
* Returns the list of fields that can be exported
*
* @param bool $prefix
*
* @return array
*/
static function &export($prefix = false) {
$r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'pcp', $prefix, array());
return $r;
}
/**
* Returns the list of indices
*/
public static function indices($localize = TRUE) {
$indices = array();
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
}
}