[civicrm-core.git] / CRM / Core / Reference / Interface.php

<?php
interface CRM_Core_Reference_Interface {
  public function getReferenceTable();

  public function getReferenceKey();

  /**
   * Determine if a given table is a target of this reference.
   *
   * @param string $tableName
   * @return bool
   */
  public function matchesTargetTable($tableName);

  /**
   * Create a query to find references to a particular record
   *
   * @param CRM_Core_DAO $targetDao the instance for which we want references
   * @return CRM_Core_DAO|NULL a query-handle (like the result of CRM_Core_DAO::executeQuery)
   */
  public function findReferences($targetDao);
}
Commit	Line	Data
11626cf1 TO	1	<?php
	2	interface CRM_Core_Reference_Interface {
	3	public function getReferenceTable();
	4
	5	public function getReferenceKey();
	6
	7	/**
	8	* Determine if a given table is a target of this reference.
	9	*
	10	* @param string $tableName
	11	* @return bool
	12	*/
	13	public function matchesTargetTable($tableName);
	14
	15	/**
	16	* Create a query to find references to a particular record
	17	*
	18	* @param CRM_Core_DAO $targetDao the instance for which we want references
ffcef054	19	* @return CRM_Core_DAO\|NULL a query-handle (like the result of CRM_Core_DAO::executeQuery)
11626cf1 TO	20	*/
	21	public function findReferences($targetDao);
	22	}