CRM/Member/DAO/MembershipBlock.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Member/MembershipBlock.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:becab4023b8e0c9d10b2081b7002467d)
  10  */
  11
  12 /**
  13  * Database access object for the MembershipBlock entity.
  14  */
  15 class CRM_Member_DAO_MembershipBlock extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_membership_block';
  23
  24   /**
  25    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  26    *
  27    * @var bool
  28    */
  29   public static $_log = TRUE;
  30
  31   /**
  32    * Membership Id
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * Name for Membership Status
  40    *
  41    * @var string
  42    */
  43   public $entity_table;
  44
  45   /**
  46    * FK to civicrm_contribution_page.id
  47    *
  48    * @var int
  49    */
  50   public $entity_id;
  51
  52   /**
  53    * Membership types to be exposed by this block
  54    *
  55    * @var string
  56    */
  57   public $membership_types;
  58
  59   /**
  60    * Optional foreign key to membership_type
  61    *
  62    * @var int
  63    */
  64   public $membership_type_default;
  65
  66   /**
  67    * Display minimum membership fee
  68    *
  69    * @var bool
  70    */
  71   public $display_min_fee;
  72
  73   /**
  74    * Should membership transactions be processed separately
  75    *
  76    * @var bool
  77    */
  78   public $is_separate_payment;
  79
  80   /**
  81    * Title to display at top of block
  82    *
  83    * @var string
  84    */
  85   public $new_title;
  86
  87   /**
  88    * Text to display below title
  89    *
  90    * @var text
  91    */
  92   public $new_text;
  93
  94   /**
  95    * Title for renewal
  96    *
  97    * @var string
  98    */
  99   public $renewal_title;
 100
 101   /**
 102    * Text to display for member renewal
 103    *
 104    * @var text
 105    */
 106   public $renewal_text;
 107
 108   /**
 109    * Is membership sign up optional
 110    *
 111    * @var bool
 112    */
 113   public $is_required;
 114
 115   /**
 116    * Is this membership_block enabled
 117    *
 118    * @var bool
 119    */
 120   public $is_active;
 121
 122   /**
 123    * Class constructor.
 124    */
 125   public function __construct() {
 126     $this->__table = 'civicrm_membership_block';
 127     parent::__construct();
 128   }
 129
 130   /**
 131    * Returns localized title of this entity.
 132    */
 133   public static function getEntityTitle() {
 134     return ts('Membership Blocks');
 135   }
 136
 137   /**
 138    * Returns foreign keys and entity references.
 139    *
 140    * @return array
 141    *   [CRM_Core_Reference_Interface]
 142    */
 143   public static function getReferenceColumns() {
 144     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 145       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 146       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'entity_id', 'civicrm_contribution_page', 'id');
 147       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'membership_type_default', 'civicrm_membership_type', 'id');
 148       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 149     }
 150     return Civi::$statics[__CLASS__]['links'];
 151   }
 152
 153   /**
 154    * Returns all the column names of this table
 155    *
 156    * @return array
 157    */
 158   public static function &fields() {
 159     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 160       Civi::$statics[__CLASS__]['fields'] = [
 161         'id' => [
 162           'name' => 'id',
 163           'type' => CRM_Utils_Type::T_INT,
 164           'title' => ts('Membership Block ID'),
 165           'description' => ts('Membership Id'),
 166           'required' => TRUE,
 167           'where' => 'civicrm_membership_block.id',
 168           'table_name' => 'civicrm_membership_block',
 169           'entity' => 'MembershipBlock',
 170           'bao' => 'CRM_Member_BAO_MembershipBlock',
 171           'localizable' => 0,
 172         ],
 173         'entity_table' => [
 174           'name' => 'entity_table',
 175           'type' => CRM_Utils_Type::T_STRING,
 176           'title' => ts('Membership Block Entity Table'),
 177           'description' => ts('Name for Membership Status'),
 178           'maxlength' => 64,
 179           'size' => CRM_Utils_Type::BIG,
 180           'where' => 'civicrm_membership_block.entity_table',
 181           'table_name' => 'civicrm_membership_block',
 182           'entity' => 'MembershipBlock',
 183           'bao' => 'CRM_Member_BAO_MembershipBlock',
 184           'localizable' => 0,
 185         ],
 186         'entity_id' => [
 187           'name' => 'entity_id',
 188           'type' => CRM_Utils_Type::T_INT,
 189           'title' => ts('Membership Block Entity ID'),
 190           'description' => ts('FK to civicrm_contribution_page.id'),
 191           'required' => TRUE,
 192           'where' => 'civicrm_membership_block.entity_id',
 193           'table_name' => 'civicrm_membership_block',
 194           'entity' => 'MembershipBlock',
 195           'bao' => 'CRM_Member_BAO_MembershipBlock',
 196           'localizable' => 0,
 197           'FKClassName' => 'CRM_Contribute_DAO_ContributionPage',
 198         ],
 199         'membership_types' => [
 200           'name' => 'membership_types',
 201           'type' => CRM_Utils_Type::T_STRING,
 202           'title' => ts('Membership Block Membership Types'),
 203           'description' => ts('Membership types to be exposed by this block'),
 204           'maxlength' => 1024,
 205           'size' => CRM_Utils_Type::HUGE,
 206           'where' => 'civicrm_membership_block.membership_types',
 207           'table_name' => 'civicrm_membership_block',
 208           'entity' => 'MembershipBlock',
 209           'bao' => 'CRM_Member_BAO_MembershipBlock',
 210           'localizable' => 0,
 211           'serialize' => self::SERIALIZE_PHP,
 212         ],
 213         'membership_type_default' => [
 214           'name' => 'membership_type_default',
 215           'type' => CRM_Utils_Type::T_INT,
 216           'title' => ts('Membership Block Default Type'),
 217           'description' => ts('Optional foreign key to membership_type'),
 218           'where' => 'civicrm_membership_block.membership_type_default',
 219           'table_name' => 'civicrm_membership_block',
 220           'entity' => 'MembershipBlock',
 221           'bao' => 'CRM_Member_BAO_MembershipBlock',
 222           'localizable' => 0,
 223           'FKClassName' => 'CRM_Member_DAO_MembershipType',
 224         ],
 225         'display_min_fee' => [
 226           'name' => 'display_min_fee',
 227           'type' => CRM_Utils_Type::T_BOOLEAN,
 228           'title' => ts('Membership Block Display Minimum Fee'),
 229           'description' => ts('Display minimum membership fee'),
 230           'where' => 'civicrm_membership_block.display_min_fee',
 231           'default' => '1',
 232           'table_name' => 'civicrm_membership_block',
 233           'entity' => 'MembershipBlock',
 234           'bao' => 'CRM_Member_BAO_MembershipBlock',
 235           'localizable' => 0,
 236         ],
 237         'is_separate_payment' => [
 238           'name' => 'is_separate_payment',
 239           'type' => CRM_Utils_Type::T_BOOLEAN,
 240           'title' => ts('Membership Block Is Separate Payment'),
 241           'description' => ts('Should membership transactions be processed separately'),
 242           'where' => 'civicrm_membership_block.is_separate_payment',
 243           'default' => '1',
 244           'table_name' => 'civicrm_membership_block',
 245           'entity' => 'MembershipBlock',
 246           'bao' => 'CRM_Member_BAO_MembershipBlock',
 247           'localizable' => 0,
 248         ],
 249         'new_title' => [
 250           'name' => 'new_title',
 251           'type' => CRM_Utils_Type::T_STRING,
 252           'title' => ts('Membership Block New Title'),
 253           'description' => ts('Title to display at top of block'),
 254           'maxlength' => 255,
 255           'size' => CRM_Utils_Type::HUGE,
 256           'where' => 'civicrm_membership_block.new_title',
 257           'table_name' => 'civicrm_membership_block',
 258           'entity' => 'MembershipBlock',
 259           'bao' => 'CRM_Member_BAO_MembershipBlock',
 260           'localizable' => 1,
 261         ],
 262         'new_text' => [
 263           'name' => 'new_text',
 264           'type' => CRM_Utils_Type::T_TEXT,
 265           'title' => ts('Membership Block New Text'),
 266           'description' => ts('Text to display below title'),
 267           'where' => 'civicrm_membership_block.new_text',
 268           'table_name' => 'civicrm_membership_block',
 269           'entity' => 'MembershipBlock',
 270           'bao' => 'CRM_Member_BAO_MembershipBlock',
 271           'localizable' => 1,
 272         ],
 273         'renewal_title' => [
 274           'name' => 'renewal_title',
 275           'type' => CRM_Utils_Type::T_STRING,
 276           'title' => ts('Membership Block Renewal Title'),
 277           'description' => ts('Title for renewal'),
 278           'maxlength' => 255,
 279           'size' => CRM_Utils_Type::HUGE,
 280           'where' => 'civicrm_membership_block.renewal_title',
 281           'table_name' => 'civicrm_membership_block',
 282           'entity' => 'MembershipBlock',
 283           'bao' => 'CRM_Member_BAO_MembershipBlock',
 284           'localizable' => 1,
 285         ],
 286         'renewal_text' => [
 287           'name' => 'renewal_text',
 288           'type' => CRM_Utils_Type::T_TEXT,
 289           'title' => ts('Membership Block Renewal Text'),
 290           'description' => ts('Text to display for member renewal'),
 291           'where' => 'civicrm_membership_block.renewal_text',
 292           'table_name' => 'civicrm_membership_block',
 293           'entity' => 'MembershipBlock',
 294           'bao' => 'CRM_Member_BAO_MembershipBlock',
 295           'localizable' => 1,
 296         ],
 297         'is_required' => [
 298           'name' => 'is_required',
 299           'type' => CRM_Utils_Type::T_BOOLEAN,
 300           'title' => ts('Is Required'),
 301           'description' => ts('Is membership sign up optional'),
 302           'where' => 'civicrm_membership_block.is_required',
 303           'default' => '0',
 304           'table_name' => 'civicrm_membership_block',
 305           'entity' => 'MembershipBlock',
 306           'bao' => 'CRM_Member_BAO_MembershipBlock',
 307           'localizable' => 0,
 308         ],
 309         'is_active' => [
 310           'name' => 'is_active',
 311           'type' => CRM_Utils_Type::T_BOOLEAN,
 312           'title' => ts('Is Active'),
 313           'description' => ts('Is this membership_block enabled'),
 314           'where' => 'civicrm_membership_block.is_active',
 315           'default' => '1',
 316           'table_name' => 'civicrm_membership_block',
 317           'entity' => 'MembershipBlock',
 318           'bao' => 'CRM_Member_BAO_MembershipBlock',
 319           'localizable' => 0,
 320         ],
 321       ];
 322       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 323     }
 324     return Civi::$statics[__CLASS__]['fields'];
 325   }
 326
 327   /**
 328    * Return a mapping from field-name to the corresponding key (as used in fields()).
 329    *
 330    * @return array
 331    *   Array(string $name => string $uniqueName).
 332    */
 333   public static function &fieldKeys() {
 334     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 335       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 336     }
 337     return Civi::$statics[__CLASS__]['fieldKeys'];
 338   }
 339
 340   /**
 341    * Returns the names of this table
 342    *
 343    * @return string
 344    */
 345   public static function getTableName() {
 346     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 347   }
 348
 349   /**
 350    * Returns if this table needs to be logged
 351    *
 352    * @return bool
 353    */
 354   public function getLog() {
 355     return self::$_log;
 356   }
 357
 358   /**
 359    * Returns the list of fields that can be imported
 360    *
 361    * @param bool $prefix
 362    *
 363    * @return array
 364    */
 365   public static function &import($prefix = FALSE) {
 366     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_block', $prefix, []);
 367     return $r;
 368   }
 369
 370   /**
 371    * Returns the list of fields that can be exported
 372    *
 373    * @param bool $prefix
 374    *
 375    * @return array
 376    */
 377   public static function &export($prefix = FALSE) {
 378     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_block', $prefix, []);
 379     return $r;
 380   }
 381
 382   /**
 383    * Returns the list of indices
 384    *
 385    * @param bool $localize
 386    *
 387    * @return array
 388    */
 389   public static function indices($localize = TRUE) {
 390     $indices = [];
 391     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 392   }
 393
 394 }