CRM/PCP/DAO/PCPBlock.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/PCP/PCPBlock.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:039e37edb86cfd25e6c882ce4950e3c9)
  10  */
  11
  12 /**
  13  * Database access object for the PCPBlock entity.
  14  */
  15 class CRM_PCP_DAO_PCPBlock extends CRM_Core_DAO {
  16
  17   /**
  18    * Static instance to hold the table name.
  19    *
  20    * @var string
  21    */
  22   public static $_tableName = 'civicrm_pcp_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    * PCP block Id
  33    *
  34    * @var int
  35    */
  36   public $id;
  37
  38   /**
  39    * @var string
  40    */
  41   public $entity_table;
  42
  43   /**
  44    * FK to civicrm_contribution_page.id OR civicrm_event.id
  45    *
  46    * @var int
  47    */
  48   public $entity_id;
  49
  50   /**
  51    * The type of entity that this pcp targets
  52    *
  53    * @var string
  54    */
  55   public $target_entity_type;
  56
  57   /**
  58    * The entity that this pcp targets
  59    *
  60    * @var int
  61    */
  62   public $target_entity_id;
  63
  64   /**
  65    * FK to civicrm_uf_group.id. Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?
  66    *
  67    * @var int
  68    */
  69   public $supporter_profile_id;
  70
  71   /**
  72    * FK to civicrm_option_group with name = PCP owner notifications
  73    *
  74    * @var int
  75    */
  76   public $owner_notify_id;
  77
  78   /**
  79    * Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?
  80    *
  81    * @var bool
  82    */
  83   public $is_approval_needed;
  84
  85   /**
  86    * Does Personal Campaign Page allow using tell a friend?
  87    *
  88    * @var bool
  89    */
  90   public $is_tellfriend_enabled;
  91
  92   /**
  93    * Maximum recipient fields allowed in tell a friend
  94    *
  95    * @var int
  96    */
  97   public $tellfriend_limit;
  98
  99   /**
 100    * Link text for PCP.
 101    *
 102    * @var string
 103    */
 104   public $link_text;
 105
 106   /**
 107    * Is Personal Campaign Page Block enabled/active?
 108    *
 109    * @var bool
 110    */
 111   public $is_active;
 112
 113   /**
 114    * If set, notification is automatically emailed to this email-address on create/update Personal Campaign Page
 115    *
 116    * @var string
 117    */
 118   public $notify_email;
 119
 120   /**
 121    * Class constructor.
 122    */
 123   public function __construct() {
 124     $this->__table = 'civicrm_pcp_block';
 125     parent::__construct();
 126   }
 127
 128   /**
 129    * Returns localized title of this entity.
 130    */
 131   public static function getEntityTitle() {
 132     return ts('PCPBlocks');
 133   }
 134
 135   /**
 136    * Returns foreign keys and entity references.
 137    *
 138    * @return array
 139    *   [CRM_Core_Reference_Interface]
 140    */
 141   public static function getReferenceColumns() {
 142     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 143       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 144       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'supporter_profile_id', 'civicrm_uf_group', 'id');
 145       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
 146       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'target_entity_id', NULL, 'id', 'target_entity_type');
 147       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 148     }
 149     return Civi::$statics[__CLASS__]['links'];
 150   }
 151
 152   /**
 153    * Returns all the column names of this table
 154    *
 155    * @return array
 156    */
 157   public static function &fields() {
 158     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 159       Civi::$statics[__CLASS__]['fields'] = [
 160         'id' => [
 161           'name' => 'id',
 162           'type' => CRM_Utils_Type::T_INT,
 163           'title' => ts('PCP Block ID'),
 164           'description' => ts('PCP block Id'),
 165           'required' => TRUE,
 166           'where' => 'civicrm_pcp_block.id',
 167           'table_name' => 'civicrm_pcp_block',
 168           'entity' => 'PCPBlock',
 169           'bao' => 'CRM_PCP_BAO_PCPBlock',
 170           'localizable' => 0,
 171           'add' => '2.2',
 172         ],
 173         'entity_table' => [
 174           'name' => 'entity_table',
 175           'type' => CRM_Utils_Type::T_STRING,
 176           'title' => ts('Entity Table'),
 177           'maxlength' => 64,
 178           'size' => CRM_Utils_Type::BIG,
 179           'where' => 'civicrm_pcp_block.entity_table',
 180           'table_name' => 'civicrm_pcp_block',
 181           'entity' => 'PCPBlock',
 182           'bao' => 'CRM_PCP_BAO_PCPBlock',
 183           'localizable' => 0,
 184           'add' => '2.2',
 185         ],
 186         'entity_id' => [
 187           'name' => 'entity_id',
 188           'type' => CRM_Utils_Type::T_INT,
 189           'title' => ts('Entity'),
 190           'description' => ts('FK to civicrm_contribution_page.id OR civicrm_event.id'),
 191           'required' => TRUE,
 192           'where' => 'civicrm_pcp_block.entity_id',
 193           'table_name' => 'civicrm_pcp_block',
 194           'entity' => 'PCPBlock',
 195           'bao' => 'CRM_PCP_BAO_PCPBlock',
 196           'localizable' => 0,
 197           'add' => '2.2',
 198         ],
 199         'target_entity_type' => [
 200           'name' => 'target_entity_type',
 201           'type' => CRM_Utils_Type::T_STRING,
 202           'title' => ts('Target Entity'),
 203           'description' => ts('The type of entity that this pcp targets'),
 204           'required' => TRUE,
 205           'maxlength' => 255,
 206           'size' => CRM_Utils_Type::HUGE,
 207           'where' => 'civicrm_pcp_block.target_entity_type',
 208           'default' => 'contribute',
 209           'table_name' => 'civicrm_pcp_block',
 210           'entity' => 'PCPBlock',
 211           'bao' => 'CRM_PCP_BAO_PCPBlock',
 212           'localizable' => 0,
 213           'add' => '4.1',
 214         ],
 215         'target_entity_id' => [
 216           'name' => 'target_entity_id',
 217           'type' => CRM_Utils_Type::T_INT,
 218           'title' => ts('Target Entity ID'),
 219           'description' => ts('The entity that this pcp targets'),
 220           'required' => TRUE,
 221           'where' => 'civicrm_pcp_block.target_entity_id',
 222           'table_name' => 'civicrm_pcp_block',
 223           'entity' => 'PCPBlock',
 224           'bao' => 'CRM_PCP_BAO_PCPBlock',
 225           'localizable' => 0,
 226           'add' => '4.1',
 227         ],
 228         'supporter_profile_id' => [
 229           'name' => 'supporter_profile_id',
 230           'type' => CRM_Utils_Type::T_INT,
 231           'title' => ts('Supporter Profile'),
 232           'description' => ts('FK to civicrm_uf_group.id. Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?'),
 233           'where' => 'civicrm_pcp_block.supporter_profile_id',
 234           'default' => 'NULL',
 235           'table_name' => 'civicrm_pcp_block',
 236           'entity' => 'PCPBlock',
 237           'bao' => 'CRM_PCP_BAO_PCPBlock',
 238           'localizable' => 0,
 239           'FKClassName' => 'CRM_Core_DAO_UFGroup',
 240           'add' => '2.2',
 241         ],
 242         'owner_notify_id' => [
 243           'name' => 'owner_notify_id',
 244           'type' => CRM_Utils_Type::T_INT,
 245           'title' => ts('Owner Notification'),
 246           'description' => ts('FK to civicrm_option_group with name = PCP owner notifications'),
 247           'where' => 'civicrm_pcp_block.owner_notify_id',
 248           'default' => '0',
 249           'table_name' => 'civicrm_pcp_block',
 250           'entity' => 'PCPBlock',
 251           'bao' => 'CRM_PCP_BAO_PCPBlock',
 252           'localizable' => 0,
 253           'html' => [
 254             'type' => 'Radio',
 255           ],
 256           'pseudoconstant' => [
 257             'optionGroupName' => 'pcp_owner_notify',
 258             'optionEditPath' => 'civicrm/admin/options/pcp_owner_notify',
 259           ],
 260           'add' => '4.6',
 261         ],
 262         'is_approval_needed' => [
 263           'name' => 'is_approval_needed',
 264           'type' => CRM_Utils_Type::T_BOOLEAN,
 265           'title' => ts('Approval Required?'),
 266           'description' => ts('Does Personal Campaign Page require manual activation by administrator? (is inactive by default after setup)?'),
 267           'where' => 'civicrm_pcp_block.is_approval_needed',
 268           'default' => 'NULL',
 269           'table_name' => 'civicrm_pcp_block',
 270           'entity' => 'PCPBlock',
 271           'bao' => 'CRM_PCP_BAO_PCPBlock',
 272           'localizable' => 0,
 273           'add' => '2.2',
 274         ],
 275         'is_tellfriend_enabled' => [
 276           'name' => 'is_tellfriend_enabled',
 277           'type' => CRM_Utils_Type::T_BOOLEAN,
 278           'title' => ts('Tell a Friend Enabled?'),
 279           'description' => ts('Does Personal Campaign Page allow using tell a friend?'),
 280           'where' => 'civicrm_pcp_block.is_tellfriend_enabled',
 281           'default' => 'NULL',
 282           'table_name' => 'civicrm_pcp_block',
 283           'entity' => 'PCPBlock',
 284           'bao' => 'CRM_PCP_BAO_PCPBlock',
 285           'localizable' => 0,
 286           'add' => '2.2',
 287         ],
 288         'tellfriend_limit' => [
 289           'name' => 'tellfriend_limit',
 290           'type' => CRM_Utils_Type::T_INT,
 291           'title' => ts('Tell A Friend Limit'),
 292           'description' => ts('Maximum recipient fields allowed in tell a friend'),
 293           'where' => 'civicrm_pcp_block.tellfriend_limit',
 294           'default' => 'NULL',
 295           'table_name' => 'civicrm_pcp_block',
 296           'entity' => 'PCPBlock',
 297           'bao' => 'CRM_PCP_BAO_PCPBlock',
 298           'localizable' => 0,
 299           'add' => '2.2',
 300         ],
 301         'link_text' => [
 302           'name' => 'link_text',
 303           'type' => CRM_Utils_Type::T_STRING,
 304           'title' => ts('Link Text'),
 305           'description' => ts('Link text for PCP.'),
 306           'maxlength' => 255,
 307           'size' => CRM_Utils_Type::HUGE,
 308           'where' => 'civicrm_pcp_block.link_text',
 309           'default' => 'NULL',
 310           'table_name' => 'civicrm_pcp_block',
 311           'entity' => 'PCPBlock',
 312           'bao' => 'CRM_PCP_BAO_PCPBlock',
 313           'localizable' => 1,
 314           'add' => '2.2',
 315         ],
 316         'is_active' => [
 317           'name' => 'is_active',
 318           'type' => CRM_Utils_Type::T_BOOLEAN,
 319           'title' => ts('Enabled?'),
 320           'description' => ts('Is Personal Campaign Page Block enabled/active?'),
 321           'where' => 'civicrm_pcp_block.is_active',
 322           'default' => '1',
 323           'table_name' => 'civicrm_pcp_block',
 324           'entity' => 'PCPBlock',
 325           'bao' => 'CRM_PCP_BAO_PCPBlock',
 326           'localizable' => 0,
 327           'add' => '2.2',
 328         ],
 329         'notify_email' => [
 330           'name' => 'notify_email',
 331           'type' => CRM_Utils_Type::T_STRING,
 332           'title' => ts('Notification Email'),
 333           'description' => ts('If set, notification is automatically emailed to this email-address on create/update Personal Campaign Page'),
 334           'maxlength' => 255,
 335           'size' => CRM_Utils_Type::HUGE,
 336           'where' => 'civicrm_pcp_block.notify_email',
 337           'default' => 'NULL',
 338           'table_name' => 'civicrm_pcp_block',
 339           'entity' => 'PCPBlock',
 340           'bao' => 'CRM_PCP_BAO_PCPBlock',
 341           'localizable' => 0,
 342           'add' => '2.2',
 343         ],
 344       ];
 345       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 346     }
 347     return Civi::$statics[__CLASS__]['fields'];
 348   }
 349
 350   /**
 351    * Return a mapping from field-name to the corresponding key (as used in fields()).
 352    *
 353    * @return array
 354    *   Array(string $name => string $uniqueName).
 355    */
 356   public static function &fieldKeys() {
 357     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 358       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 359     }
 360     return Civi::$statics[__CLASS__]['fieldKeys'];
 361   }
 362
 363   /**
 364    * Returns the names of this table
 365    *
 366    * @return string
 367    */
 368   public static function getTableName() {
 369     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 370   }
 371
 372   /**
 373    * Returns if this table needs to be logged
 374    *
 375    * @return bool
 376    */
 377   public function getLog() {
 378     return self::$_log;
 379   }
 380
 381   /**
 382    * Returns the list of fields that can be imported
 383    *
 384    * @param bool $prefix
 385    *
 386    * @return array
 387    */
 388   public static function &import($prefix = FALSE) {
 389     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'pcp_block', $prefix, []);
 390     return $r;
 391   }
 392
 393   /**
 394    * Returns the list of fields that can be exported
 395    *
 396    * @param bool $prefix
 397    *
 398    * @return array
 399    */
 400   public static function &export($prefix = FALSE) {
 401     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'pcp_block', $prefix, []);
 402     return $r;
 403   }
 404
 405   /**
 406    * Returns the list of indices
 407    *
 408    * @param bool $localize
 409    *
 410    * @return array
 411    */
 412   public static function indices($localize = TRUE) {
 413     $indices = [];
 414     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 415   }
 416
 417 }