CRM/Member/DAO/MembershipStatus.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Member/MembershipStatus.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:7a244bc9a0db34ad31adc004d97e1945)
  10  */
  11
  12 /**
  13  * Database access object for the MembershipStatus entity.
  14  */
  15 class CRM_Member_DAO_MembershipStatus extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.5';
  18   const COMPONENT = 'CiviMember';
  19
  20   /**
  21    * Static instance to hold the table name.
  22    *
  23    * @var string
  24    */
  25   public static $_tableName = 'civicrm_membership_status';
  26
  27   /**
  28    * Field to show when displaying a record.
  29    *
  30    * @var string
  31    */
  32   public static $_labelField = 'label';
  33
  34   /**
  35    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  36    *
  37    * @var bool
  38    */
  39   public static $_log = TRUE;
  40
  41   /**
  42    * Membership ID
  43    *
  44    * @var int
  45    */
  46   public $id;
  47
  48   /**
  49    * Name for Membership Status
  50    *
  51    * @var string
  52    */
  53   public $name;
  54
  55   /**
  56    * Label for Membership Status
  57    *
  58    * @var string
  59    */
  60   public $label;
  61
  62   /**
  63    * Event when this status starts.
  64    *
  65    * @var string
  66    */
  67   public $start_event;
  68
  69   /**
  70    * Unit used for adjusting from start_event.
  71    *
  72    * @var string
  73    */
  74   public $start_event_adjust_unit;
  75
  76   /**
  77    * Status range begins this many units from start_event.
  78    *
  79    * @var int
  80    */
  81   public $start_event_adjust_interval;
  82
  83   /**
  84    * Event after which this status ends.
  85    *
  86    * @var string
  87    */
  88   public $end_event;
  89
  90   /**
  91    * Unit used for adjusting from the ending event.
  92    *
  93    * @var string
  94    */
  95   public $end_event_adjust_unit;
  96
  97   /**
  98    * Status range ends this many units from end_event.
  99    *
 100    * @var int
 101    */
 102   public $end_event_adjust_interval;
 103
 104   /**
 105    * Does this status aggregate to current members (e.g. New, Renewed, Grace might all be TRUE... while Unrenewed, Lapsed, Inactive would be FALSE).
 106    *
 107    * @var bool
 108    */
 109   public $is_current_member;
 110
 111   /**
 112    * Is this status for admin/manual assignment only.
 113    *
 114    * @var bool
 115    */
 116   public $is_admin;
 117
 118   /**
 119    * @var int
 120    */
 121   public $weight;
 122
 123   /**
 124    * Assign this status to a membership record if no other status match is found.
 125    *
 126    * @var bool
 127    */
 128   public $is_default;
 129
 130   /**
 131    * Is this membership_status enabled.
 132    *
 133    * @var bool
 134    */
 135   public $is_active;
 136
 137   /**
 138    * Is this membership_status reserved.
 139    *
 140    * @var bool
 141    */
 142   public $is_reserved;
 143
 144   /**
 145    * Class constructor.
 146    */
 147   public function __construct() {
 148     $this->__table = 'civicrm_membership_status';
 149     parent::__construct();
 150   }
 151
 152   /**
 153    * Returns localized title of this entity.
 154    *
 155    * @param bool $plural
 156    *   Whether to return the plural version of the title.
 157    */
 158   public static function getEntityTitle($plural = FALSE) {
 159     return $plural ? ts('Membership Statuses') : ts('Membership Status');
 160   }
 161
 162   /**
 163    * Returns all the column names of this table
 164    *
 165    * @return array
 166    */
 167   public static function &fields() {
 168     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 169       Civi::$statics[__CLASS__]['fields'] = [
 170         'id' => [
 171           'name' => 'id',
 172           'type' => CRM_Utils_Type::T_INT,
 173           'title' => ts('Membership Status ID'),
 174           'description' => ts('Membership ID'),
 175           'required' => TRUE,
 176           'where' => 'civicrm_membership_status.id',
 177           'table_name' => 'civicrm_membership_status',
 178           'entity' => 'MembershipStatus',
 179           'bao' => 'CRM_Member_BAO_MembershipStatus',
 180           'localizable' => 0,
 181           'html' => [
 182             'type' => 'Number',
 183           ],
 184           'add' => '1.5',
 185         ],
 186         'membership_status' => [
 187           'name' => 'name',
 188           'type' => CRM_Utils_Type::T_STRING,
 189           'title' => ts('Membership Status'),
 190           'description' => ts('Name for Membership Status'),
 191           'maxlength' => 128,
 192           'size' => CRM_Utils_Type::HUGE,
 193           'import' => TRUE,
 194           'where' => 'civicrm_membership_status.name',
 195           'export' => TRUE,
 196           'table_name' => 'civicrm_membership_status',
 197           'entity' => 'MembershipStatus',
 198           'bao' => 'CRM_Member_BAO_MembershipStatus',
 199           'localizable' => 0,
 200           'add' => '1.5',
 201         ],
 202         'label' => [
 203           'name' => 'label',
 204           'type' => CRM_Utils_Type::T_STRING,
 205           'title' => ts('Label'),
 206           'description' => ts('Label for Membership Status'),
 207           'maxlength' => 128,
 208           'size' => CRM_Utils_Type::HUGE,
 209           'where' => 'civicrm_membership_status.label',
 210           'table_name' => 'civicrm_membership_status',
 211           'entity' => 'MembershipStatus',
 212           'bao' => 'CRM_Member_BAO_MembershipStatus',
 213           'localizable' => 1,
 214           'html' => [
 215             'type' => 'Text',
 216           ],
 217           'add' => '3.2',
 218         ],
 219         'start_event' => [
 220           'name' => 'start_event',
 221           'type' => CRM_Utils_Type::T_STRING,
 222           'title' => ts('Start Event'),
 223           'description' => ts('Event when this status starts.'),
 224           'maxlength' => 12,
 225           'size' => CRM_Utils_Type::TWELVE,
 226           'where' => 'civicrm_membership_status.start_event',
 227           'table_name' => 'civicrm_membership_status',
 228           'entity' => 'MembershipStatus',
 229           'bao' => 'CRM_Member_BAO_MembershipStatus',
 230           'localizable' => 0,
 231           'html' => [
 232             'type' => 'Select',
 233           ],
 234           'pseudoconstant' => [
 235             'callback' => 'CRM_Core_SelectValues::eventDate',
 236           ],
 237           'add' => '1.5',
 238         ],
 239         'start_event_adjust_unit' => [
 240           'name' => 'start_event_adjust_unit',
 241           'type' => CRM_Utils_Type::T_STRING,
 242           'title' => ts('Start Event Adjust Unit'),
 243           'description' => ts('Unit used for adjusting from start_event.'),
 244           'maxlength' => 8,
 245           'size' => CRM_Utils_Type::EIGHT,
 246           'where' => 'civicrm_membership_status.start_event_adjust_unit',
 247           'table_name' => 'civicrm_membership_status',
 248           'entity' => 'MembershipStatus',
 249           'bao' => 'CRM_Member_BAO_MembershipStatus',
 250           'localizable' => 0,
 251           'html' => [
 252             'type' => 'Select',
 253           ],
 254           'pseudoconstant' => [
 255             'callback' => 'CRM_Core_SelectValues::unitList',
 256           ],
 257           'add' => '1.5',
 258         ],
 259         'start_event_adjust_interval' => [
 260           'name' => 'start_event_adjust_interval',
 261           'type' => CRM_Utils_Type::T_INT,
 262           'title' => ts('Start Event Adjust Interval'),
 263           'description' => ts('Status range begins this many units from start_event.'),
 264           'where' => 'civicrm_membership_status.start_event_adjust_interval',
 265           'table_name' => 'civicrm_membership_status',
 266           'entity' => 'MembershipStatus',
 267           'bao' => 'CRM_Member_BAO_MembershipStatus',
 268           'localizable' => 0,
 269           'add' => '1.5',
 270         ],
 271         'end_event' => [
 272           'name' => 'end_event',
 273           'type' => CRM_Utils_Type::T_STRING,
 274           'title' => ts('End Event'),
 275           'description' => ts('Event after which this status ends.'),
 276           'maxlength' => 12,
 277           'size' => CRM_Utils_Type::TWELVE,
 278           'where' => 'civicrm_membership_status.end_event',
 279           'table_name' => 'civicrm_membership_status',
 280           'entity' => 'MembershipStatus',
 281           'bao' => 'CRM_Member_BAO_MembershipStatus',
 282           'localizable' => 0,
 283           'html' => [
 284             'type' => 'Select',
 285           ],
 286           'pseudoconstant' => [
 287             'callback' => 'CRM_Core_SelectValues::eventDate',
 288           ],
 289           'add' => '1.5',
 290         ],
 291         'end_event_adjust_unit' => [
 292           'name' => 'end_event_adjust_unit',
 293           'type' => CRM_Utils_Type::T_STRING,
 294           'title' => ts('End Event Adjust Unit'),
 295           'description' => ts('Unit used for adjusting from the ending event.'),
 296           'maxlength' => 8,
 297           'size' => CRM_Utils_Type::EIGHT,
 298           'where' => 'civicrm_membership_status.end_event_adjust_unit',
 299           'table_name' => 'civicrm_membership_status',
 300           'entity' => 'MembershipStatus',
 301           'bao' => 'CRM_Member_BAO_MembershipStatus',
 302           'localizable' => 0,
 303           'html' => [
 304             'type' => 'Select',
 305           ],
 306           'pseudoconstant' => [
 307             'callback' => 'CRM_Core_SelectValues::unitList',
 308           ],
 309           'add' => '1.5',
 310         ],
 311         'end_event_adjust_interval' => [
 312           'name' => 'end_event_adjust_interval',
 313           'type' => CRM_Utils_Type::T_INT,
 314           'title' => ts('End Event Adjust Interval'),
 315           'description' => ts('Status range ends this many units from end_event.'),
 316           'where' => 'civicrm_membership_status.end_event_adjust_interval',
 317           'table_name' => 'civicrm_membership_status',
 318           'entity' => 'MembershipStatus',
 319           'bao' => 'CRM_Member_BAO_MembershipStatus',
 320           'localizable' => 0,
 321           'add' => '1.5',
 322         ],
 323         'is_current_member' => [
 324           'name' => 'is_current_member',
 325           'type' => CRM_Utils_Type::T_BOOLEAN,
 326           'title' => ts('Current Membership?'),
 327           'description' => ts('Does this status aggregate to current members (e.g. New, Renewed, Grace might all be TRUE... while Unrenewed, Lapsed, Inactive would be FALSE).'),
 328           'where' => 'civicrm_membership_status.is_current_member',
 329           'table_name' => 'civicrm_membership_status',
 330           'entity' => 'MembershipStatus',
 331           'bao' => 'CRM_Member_BAO_MembershipStatus',
 332           'localizable' => 0,
 333           'add' => '1.5',
 334         ],
 335         'is_admin' => [
 336           'name' => 'is_admin',
 337           'type' => CRM_Utils_Type::T_BOOLEAN,
 338           'title' => ts('Administrator Only?'),
 339           'description' => ts('Is this status for admin/manual assignment only.'),
 340           'where' => 'civicrm_membership_status.is_admin',
 341           'table_name' => 'civicrm_membership_status',
 342           'entity' => 'MembershipStatus',
 343           'bao' => 'CRM_Member_BAO_MembershipStatus',
 344           'localizable' => 0,
 345           'html' => [
 346             'type' => 'CheckBox',
 347           ],
 348           'add' => '1.5',
 349         ],
 350         'weight' => [
 351           'name' => 'weight',
 352           'type' => CRM_Utils_Type::T_INT,
 353           'title' => ts('Order'),
 354           'where' => 'civicrm_membership_status.weight',
 355           'table_name' => 'civicrm_membership_status',
 356           'entity' => 'MembershipStatus',
 357           'bao' => 'CRM_Member_BAO_MembershipStatus',
 358           'localizable' => 0,
 359           'add' => '1.5',
 360         ],
 361         'is_default' => [
 362           'name' => 'is_default',
 363           'type' => CRM_Utils_Type::T_BOOLEAN,
 364           'title' => ts('Default Status?'),
 365           'description' => ts('Assign this status to a membership record if no other status match is found.'),
 366           'where' => 'civicrm_membership_status.is_default',
 367           'table_name' => 'civicrm_membership_status',
 368           'entity' => 'MembershipStatus',
 369           'bao' => 'CRM_Member_BAO_MembershipStatus',
 370           'localizable' => 0,
 371           'html' => [
 372             'type' => 'CheckBox',
 373           ],
 374           'add' => '1.5',
 375         ],
 376         'is_active' => [
 377           'name' => 'is_active',
 378           'type' => CRM_Utils_Type::T_BOOLEAN,
 379           'title' => ts('Is Active'),
 380           'description' => ts('Is this membership_status enabled.'),
 381           'where' => 'civicrm_membership_status.is_active',
 382           'default' => '1',
 383           'table_name' => 'civicrm_membership_status',
 384           'entity' => 'MembershipStatus',
 385           'bao' => 'CRM_Member_BAO_MembershipStatus',
 386           'localizable' => 0,
 387           'html' => [
 388             'type' => 'CheckBox',
 389           ],
 390           'add' => '1.5',
 391         ],
 392         'is_reserved' => [
 393           'name' => 'is_reserved',
 394           'type' => CRM_Utils_Type::T_BOOLEAN,
 395           'title' => ts('Is Reserved'),
 396           'description' => ts('Is this membership_status reserved.'),
 397           'where' => 'civicrm_membership_status.is_reserved',
 398           'default' => '0',
 399           'table_name' => 'civicrm_membership_status',
 400           'entity' => 'MembershipStatus',
 401           'bao' => 'CRM_Member_BAO_MembershipStatus',
 402           'localizable' => 0,
 403           'html' => [
 404             'type' => 'CheckBox',
 405           ],
 406           'add' => '2.1',
 407         ],
 408       ];
 409       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 410     }
 411     return Civi::$statics[__CLASS__]['fields'];
 412   }
 413
 414   /**
 415    * Return a mapping from field-name to the corresponding key (as used in fields()).
 416    *
 417    * @return array
 418    *   Array(string $name => string $uniqueName).
 419    */
 420   public static function &fieldKeys() {
 421     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 422       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 423     }
 424     return Civi::$statics[__CLASS__]['fieldKeys'];
 425   }
 426
 427   /**
 428    * Returns the names of this table
 429    *
 430    * @return string
 431    */
 432   public static function getTableName() {
 433     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 434   }
 435
 436   /**
 437    * Returns if this table needs to be logged
 438    *
 439    * @return bool
 440    */
 441   public function getLog() {
 442     return self::$_log;
 443   }
 444
 445   /**
 446    * Returns the list of fields that can be imported
 447    *
 448    * @param bool $prefix
 449    *
 450    * @return array
 451    */
 452   public static function &import($prefix = FALSE) {
 453     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'membership_status', $prefix, []);
 454     return $r;
 455   }
 456
 457   /**
 458    * Returns the list of fields that can be exported
 459    *
 460    * @param bool $prefix
 461    *
 462    * @return array
 463    */
 464   public static function &export($prefix = FALSE) {
 465     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'membership_status', $prefix, []);
 466     return $r;
 467   }
 468
 469   /**
 470    * Returns the list of indices
 471    *
 472    * @param bool $localize
 473    *
 474    * @return array
 475    */
 476   public static function indices($localize = TRUE) {
 477     $indices = [];
 478     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 479   }
 480
 481 }