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:3c7051137838e12caf53b96b8c369f2b)
  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    * Paths for accessing this entity in the UI.
  42    *
  43    * @var string[]
  44    */
  45   protected static $_paths = [
  46     'view' => 'civicrm/contact/view/rel?action=view&reset=1&cid=[contact_id_a]&id=[id]',
  47     'delete' => 'civicrm/contact/view/rel?action=delete&reset=1&cid=[contact_id_a]&id=[id]',
  48   ];
  49
  50   /**
  51    * Relationship ID
  52    *
  53    * @var int|string|null
  54    *   (SQL type: int unsigned)
  55    *   Note that values will be retrieved from the database as a string.
  56    */
  57   public $id;
  58
  59   /**
  60    * id of the first contact
  61    *
  62    * @var int|string
  63    *   (SQL type: int unsigned)
  64    *   Note that values will be retrieved from the database as a string.
  65    */
  66   public $contact_id_a;
  67
  68   /**
  69    * id of the second contact
  70    *
  71    * @var int|string
  72    *   (SQL type: int unsigned)
  73    *   Note that values will be retrieved from the database as a string.
  74    */
  75   public $contact_id_b;
  76
  77   /**
  78    * Type of relationship
  79    *
  80    * @var int|string
  81    *   (SQL type: int unsigned)
  82    *   Note that values will be retrieved from the database as a string.
  83    */
  84   public $relationship_type_id;
  85
  86   /**
  87    * date when the relationship started
  88    *
  89    * @var string|null
  90    *   (SQL type: date)
  91    *   Note that values will be retrieved from the database as a string.
  92    */
  93   public $start_date;
  94
  95   /**
  96    * date when the relationship ended
  97    *
  98    * @var string|null
  99    *   (SQL type: date)
 100    *   Note that values will be retrieved from the database as a string.
 101    */
 102   public $end_date;
 103
 104   /**
 105    * is the relationship active ?
 106    *
 107    * @var bool|string
 108    *   (SQL type: tinyint)
 109    *   Note that values will be retrieved from the database as a string.
 110    */
 111   public $is_active;
 112
 113   /**
 114    * Optional verbose description for the relationship.
 115    *
 116    * @var string|null
 117    *   (SQL type: varchar(255))
 118    *   Note that values will be retrieved from the database as a string.
 119    */
 120   public $description;
 121
 122   /**
 123    * Permission that Contact A has to view/update Contact B
 124    *
 125    * @var int|string
 126    *   (SQL type: int unsigned)
 127    *   Note that values will be retrieved from the database as a string.
 128    */
 129   public $is_permission_a_b;
 130
 131   /**
 132    * Permission that Contact B has to view/update Contact A
 133    *
 134    * @var int|string
 135    *   (SQL type: int unsigned)
 136    *   Note that values will be retrieved from the database as a string.
 137    */
 138   public $is_permission_b_a;
 139
 140   /**
 141    * FK to civicrm_case
 142    *
 143    * @var int|string|null
 144    *   (SQL type: int unsigned)
 145    *   Note that values will be retrieved from the database as a string.
 146    */
 147   public $case_id;
 148
 149   /**
 150    * Relationship created date.
 151    *
 152    * @var string
 153    *   (SQL type: timestamp)
 154    *   Note that values will be retrieved from the database as a string.
 155    */
 156   public $created_date;
 157
 158   /**
 159    * Relationship last modified.
 160    *
 161    * @var string
 162    *   (SQL type: timestamp)
 163    *   Note that values will be retrieved from the database as a string.
 164    */
 165   public $modified_date;
 166
 167   /**
 168    * Class constructor.
 169    */
 170   public function __construct() {
 171     $this->__table = 'civicrm_relationship';
 172     parent::__construct();
 173   }
 174
 175   /**
 176    * Returns localized title of this entity.
 177    *
 178    * @param bool $plural
 179    *   Whether to return the plural version of the title.
 180    */
 181   public static function getEntityTitle($plural = FALSE) {
 182     return $plural ? ts('Relationships') : ts('Relationship');
 183   }
 184
 185   /**
 186    * Returns foreign keys and entity references.
 187    *
 188    * @return array
 189    *   [CRM_Core_Reference_Interface]
 190    */
 191   public static function getReferenceColumns() {
 192     if (!isset(Civi::$statics[__CLASS__]['links'])) {
 193       Civi::$statics[__CLASS__]['links'] = static::createReferenceColumns(__CLASS__);
 194       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id_a', 'civicrm_contact', 'id');
 195       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'contact_id_b', 'civicrm_contact', 'id');
 196       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'relationship_type_id', 'civicrm_relationship_type', 'id');
 197       Civi::$statics[__CLASS__]['links'][] = new CRM_Core_Reference_Basic(self::getTableName(), 'case_id', 'civicrm_case', 'id');
 198       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'links_callback', Civi::$statics[__CLASS__]['links']);
 199     }
 200     return Civi::$statics[__CLASS__]['links'];
 201   }
 202
 203   /**
 204    * Returns all the column names of this table
 205    *
 206    * @return array
 207    */
 208   public static function &fields() {
 209     if (!isset(Civi::$statics[__CLASS__]['fields'])) {
 210       Civi::$statics[__CLASS__]['fields'] = [
 211         'id' => [
 212           'name' => 'id',
 213           'type' => CRM_Utils_Type::T_INT,
 214           'title' => ts('Relationship ID'),
 215           'description' => ts('Relationship ID'),
 216           'required' => TRUE,
 217           'where' => 'civicrm_relationship.id',
 218           'table_name' => 'civicrm_relationship',
 219           'entity' => 'Relationship',
 220           'bao' => 'CRM_Contact_BAO_Relationship',
 221           'localizable' => 0,
 222           'html' => [
 223             'type' => 'Number',
 224           ],
 225           'readonly' => TRUE,
 226           'add' => '1.1',
 227         ],
 228         'contact_id_a' => [
 229           'name' => 'contact_id_a',
 230           'type' => CRM_Utils_Type::T_INT,
 231           'title' => ts('Contact A ID'),
 232           'description' => ts('id of the first contact'),
 233           'required' => TRUE,
 234           'where' => 'civicrm_relationship.contact_id_a',
 235           'table_name' => 'civicrm_relationship',
 236           'entity' => 'Relationship',
 237           'bao' => 'CRM_Contact_BAO_Relationship',
 238           'localizable' => 0,
 239           'FKClassName' => 'CRM_Contact_DAO_Contact',
 240           'html' => [
 241             'type' => 'EntityRef',
 242             'label' => ts("Contact A"),
 243           ],
 244           'add' => '1.1',
 245         ],
 246         'contact_id_b' => [
 247           'name' => 'contact_id_b',
 248           'type' => CRM_Utils_Type::T_INT,
 249           'title' => ts('Contact B ID'),
 250           'description' => ts('id of the second contact'),
 251           'required' => TRUE,
 252           'where' => 'civicrm_relationship.contact_id_b',
 253           'table_name' => 'civicrm_relationship',
 254           'entity' => 'Relationship',
 255           'bao' => 'CRM_Contact_BAO_Relationship',
 256           'localizable' => 0,
 257           'FKClassName' => 'CRM_Contact_DAO_Contact',
 258           'html' => [
 259             'type' => 'EntityRef',
 260             'label' => ts("Contact B"),
 261           ],
 262           'add' => '1.1',
 263         ],
 264         'relationship_type_id' => [
 265           'name' => 'relationship_type_id',
 266           'type' => CRM_Utils_Type::T_INT,
 267           'title' => ts('Relationship Type ID'),
 268           'description' => ts('Type of relationship'),
 269           'required' => TRUE,
 270           'where' => 'civicrm_relationship.relationship_type_id',
 271           'table_name' => 'civicrm_relationship',
 272           'entity' => 'Relationship',
 273           'bao' => 'CRM_Contact_BAO_Relationship',
 274           'localizable' => 0,
 275           'FKClassName' => 'CRM_Contact_DAO_RelationshipType',
 276           'html' => [
 277             'type' => 'Select',
 278             'label' => ts("Relationship Type"),
 279           ],
 280           'pseudoconstant' => [
 281             'table' => 'civicrm_relationship_type',
 282             'keyColumn' => 'id',
 283             'labelColumn' => 'label_a_b',
 284             'nameColumn' => 'name_a_b',
 285           ],
 286           'add' => '1.1',
 287         ],
 288         'relationship_start_date' => [
 289           'name' => 'start_date',
 290           'type' => CRM_Utils_Type::T_DATE,
 291           'title' => ts('Relationship Start Date'),
 292           'description' => ts('date when the relationship started'),
 293           'where' => 'civicrm_relationship.start_date',
 294           'table_name' => 'civicrm_relationship',
 295           'entity' => 'Relationship',
 296           'bao' => 'CRM_Contact_BAO_Relationship',
 297           'localizable' => 0,
 298           'html' => [
 299             'type' => 'Select Date',
 300             'formatType' => 'activityDate',
 301           ],
 302           'add' => '1.1',
 303         ],
 304         'relationship_end_date' => [
 305           'name' => 'end_date',
 306           'type' => CRM_Utils_Type::T_DATE,
 307           'title' => ts('Relationship End Date'),
 308           'description' => ts('date when the relationship ended'),
 309           'where' => 'civicrm_relationship.end_date',
 310           'table_name' => 'civicrm_relationship',
 311           'entity' => 'Relationship',
 312           'bao' => 'CRM_Contact_BAO_Relationship',
 313           'localizable' => 0,
 314           'html' => [
 315             'type' => 'Select Date',
 316             'formatType' => 'activityDate',
 317           ],
 318           'add' => '1.1',
 319         ],
 320         'is_active' => [
 321           'name' => 'is_active',
 322           'type' => CRM_Utils_Type::T_BOOLEAN,
 323           'title' => ts('Relationship Is Active'),
 324           'description' => ts('is the relationship active ?'),
 325           'required' => TRUE,
 326           'where' => 'civicrm_relationship.is_active',
 327           'default' => '1',
 328           'table_name' => 'civicrm_relationship',
 329           'entity' => 'Relationship',
 330           'bao' => 'CRM_Contact_BAO_Relationship',
 331           'localizable' => 0,
 332           'html' => [
 333             'type' => 'CheckBox',
 334           ],
 335           'add' => '1.1',
 336         ],
 337         'description' => [
 338           'name' => 'description',
 339           'type' => CRM_Utils_Type::T_STRING,
 340           'title' => ts('Relationship Description'),
 341           'description' => ts('Optional verbose description for the relationship.'),
 342           'maxlength' => 255,
 343           'size' => CRM_Utils_Type::HUGE,
 344           'where' => 'civicrm_relationship.description',
 345           'table_name' => 'civicrm_relationship',
 346           'entity' => 'Relationship',
 347           'bao' => 'CRM_Contact_BAO_Relationship',
 348           'localizable' => 0,
 349           'html' => [
 350             'type' => 'Text',
 351           ],
 352           'add' => '1.5',
 353         ],
 354         'is_permission_a_b' => [
 355           'name' => 'is_permission_a_b',
 356           'type' => CRM_Utils_Type::T_INT,
 357           'title' => ts('Contact A has Permission Over Contact B'),
 358           'description' => ts('Permission that Contact A has to view/update Contact B'),
 359           'required' => TRUE,
 360           'where' => 'civicrm_relationship.is_permission_a_b',
 361           'default' => '0',
 362           'table_name' => 'civicrm_relationship',
 363           'entity' => 'Relationship',
 364           'bao' => 'CRM_Contact_BAO_Relationship',
 365           'localizable' => 0,
 366           'html' => [
 367             'type' => 'Radio',
 368           ],
 369           'pseudoconstant' => [
 370             'callback' => 'CRM_Core_SelectValues::getPermissionedRelationshipOptions',
 371           ],
 372           'add' => '2.1',
 373         ],
 374         'is_permission_b_a' => [
 375           'name' => 'is_permission_b_a',
 376           'type' => CRM_Utils_Type::T_INT,
 377           'title' => ts('Contact B has Permission Over Contact A'),
 378           'description' => ts('Permission that Contact B has to view/update Contact A'),
 379           'required' => TRUE,
 380           'where' => 'civicrm_relationship.is_permission_b_a',
 381           'default' => '0',
 382           'table_name' => 'civicrm_relationship',
 383           'entity' => 'Relationship',
 384           'bao' => 'CRM_Contact_BAO_Relationship',
 385           'localizable' => 0,
 386           'html' => [
 387             'type' => 'Radio',
 388           ],
 389           'pseudoconstant' => [
 390             'callback' => 'CRM_Core_SelectValues::getPermissionedRelationshipOptions',
 391           ],
 392           'add' => '2.1',
 393         ],
 394         'case_id' => [
 395           'name' => 'case_id',
 396           'type' => CRM_Utils_Type::T_INT,
 397           'title' => ts('Case ID'),
 398           'description' => ts('FK to civicrm_case'),
 399           'where' => 'civicrm_relationship.case_id',
 400           'default' => NULL,
 401           'table_name' => 'civicrm_relationship',
 402           'entity' => 'Relationship',
 403           'bao' => 'CRM_Contact_BAO_Relationship',
 404           'localizable' => 0,
 405           'FKClassName' => 'CRM_Case_DAO_Case',
 406           'component' => 'CiviCase',
 407           'html' => [
 408             'label' => ts("Case"),
 409           ],
 410           'add' => '2.2',
 411         ],
 412         'created_date' => [
 413           'name' => 'created_date',
 414           'type' => CRM_Utils_Type::T_TIMESTAMP,
 415           'title' => ts('Created Date'),
 416           'description' => ts('Relationship created date.'),
 417           'required' => TRUE,
 418           'where' => 'civicrm_relationship.created_date',
 419           'default' => 'CURRENT_TIMESTAMP',
 420           'table_name' => 'civicrm_relationship',
 421           'entity' => 'Relationship',
 422           'bao' => 'CRM_Contact_BAO_Relationship',
 423           'localizable' => 0,
 424           'add' => '5.47',
 425         ],
 426         'modified_date' => [
 427           'name' => 'modified_date',
 428           'type' => CRM_Utils_Type::T_TIMESTAMP,
 429           'title' => ts('Relationship Modified Date'),
 430           'description' => ts('Relationship last modified.'),
 431           'required' => TRUE,
 432           'where' => 'civicrm_relationship.modified_date',
 433           'default' => 'CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP',
 434           'table_name' => 'civicrm_relationship',
 435           'entity' => 'Relationship',
 436           'bao' => 'CRM_Contact_BAO_Relationship',
 437           'localizable' => 0,
 438           'readonly' => TRUE,
 439           'add' => '5.47',
 440         ],
 441       ];
 442       CRM_Core_DAO_AllCoreTables::invoke(__CLASS__, 'fields_callback', Civi::$statics[__CLASS__]['fields']);
 443     }
 444     return Civi::$statics[__CLASS__]['fields'];
 445   }
 446
 447   /**
 448    * Return a mapping from field-name to the corresponding key (as used in fields()).
 449    *
 450    * @return array
 451    *   Array(string $name => string $uniqueName).
 452    */
 453   public static function &fieldKeys() {
 454     if (!isset(Civi::$statics[__CLASS__]['fieldKeys'])) {
 455       Civi::$statics[__CLASS__]['fieldKeys'] = array_flip(CRM_Utils_Array::collect('name', self::fields()));
 456     }
 457     return Civi::$statics[__CLASS__]['fieldKeys'];
 458   }
 459
 460   /**
 461    * Returns the names of this table
 462    *
 463    * @return string
 464    */
 465   public static function getTableName() {
 466     return self::$_tableName;
 467   }
 468
 469   /**
 470    * Returns if this table needs to be logged
 471    *
 472    * @return bool
 473    */
 474   public function getLog() {
 475     return self::$_log;
 476   }
 477
 478   /**
 479    * Returns the list of fields that can be imported
 480    *
 481    * @param bool $prefix
 482    *
 483    * @return array
 484    */
 485   public static function &import($prefix = FALSE) {
 486     $r = CRM_Core_DAO_AllCoreTables::getImports(__CLASS__, 'relationship', $prefix, []);
 487     return $r;
 488   }
 489
 490   /**
 491    * Returns the list of fields that can be exported
 492    *
 493    * @param bool $prefix
 494    *
 495    * @return array
 496    */
 497   public static function &export($prefix = FALSE) {
 498     $r = CRM_Core_DAO_AllCoreTables::getExports(__CLASS__, 'relationship', $prefix, []);
 499     return $r;
 500   }
 501
 502   /**
 503    * Returns the list of indices
 504    *
 505    * @param bool $localize
 506    *
 507    * @return array
 508    */
 509   public static function indices($localize = TRUE) {
 510     $indices = [];
 511     return ($localize && !empty($indices)) ? CRM_Core_DAO_AllCoreTables::multilingualize(__CLASS__, $indices) : $indices;
 512   }
 513
 514 }