CRM/Contact/DAO/Relationship.php

   1 <?php
   2
   3 /**
   4  * @package CRM
   5  * @copyright CiviCRM LLC https://civicrm.org/licensing
   6  *
   7  * Generated from xml/schema/CRM/Contact/Relationship.xml
   8  * DO NOT EDIT.  Generated by CRM_Core_CodeGen
   9  * (GenCodeChecksum:2046fac3c61cd88a17bf21dfe3e6f970)
  10  */
  11
  12 /**
  13  * Database access object for the Relationship entity.
  14  */
  15 class CRM_Contact_DAO_Relationship extends CRM_Core_DAO {
  16   const EXT = 'civicrm';
  17   const TABLE_ADDED = '1.1';
  18
  19   /**
  20    * Static instance to hold the table name.
  21    *
  22    * @var string
  23    */
  24   public static $_tableName = 'civicrm_relationship';
  25
  26   /**
  27    * Icon associated with this entity.
  28    *
  29    * @var string
  30    */
  31   public static $_icon = 'fa-handshake-o';
  32
  33   /**
  34    * Should CiviCRM log any modifications to this table in the civicrm_log table.
  35    *
  36    * @var bool
  37    */
  38   public static $_log = TRUE;
  39
  40   /**
  41    * Relationship ID
  42    *
  43    * @var int
  44    */
  45   public $id;
  46
  47   /**
  48    * id of the first contact
  49    *
  50    * @var int
  51    */
  52   public $contact_id_a;
  53
  54   /**
  55    * id of the second contact
  56    *
  57    * @var int
  58    */
  59   public $contact_id_b;
  60
  61   /**
  62    * id of the relationship
  63    *
  64    * @var int
  65    */
  66   public $relationship_type_id;
  67
  68   /**
  69    * date when the relationship started
  70    *
  71    * @var date
  72    */
  73   public $start_date;
  74
  75   /**
  76    * date when the relationship ended
  77    *
  78    * @var date
  79    */
  80   public $end_date;
  81
  82   /**
  83    * is the relationship active ?
  84    *
  85    * @var bool
  86    */
  87   public $is_active;
  88
  89   /**
  90    * Optional verbose description for the relationship.
  91    *
  92    * @var string
  93    */
  94   public $description;
  95
  96   /**
  97    * Permission that Contact A has to view/update Contact B
  98    *
  99    * @var int
 100    */
 101   public $is_permission_a_b;
 102
 103   /**
 104    * Permission that Contact B has to view/update Contact A
 105    *
 106    * @var int
 107    */
 108   public $is_permission_b_a;
 109
 110   /**
 111    * FK to civicrm_case
 112    *
 113    * @var int
 114    */
 115   public $case_id;
 116
 117   /**
 118    * Class constructor.
 119    */
 120   public function __construct() {
 121     $this->__table = 'civicrm_relationship';
 122     parent::__construct();
 123   }
 124
 125   /**
 126    * Returns localized title of this entity.
 127    *
 128    * @param bool $plural
 129    *   Whether to return the plural version of the title.
 130    */
 131   public static function getEntityTitle($plural = FALSE) {
 132     return $plural ? ts('Relationships') : ts('Relationship');
 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(), 'contact_id_a', 'civicrm_contact', 'id');
 145       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id_b', 'civicrm_contact', 'id');
 146       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'relationship_type_id', 'civicrm_relationship_type', 'id');
 147       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'case_id', 'civicrm_case', '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('Relationship ID'),
 165           'description' => ts('Relationship ID'),
 166           'required' => TRUE,
 167           'where' => 'civicrm_relationship.id',
 168           'table_name' => 'civicrm_relationship',
 169           'entity' => 'Relationship',
 170           'bao' => 'CRM_Contact_BAO_Relationship',
 171           'localizable' => 0,
 172           'add' => '1.1',
 173         ],
 174         'contact_id_a' => [
 175           'name' => 'contact_id_a',
 176           'type' => CRM_Utils_Type::T_INT,
 177           'title' => ts('Contact A'),
 178           'description' => ts('id of the first contact'),
 179           'required' => TRUE,
 180           'where' => 'civicrm_relationship.contact_id_a',
 181           'table_name' => 'civicrm_relationship',
 182           'entity' => 'Relationship',
 183           'bao' => 'CRM_Contact_BAO_Relationship',
 184           'localizable' => 0,
 185           'FKClassName' => 'CRM_Contact_DAO_Contact',
 186           'add' => '1.1',
 187         ],
 188         'contact_id_b' => [
 189           'name' => 'contact_id_b',
 190           'type' => CRM_Utils_Type::T_INT,
 191           'title' => ts('Contact B'),
 192           'description' => ts('id of the second contact'),
 193           'required' => TRUE,
 194           'where' => 'civicrm_relationship.contact_id_b',
 195           'table_name' => 'civicrm_relationship',
 196           'entity' => 'Relationship',
 197           'bao' => 'CRM_Contact_BAO_Relationship',
 198           'localizable' => 0,
 199           'FKClassName' => 'CRM_Contact_DAO_Contact',
 200           'html' => [
 201             'type' => 'EntityRef',
 202           ],
 203           'add' => '1.1',
 204         ],
 205         'relationship_type_id' => [
 206           'name' => 'relationship_type_id',
 207           'type' => CRM_Utils_Type::T_INT,
 208           'title' => ts('Relationship Type'),
 209           'description' => ts('id of the relationship'),
 210           'required' => TRUE,
 211           'where' => 'civicrm_relationship.relationship_type_id',
 212           'table_name' => 'civicrm_relationship',
 213           'entity' => 'Relationship',
 214           'bao' => 'CRM_Contact_BAO_Relationship',
 215           'localizable' => 0,
 216           'FKClassName' => 'CRM_Contact_DAO_RelationshipType',
 217           'html' => [
 218             'type' => 'Select',
 219           ],
 220           'add' => '1.1',
 221         ],
 222         'relationship_start_date' => [
 223           'name' => 'start_date',
 224           'type' => CRM_Utils_Type::T_DATE,
 225           'title' => ts('Relationship Start Date'),
 226           'description' => ts('date when the relationship started'),
 227           'where' => 'civicrm_relationship.start_date',
 228           'table_name' => 'civicrm_relationship',
 229           'entity' => 'Relationship',
 230           'bao' => 'CRM_Contact_BAO_Relationship',
 231           'localizable' => 0,
 232           'html' => [
 233             'type' => 'Select Date',
 234             'formatType' => 'activityDate',
 235           ],
 236           'add' => '1.1',
 237         ],
 238         'relationship_end_date' => [
 239           'name' => 'end_date',
 240           'type' => CRM_Utils_Type::T_DATE,
 241           'title' => ts('Relationship End Date'),
 242           'description' => ts('date when the relationship ended'),
 243           'where' => 'civicrm_relationship.end_date',
 244           'table_name' => 'civicrm_relationship',
 245           'entity' => 'Relationship',
 246           'bao' => 'CRM_Contact_BAO_Relationship',
 247           'localizable' => 0,
 248           'html' => [
 249             'type' => 'Select Date',
 250             'formatType' => 'activityDate',
 251           ],
 252           'add' => '1.1',
 253         ],
 254         'is_active' => [
 255           'name' => 'is_active',
 256           'type' => CRM_Utils_Type::T_BOOLEAN,
 257           'title' => ts('Relationship Is Active'),
 258           'description' => ts('is the relationship active ?'),
 259           'where' => 'civicrm_relationship.is_active',
 260           'default' => '1',
 261           'table_name' => 'civicrm_relationship',
 262           'entity' => 'Relationship',
 263           'bao' => 'CRM_Contact_BAO_Relationship',
 264           'localizable' => 0,
 265           'html' => [
 266             'type' => 'CheckBox',
 267           ],
 268           'add' => '1.1',
 269         ],
 270         'description' => [
 271           'name' => 'description',
 272           'type' => CRM_Utils_Type::T_STRING,
 273           'title' => ts('Relationship Description'),
 274           'description' => ts('Optional verbose description for the relationship.'),
 275           'maxlength' => 255,
 276           'size' => CRM_Utils_Type::HUGE,
 277           'where' => 'civicrm_relationship.description',
 278           'table_name' => 'civicrm_relationship',
 279           'entity' => 'Relationship',
 280           'bao' => 'CRM_Contact_BAO_Relationship',
 281           'localizable' => 0,
 282           'html' => [
 283             'type' => 'Text',
 284           ],
 285           'add' => '1.5',
 286         ],
 287         'is_permission_a_b' => [
 288           'name' => 'is_permission_a_b',
 289           'type' => CRM_Utils_Type::T_INT,
 290           'title' => ts('Contact A has Permission Over Contact B'),
 291           'description' => ts('Permission that Contact A has to view/update Contact B'),
 292           'required' => TRUE,
 293           'where' => 'civicrm_relationship.is_permission_a_b',
 294           'default' => '0',
 295           'table_name' => 'civicrm_relationship',
 296           'entity' => 'Relationship',
 297           'bao' => 'CRM_Contact_BAO_Relationship',
 298           'localizable' => 0,
 299           'html' => [
 300             'type' => 'Radio',
 301           ],
 302           'pseudoconstant' => [
 303             'callback' => 'CRM_Core_SelectValues::getPermissionedRelationshipOptions',
 304           ],
 305           'add' => '2.1',
 306         ],
 307         'is_permission_b_a' => [
 308           'name' => 'is_permission_b_a',
 309           'type' => CRM_Utils_Type::T_INT,
 310           'title' => ts('Contact B has Permission Over Contact A'),
 311           'description' => ts('Permission that Contact B has to view/update Contact A'),
 312           'required' => TRUE,
 313           'where' => 'civicrm_relationship.is_permission_b_a',
 314           'default' => '0',
 315           'table_name' => 'civicrm_relationship',
 316           'entity' => 'Relationship',
 317           'bao' => 'CRM_Contact_BAO_Relationship',
 318           'localizable' => 0,
 319           'html' => [
 320             'type' => 'Radio',
 321           ],
 322           'pseudoconstant' => [
 323             'callback' => 'CRM_Core_SelectValues::getPermissionedRelationshipOptions',
 324           ],
 325           'add' => '2.1',
 326         ],
 327         'case_id' => [
 328           'name' => 'case_id',
 329           'type' => CRM_Utils_Type::T_INT,
 330           'title' => ts('Relationship Case'),
 331           'description' => ts('FK to civicrm_case'),
 332           'where' => 'civicrm_relationship.case_id',
 333           'default' => 'NULL',
 334           'table_name' => 'civicrm_relationship',
 335           'entity' => 'Relationship',
 336           'bao' => 'CRM_Contact_BAO_Relationship',
 337           'localizable' => 0,
 338           'FKClassName' => 'CRM_Case_DAO_Case',
 339           'add' => '2.2',
 340         ],
 341       ];
 342       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 343     }
 344     return Civi::$statics[__CLASS__]['fields'];
 345   }
 346
 347   /**
 348    * Return a mapping from field-name to the corresponding key (as used in fields()).
 349    *
 350    * @return array
 351    *   Array(string $name => string $uniqueName).
 352    */
 353   public static function &fieldKeys() {
 354     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 355       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 356     }
 357     return Civi::$statics[__CLASS__]['fieldKeys'];
 358   }
 359
 360   /**
 361    * Returns the names of this table
 362    *
 363    * @return string
 364    */
 365   public static function getTableName() {
 366     return self::$_tableName;
 367   }
 368
 369   /**
 370    * Returns if this table needs to be logged
 371    *
 372    * @return bool
 373    */
 374   public function getLog() {
 375     return self::$_log;
 376   }
 377
 378   /**
 379    * Returns the list of fields that can be imported
 380    *
 381    * @param bool $prefix
 382    *
 383    * @return array
 384    */
 385   public static function &import($prefix = FALSE) {
 386     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'relationship', $prefix, []);
 387     return $r;
 388   }
 389
 390   /**
 391    * Returns the list of fields that can be exported
 392    *
 393    * @param bool $prefix
 394    *
 395    * @return array
 396    */
 397   public static function &export($prefix = FALSE) {
 398     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'relationship', $prefix, []);
 399     return $r;
 400   }
 401
 402   /**
 403    * Returns the list of indices
 404    *
 405    * @param bool $localize
 406    *
 407    * @return array
 408    */
 409   public static function indices($localize = TRUE) {
 410     $indices = [];
 411     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 412   }
 413
 414 }