CRM/Core/Reference/Dynamic.php

   1 <?php
   2
   3 /**
   4  * Description of a one-way link between two entities
   5  *
   6  * This is a generic, soft-foreign key based on a pair of columns (entity_id, entity_table).
   7  */
   8 class CRM_Core_Reference_Dynamic extends CRM_Core_Reference_Basic {
   9
  10   /**
  11    * @param string $tableName
  12    *
  13    * @return bool
  14    */
  15   public function matchesTargetTable($tableName) {
  16     return TRUE;
  17   }
  18
  19   /**
  20    * Create a query to find references to a particular record.
  21    *
  22    * @param CRM_Core_DAO $targetDao
  23    *   The instance for which we want references.
  24    * @return CRM_Core_DAO
  25    *   a query-handle (like the result of CRM_Core_DAO::executeQuery)
  26    */
  27   public function findReferences($targetDao) {
  28     $refColumn = $this->getReferenceKey();
  29     $targetColumn = $this->getTargetKey();
  30
  31     $params = [
  32       1 => [$targetDao->$targetColumn, 'String'],
  33       // If anyone complains about $targetDao::getTableName(), then could use
  34       // "{get_class($targetDao)}::getTableName();"
  35       2 => [$targetDao::getTableName(), 'String'],
  36     ];
  37
  38     $sql = <<<EOS
  39 SELECT id
  40 FROM {$this->getReferenceTable()}
  41 WHERE {$refColumn} = %1
  42 AND {$this->getTypeColumn()} = %2
  43 EOS;
  44
  45     $daoName = CRM_Core_DAO_AllCoreTables::getClassForTable($this->getReferenceTable());
  46     $result = CRM_Core_DAO::executeQuery($sql, $params, TRUE, $daoName);
  47     return $result;
  48   }
  49
  50   /**
  51    * @param CRM_Core_DAO $targetDao
  52    *
  53    * @return array
  54    */
  55   public function getReferenceCount($targetDao) {
  56     $targetColumn = $this->getTargetKey();
  57     $params = [
  58       1 => [$targetDao->$targetColumn, 'String'],
  59       // If anyone complains about $targetDao::getTableName(), then could use
  60       // "{get_class($targetDao)}::getTableName();"
  61       2 => [$targetDao::getTableName(), 'String'],
  62     ];
  63
  64     $sql = <<<EOS
  65 SELECT count(id)
  66 FROM {$this->getReferenceTable()}
  67 WHERE {$this->getReferenceKey()} = %1
  68 AND {$this->getTypeColumn()} = %2
  69 EOS;
  70
  71     return [
  72       'name' => implode(':', ['sql', $this->getReferenceTable(), $this->getReferenceKey()]),
  73       'type' => get_class($this),
  74       'table' => $this->getReferenceTable(),
  75       'key' => $this->getReferenceKey(),
  76       'count' => CRM_Core_DAO::singleValueQuery($sql, $params),
  77     ];
  78   }
  79
  80 }