CRM/Friend/DAO/Friend.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Friend/Friend.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:3d5fa2c27a1430537988ce50ac455566)
  10  */
  11
  12 /**
  13  * Database access object for the Friend entity.
  14  */
  15 class CRM_Friend_DAO_Friend extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '2.0';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_tell_friend';
  25
  26   /**
  27    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  28    *
  29    * @var bool
  30    */
  31   public static $_log = FALSE;
  32
  33   /**
  34    * Friend ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * Name of table where item being referenced is stored.
  42    *
  43    * @var string
  44    */
  45   public $entity_table;
  46
  47   /**
  48    * Foreign key to the referenced item.
  49    *
  50    * @var int
  51    */
  52   public $entity_id;
  53
  54   /**
  55    * @var string
  56    */
  57   public $title;
  58
  59   /**
  60    * Introductory message to contributor or participant displayed on the Tell a Friend form.
  61    *
  62    * @var text
  63    */
  64   public $intro;
  65
  66   /**
  67    * Suggested message to friends, provided as default on the Tell A Friend form.
  68    *
  69    * @var text
  70    */
  71   public $suggested_message;
  72
  73   /**
  74    * URL for general info about the organization - included in the email sent to friends.
  75    *
  76    * @var string
  77    */
  78   public $general_link;
  79
  80   /**
  81    * Text for Tell a Friend thank you page header and HTML title.
  82    *
  83    * @var string
  84    */
  85   public $thankyou_title;
  86
  87   /**
  88    * Thank you message displayed on success page.
  89    *
  90    * @var text
  91    */
  92   public $thankyou_text;
  93
  94   /**
  95    * @var bool
  96    */
  97   public $is_active;
  98
  99   /**
 100    * Class constructor.
 101    */
 102   public function __construct() {
 103     $this->__table = 'civicrm_tell_friend';
 104     parent::__construct();
 105   }
 106
 107   /**
 108    * Returns localized title of this entity.
 109    *
 110    * @param bool $plural
 111    *   Whether to return the plural version of the title.
 112    */
 113   public static function getEntityTitle($plural = FALSE) {
 114     return $plural ? ts('Friends') : ts('Friend');
 115   }
 116
 117   /**
 118    * Returns foreign keys and entity references.
 119    *
 120    * @return array
 121    *   [CRM_Core_Reference_Interface]
 122    */
 123   public static function getReferenceColumns() {
 124     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 125       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 126       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Dynamic(self::getTableName(), 'entity_id', NULL, 'id', 'entity_table');
 127       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 128     }
 129     return Civi::$statics[__CLASS__]['links'];
 130   }
 131
 132   /**
 133    * Returns all the column names of this table
 134    *
 135    * @return array
 136    */
 137   public static function &fields() {
 138     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 139       Civi::$statics[__CLASS__]['fields'] = [
 140         'id' => [
 141           'name' => 'id',
 142           'type' => CRM_Utils_Type::T_INT,
 143           'title' => ts('Friend ID'),
 144           'description' => ts('Friend ID'),
 145           'required' => TRUE,
 146           'where' => 'civicrm_tell_friend.id',
 147           'table_name' => 'civicrm_tell_friend',
 148           'entity' => 'Friend',
 149           'bao' => 'CRM_Friend_BAO_Friend',
 150           'localizable' => 0,
 151           'add' => '2.0',
 152         ],
 153         'entity_table' => [
 154           'name' => 'entity_table',
 155           'type' => CRM_Utils_Type::T_STRING,
 156           'title' => ts('Entity Table'),
 157           'description' => ts('Name of table where item being referenced is stored.'),
 158           'required' => TRUE,
 159           'maxlength' => 64,
 160           'size' => CRM_Utils_Type::BIG,
 161           'where' => 'civicrm_tell_friend.entity_table',
 162           'table_name' => 'civicrm_tell_friend',
 163           'entity' => 'Friend',
 164           'bao' => 'CRM_Friend_BAO_Friend',
 165           'localizable' => 0,
 166           'add' => '2.0',
 167         ],
 168         'entity_id' => [
 169           'name' => 'entity_id',
 170           'type' => CRM_Utils_Type::T_INT,
 171           'title' => ts('Entity ID'),
 172           'description' => ts('Foreign key to the referenced item.'),
 173           'required' => TRUE,
 174           'where' => 'civicrm_tell_friend.entity_id',
 175           'table_name' => 'civicrm_tell_friend',
 176           'entity' => 'Friend',
 177           'bao' => 'CRM_Friend_BAO_Friend',
 178           'localizable' => 0,
 179           'add' => '2.0',
 180         ],
 181         'title' => [
 182           'name' => 'title',
 183           'type' => CRM_Utils_Type::T_STRING,
 184           'title' => ts('Title'),
 185           'maxlength' => 255,
 186           'size' => CRM_Utils_Type::HUGE,
 187           'where' => 'civicrm_tell_friend.title',
 188           'table_name' => 'civicrm_tell_friend',
 189           'entity' => 'Friend',
 190           'bao' => 'CRM_Friend_BAO_Friend',
 191           'localizable' => 1,
 192           'html' => [
 193             'type' => 'Text',
 194           ],
 195           'add' => '2.0',
 196         ],
 197         'intro' => [
 198           'name' => 'intro',
 199           'type' => CRM_Utils_Type::T_TEXT,
 200           'title' => ts('Intro'),
 201           'description' => ts('Introductory message to contributor or participant displayed on the Tell a Friend form.'),
 202           'where' => 'civicrm_tell_friend.intro',
 203           'table_name' => 'civicrm_tell_friend',
 204           'entity' => 'Friend',
 205           'bao' => 'CRM_Friend_BAO_Friend',
 206           'localizable' => 1,
 207           'html' => [
 208             'type' => 'Text',
 209           ],
 210           'add' => '2.0',
 211         ],
 212         'suggested_message' => [
 213           'name' => 'suggested_message',
 214           'type' => CRM_Utils_Type::T_TEXT,
 215           'title' => ts('Suggested Message'),
 216           'description' => ts('Suggested message to friends, provided as default on the Tell A Friend form.'),
 217           'where' => 'civicrm_tell_friend.suggested_message',
 218           'table_name' => 'civicrm_tell_friend',
 219           'entity' => 'Friend',
 220           'bao' => 'CRM_Friend_BAO_Friend',
 221           'localizable' => 1,
 222           'html' => [
 223             'type' => 'Text',
 224           ],
 225           'add' => '2.0',
 226         ],
 227         'general_link' => [
 228           'name' => 'general_link',
 229           'type' => CRM_Utils_Type::T_STRING,
 230           'title' => ts('General Link'),
 231           'description' => ts('URL for general info about the organization - included in the email sent to friends.'),
 232           'maxlength' => 255,
 233           'size' => CRM_Utils_Type::HUGE,
 234           'import' => TRUE,
 235           'where' => 'civicrm_tell_friend.general_link',
 236           'export' => TRUE,
 237           'table_name' => 'civicrm_tell_friend',
 238           'entity' => 'Friend',
 239           'bao' => 'CRM_Friend_BAO_Friend',
 240           'localizable' => 0,
 241           'html' => [
 242             'type' => 'Text',
 243           ],
 244           'add' => '2.0',
 245         ],
 246         'thankyou_title' => [
 247           'name' => 'thankyou_title',
 248           'type' => CRM_Utils_Type::T_STRING,
 249           'title' => ts('Thank You Title'),
 250           'description' => ts('Text for Tell a Friend thank you page header and HTML title.'),
 251           'maxlength' => 255,
 252           'size' => CRM_Utils_Type::HUGE,
 253           'where' => 'civicrm_tell_friend.thankyou_title',
 254           'table_name' => 'civicrm_tell_friend',
 255           'entity' => 'Friend',
 256           'bao' => 'CRM_Friend_BAO_Friend',
 257           'localizable' => 1,
 258           'html' => [
 259             'type' => 'Text',
 260           ],
 261           'add' => '2.0',
 262         ],
 263         'thankyou_text' => [
 264           'name' => 'thankyou_text',
 265           'type' => CRM_Utils_Type::T_TEXT,
 266           'title' => ts('Thank You Text'),
 267           'description' => ts('Thank you message displayed on success page.'),
 268           'where' => 'civicrm_tell_friend.thankyou_text',
 269           'table_name' => 'civicrm_tell_friend',
 270           'entity' => 'Friend',
 271           'bao' => 'CRM_Friend_BAO_Friend',
 272           'localizable' => 1,
 273           'html' => [
 274             'type' => 'Text',
 275           ],
 276           'add' => '2.0',
 277         ],
 278         'is_active' => [
 279           'name' => 'is_active',
 280           'type' => CRM_Utils_Type::T_BOOLEAN,
 281           'title' => ts('Enabled?'),
 282           'where' => 'civicrm_tell_friend.is_active',
 283           'table_name' => 'civicrm_tell_friend',
 284           'entity' => 'Friend',
 285           'bao' => 'CRM_Friend_BAO_Friend',
 286           'localizable' => 0,
 287           'html' => [
 288             'type' => 'CheckBox',
 289           ],
 290           'add' => '2.0',
 291         ],
 292       ];
 293       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 294     }
 295     return Civi::$statics[__CLASS__]['fields'];
 296   }
 297
 298   /**
 299    * Return a mapping from field-name to the corresponding key (as used in fields()).
 300    *
 301    * @return array
 302    *   Array(string $name => string $uniqueName).
 303    */
 304   public static function &fieldKeys() {
 305     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 306       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 307     }
 308     return Civi::$statics[__CLASS__]['fieldKeys'];
 309   }
 310
 311   /**
 312    * Returns the names of this table
 313    *
 314    * @return string
 315    */
 316   public static function getTableName() {
 317     return CRM_Core_DAO::getLocaleTableName(self::$_tableName);
 318   }
 319
 320   /**
 321    * Returns if this table needs to be logged
 322    *
 323    * @return bool
 324    */
 325   public function getLog() {
 326     return self::$_log;
 327   }
 328
 329   /**
 330    * Returns the list of fields that can be imported
 331    *
 332    * @param bool $prefix
 333    *
 334    * @return array
 335    */
 336   public static function &import($prefix = FALSE) {
 337     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'tell_friend', $prefix, []);
 338     return $r;
 339   }
 340
 341   /**
 342    * Returns the list of fields that can be exported
 343    *
 344    * @param bool $prefix
 345    *
 346    * @return array
 347    */
 348   public static function &export($prefix = FALSE) {
 349     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'tell_friend', $prefix, []);
 350     return $r;
 351   }
 352
 353   /**
 354    * Returns the list of indices
 355    *
 356    * @param bool $localize
 357    *
 358    * @return array
 359    */
 360   public static function indices($localize = TRUE) {
 361     $indices = [];
 362     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 363   }
 364
 365 }