interface DefaultMatchingEngineFieldTypeInterface in CRM Core 7

Interface for defining the logical operators and query criteria used to identify duplicate contacts based on different field types in DefaultMatchingEngine.

Hierarchy

• interface \DefaultMatchingEngineFieldTypeInterface

File

modules/crm_core_default_matching_engine/includes/DefaultMatchingEngine.inc, line 16

interface DefaultMatchingEngineFieldTypeInterface {

  /**
   * Field Renderer.
   *
   * Used for complex field types such as name.
   * Renders them into component parts for use in applying logical operators and ordering functions.
   *
   * @param array $field
   *   The field being rendered
   * @param array $field_info
   *   Info of the field  being rendered
   * @param array $form
   *   Form to be modified.
   */
  public function fieldRender($field, $field_info, &$form);

  /**
   * Operators.
   *
   * Defines the logical operators that can be used by this field type.
   * Provides any additional fields needed to capture information used in logical evaluations.
   * For instance: if this was a text field, there might be 3 logical operators: EQUALS, STARTS WITH, and ENDS WITH.
   * This function should return a select list with the operator values, and a text field to be used to enter
   * something like 'first 3'.
   */
  public function operators();

  /**
   * Query.
   *
   * Used when generating queries to identify matches in the system
   */
  public function fieldQuery($contact, $rule);

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultMatchingEngineFieldTypeInterface::fieldQuery	public	function	Query.	1
DefaultMatchingEngineFieldTypeInterface::fieldRender	public	function	Field Renderer.	1
DefaultMatchingEngineFieldTypeInterface::operators	public	function	Operators.	1