523 lines
18 KiB
PHP
523 lines
18 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/Member/Membership.xml
|
|
* DO NOT EDIT. Generated by CRM_Core_CodeGen
|
|
* (GenCodeChecksum:1a9ebe9e0d3ab9247f2a3dda32bab22a)
|
|
*/
|
|
require_once 'CRM/Core/DAO.php';
|
|
require_once 'CRM/Utils/Type.php';
|
|
/**
|
|
* CRM_Member_DAO_Membership constructor.
|
|
*/
|
|
class CRM_Member_DAO_Membership extends CRM_Core_DAO {
|
|
/**
|
|
* Static instance to hold the table name.
|
|
*
|
|
* @var string
|
|
*/
|
|
static $_tableName = 'civicrm_membership';
|
|
/**
|
|
* Should CiviCRM log any modifications to this table in the civicrm_log table.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
static $_log = true;
|
|
/**
|
|
* Membership Id
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $id;
|
|
/**
|
|
* FK to Contact ID
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $contact_id;
|
|
/**
|
|
* FK to Membership Type
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $membership_type_id;
|
|
/**
|
|
* Beginning of initial membership period (member since...).
|
|
*
|
|
* @var date
|
|
*/
|
|
public $join_date;
|
|
/**
|
|
* Beginning of current uninterrupted membership period.
|
|
*
|
|
* @var date
|
|
*/
|
|
public $start_date;
|
|
/**
|
|
* Current membership period expire date.
|
|
*
|
|
* @var date
|
|
*/
|
|
public $end_date;
|
|
/**
|
|
*
|
|
* @var string
|
|
*/
|
|
public $source;
|
|
/**
|
|
* FK to Membership Status
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $status_id;
|
|
/**
|
|
* Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_override;
|
|
/**
|
|
* Optional FK to Parent Membership.
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $owner_membership_id;
|
|
/**
|
|
* Maximum number of related memberships (membership_type override).
|
|
*
|
|
* @var int
|
|
*/
|
|
public $max_related;
|
|
/**
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_test;
|
|
/**
|
|
*
|
|
* @var boolean
|
|
*/
|
|
public $is_pay_later;
|
|
/**
|
|
* Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $contribution_recur_id;
|
|
/**
|
|
* The campaign for which this membership is attached.
|
|
*
|
|
* @var int unsigned
|
|
*/
|
|
public $campaign_id;
|
|
/**
|
|
* Class constructor.
|
|
*/
|
|
function __construct() {
|
|
$this->__table = 'civicrm_membership';
|
|
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');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'membership_type_id', 'civicrm_membership_type', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'status_id', 'civicrm_membership_status', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'owner_membership_id', 'civicrm_membership', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'contribution_recur_id', 'civicrm_contribution_recur', 'id');
|
|
Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName() , 'campaign_id', 'civicrm_campaign', '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(
|
|
'membership_id' => array(
|
|
'name' => 'id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Membership ID') ,
|
|
'description' => 'Membership Id',
|
|
'required' => true,
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.id',
|
|
'headerPattern' => '/^(m(embership\s)?id)$/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
) ,
|
|
'membership_contact_id' => array(
|
|
'name' => 'contact_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Contact ID') ,
|
|
'description' => 'FK to Contact ID',
|
|
'required' => true,
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.contact_id',
|
|
'headerPattern' => '/contact(.?id)?/i',
|
|
'dataPattern' => '/^\d+$/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Contact_DAO_Contact',
|
|
'html' => array(
|
|
'type' => 'EntityRef',
|
|
) ,
|
|
) ,
|
|
'membership_type_id' => array(
|
|
'name' => 'membership_type_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Membership Type Id') ,
|
|
'description' => 'FK to Membership Type',
|
|
'required' => true,
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.membership_type_id',
|
|
'headerPattern' => '/^(m(embership\s)?type)$/i',
|
|
'dataPattern' => '',
|
|
'export' => false,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Member_DAO_MembershipType',
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_membership_type',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'name',
|
|
)
|
|
) ,
|
|
'join_date' => array(
|
|
'name' => 'join_date',
|
|
'type' => CRM_Utils_Type::T_DATE,
|
|
'title' => ts('Member Since') ,
|
|
'description' => 'Beginning of initial membership period (member since...).',
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.join_date',
|
|
'headerPattern' => '/^join|(j(oin\s)?date)$/i',
|
|
'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDate',
|
|
) ,
|
|
) ,
|
|
'membership_start_date' => array(
|
|
'name' => 'start_date',
|
|
'type' => CRM_Utils_Type::T_DATE,
|
|
'title' => ts('Membership Start Date') ,
|
|
'description' => 'Beginning of current uninterrupted membership period.',
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.start_date',
|
|
'headerPattern' => '/(member(ship)?.)?start(s)?(.date$)?/i',
|
|
'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDate',
|
|
) ,
|
|
) ,
|
|
'membership_end_date' => array(
|
|
'name' => 'end_date',
|
|
'type' => CRM_Utils_Type::T_DATE,
|
|
'title' => ts('Membership Expiration Date') ,
|
|
'description' => 'Current membership period expire date.',
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.end_date',
|
|
'headerPattern' => '/(member(ship)?.)?end(s)?(.date$)?/i',
|
|
'dataPattern' => '/\d{4}-?\d{2}-?\d{2}/',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Select Date',
|
|
'formatType' => 'activityDate',
|
|
) ,
|
|
) ,
|
|
'membership_source' => array(
|
|
'name' => 'source',
|
|
'type' => CRM_Utils_Type::T_STRING,
|
|
'title' => ts('Source') ,
|
|
'maxlength' => 128,
|
|
'size' => CRM_Utils_Type::HUGE,
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.source',
|
|
'headerPattern' => '/^(member(ship?))?source$/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'status_id' => array(
|
|
'name' => 'status_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Membership Status Id') ,
|
|
'description' => 'FK to Membership Status',
|
|
'required' => true,
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.status_id',
|
|
'headerPattern' => '/(member(ship|).)?(status)$/i',
|
|
'dataPattern' => '',
|
|
'export' => false,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Member_DAO_MembershipStatus',
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_membership_status',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'label',
|
|
)
|
|
) ,
|
|
'is_override' => array(
|
|
'name' => 'is_override',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Status Override') ,
|
|
'description' => 'Admin users may set a manual status which overrides the calculated status. When this flag is true, automated status update scripts should NOT modify status for the record.',
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.is_override',
|
|
'headerPattern' => '/override$/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'CheckBox',
|
|
) ,
|
|
) ,
|
|
'owner_membership_id' => array(
|
|
'name' => 'owner_membership_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Primary Member ID') ,
|
|
'description' => 'Optional FK to Parent Membership.',
|
|
'export' => true,
|
|
'where' => 'civicrm_membership.owner_membership_id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Member_DAO_Membership',
|
|
) ,
|
|
'max_related' => array(
|
|
'name' => 'max_related',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Max Related') ,
|
|
'description' => 'Maximum number of related memberships (membership_type override).',
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'Text',
|
|
) ,
|
|
) ,
|
|
'member_is_test' => array(
|
|
'name' => 'is_test',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Test') ,
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.is_test',
|
|
'headerPattern' => '/(is.)?test(.member(ship)?)?/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'CheckBox',
|
|
) ,
|
|
) ,
|
|
'member_is_pay_later' => array(
|
|
'name' => 'is_pay_later',
|
|
'type' => CRM_Utils_Type::T_BOOLEAN,
|
|
'title' => ts('Is Pay Later') ,
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.is_pay_later',
|
|
'headerPattern' => '/(is.)?(pay(.)?later)$/i',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'html' => array(
|
|
'type' => 'CheckBox',
|
|
) ,
|
|
) ,
|
|
'contribution_recur_id' => array(
|
|
'name' => 'contribution_recur_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Membership Recurring Contribution') ,
|
|
'description' => 'Conditional foreign key to civicrm_contribution_recur id. Each membership in connection with a recurring contribution carries a foreign key to the recurring contribution record. This assumes we can track these processor initiated events.',
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Contribute_DAO_ContributionRecur',
|
|
) ,
|
|
'member_campaign_id' => array(
|
|
'name' => 'campaign_id',
|
|
'type' => CRM_Utils_Type::T_INT,
|
|
'title' => ts('Campaign') ,
|
|
'description' => 'The campaign for which this membership is attached.',
|
|
'import' => true,
|
|
'where' => 'civicrm_membership.campaign_id',
|
|
'headerPattern' => '',
|
|
'dataPattern' => '',
|
|
'export' => true,
|
|
'table_name' => 'civicrm_membership',
|
|
'entity' => 'Membership',
|
|
'bao' => 'CRM_Member_BAO_Membership',
|
|
'localizable' => 0,
|
|
'FKClassName' => 'CRM_Campaign_DAO_Campaign',
|
|
'html' => array(
|
|
'type' => 'Select',
|
|
) ,
|
|
'pseudoconstant' => array(
|
|
'table' => 'civicrm_campaign',
|
|
'keyColumn' => 'id',
|
|
'labelColumn' => 'title',
|
|
)
|
|
) ,
|
|
);
|
|
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__, 'membership', $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__, 'membership', $prefix, array());
|
|
return $r;
|
|
}
|
|
/**
|
|
* Returns the list of indices
|
|
*/
|
|
public static function indices($localize = TRUE) {
|
|
$indices = array(
|
|
'index_owner_membership_id' => array(
|
|
'name' => 'index_owner_membership_id',
|
|
'field' => array(
|
|
0 => 'owner_membership_id',
|
|
) ,
|
|
'localizable' => false,
|
|
'sig' => 'civicrm_membership::0::owner_membership_id',
|
|
) ,
|
|
);
|
|
return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
|
|
}
|
|
}
|