CRM/Contact/DAO/GroupOrganization.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Contact/GroupOrganization.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:18934ada33c41380e719798d5f8550e8)
  10  */
  11
  12 /**
  13  * Database access object for the GroupOrganization entity.
  14  */
  15 class CRM_Contact_DAO_GroupOrganization 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_group_organization';
  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 = TRUE;
  32
  33   /**
  34    * Relationship ID
  35    *
  36    * @var int
  37    */
  38   public $id;
  39
  40   /**
  41    * ID of the group
  42    *
  43    * @var int
  44    */
  45   public $group_id;
  46
  47   /**
  48    * ID of the Organization Contact
  49    *
  50    * @var int
  51    */
  52   public $organization_id;
  53
  54   /**
  55    * Class constructor.
  56    */
  57   public function __construct() {
  58     $this->__table = 'civicrm_group_organization';
  59     parent::__construct();
  60   }
  61
  62   /**
  63    * Returns localized title of this entity.
  64    *
  65    * @param bool $plural
  66    *   Whether to return the plural version of the title.
  67    */
  68   public static function getEntityTitle($plural = FALSE) {
  69     return $plural ? ts('Group Organizations') : ts('Group Organization');
  70   }
  71
  72   /**
  73    * Returns foreign keys and entity references.
  74    *
  75    * @return array
  76    *   [CRM_Core_Reference_Interface]
  77    */
  78   public static function getReferenceColumns() {
  79     if (!isset(Civi::$statics[__CLASS__]['links'])) {
  80       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
  81       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'group_id', 'civicrm_group', 'id');
  82       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'organization_id', 'civicrm_contact', 'id');
  83       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
  84     }
  85     return Civi::$statics[__CLASS__]['links'];
  86   }
  87
  88   /**
  89    * Returns all the column names of this table
  90    *
  91    * @return array
  92    */
  93   public static function &fields() {
  94     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
  95       Civi::$statics[__CLASS__]['fields'] = [
  96         'id' => [
  97           'name' => 'id',
  98           'type' => CRM_Utils_Type::T_INT,
  99           'title' => ts('Group Organization ID'),
 100           'description' => ts('Relationship ID'),
 101           'required' => TRUE,
 102           'where' => 'civicrm_group_organization.id',
 103           'table_name' => 'civicrm_group_organization',
 104           'entity' => 'GroupOrganization',
 105           'bao' => 'CRM_Contact_BAO_GroupOrganization',
 106           'localizable' => 0,
 107           'html' => [
 108             'type' => 'Number',
 109           ],
 110           'readonly' => TRUE,
 111           'add' => '2.0',
 112         ],
 113         'group_id' => [
 114           'name' => 'group_id',
 115           'type' => CRM_Utils_Type::T_INT,
 116           'title' => ts('Group ID'),
 117           'description' => ts('ID of the group'),
 118           'required' => TRUE,
 119           'where' => 'civicrm_group_organization.group_id',
 120           'table_name' => 'civicrm_group_organization',
 121           'entity' => 'GroupOrganization',
 122           'bao' => 'CRM_Contact_BAO_GroupOrganization',
 123           'localizable' => 0,
 124           'FKClassName' => 'CRM_Contact_DAO_Group',
 125           'html' => [
 126             'type' => 'Select',
 127             'label' => ts("Group"),
 128           ],
 129           'pseudoconstant' => [
 130             'table' => 'civicrm_group',
 131             'keyColumn' => 'id',
 132             'labelColumn' => 'title',
 133           ],
 134           'add' => '2.0',
 135         ],
 136         'organization_id' => [
 137           'name' => 'organization_id',
 138           'type' => CRM_Utils_Type::T_INT,
 139           'title' => ts('Organization ID'),
 140           'description' => ts('ID of the Organization Contact'),
 141           'required' => TRUE,
 142           'where' => 'civicrm_group_organization.organization_id',
 143           'table_name' => 'civicrm_group_organization',
 144           'entity' => 'GroupOrganization',
 145           'bao' => 'CRM_Contact_BAO_GroupOrganization',
 146           'localizable' => 0,
 147           'FKClassName' => 'CRM_Contact_DAO_Contact',
 148           'html' => [
 149             'label' => ts("Organization"),
 150           ],
 151           'add' => '2.0',
 152         ],
 153       ];
 154       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 155     }
 156     return Civi::$statics[__CLASS__]['fields'];
 157   }
 158
 159   /**
 160    * Return a mapping from field-name to the corresponding key (as used in fields()).
 161    *
 162    * @return array
 163    *   Array(string $name => string $uniqueName).
 164    */
 165   public static function &fieldKeys() {
 166     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 167       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 168     }
 169     return Civi::$statics[__CLASS__]['fieldKeys'];
 170   }
 171
 172   /**
 173    * Returns the names of this table
 174    *
 175    * @return string
 176    */
 177   public static function getTableName() {
 178     return self::$_tableName;
 179   }
 180
 181   /**
 182    * Returns if this table needs to be logged
 183    *
 184    * @return bool
 185    */
 186   public function getLog() {
 187     return self::$_log;
 188   }
 189
 190   /**
 191    * Returns the list of fields that can be imported
 192    *
 193    * @param bool $prefix
 194    *
 195    * @return array
 196    */
 197   public static function &import($prefix = FALSE) {
 198     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'group_organization', $prefix, []);
 199     return $r;
 200   }
 201
 202   /**
 203    * Returns the list of fields that can be exported
 204    *
 205    * @param bool $prefix
 206    *
 207    * @return array
 208    */
 209   public static function &export($prefix = FALSE) {
 210     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'group_organization', $prefix, []);
 211     return $r;
 212   }
 213
 214   /**
 215    * Returns the list of indices
 216    *
 217    * @param bool $localize
 218    *
 219    * @return array
 220    */
 221   public static function indices($localize = TRUE) {
 222     $indices = [
 223       'UI_group_organization' => [
 224         'name' => 'UI_group_organization',
 225         'field' => [
 226           0 => 'group_id',
 227           1 => 'organization_id',
 228         ],
 229         'localizable' => FALSE,
 230         'unique' => TRUE,
 231         'sig' => 'civicrm_group_organization::1::group_id::organization_id',
 232       ],
 233     ];
 234     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 235   }
 236
 237 }