class ExtendedFieldComparator in Changed Fields API 7.3

Class ExtendedFieldComparator.

Hierarchy

• class \CFDefaultFieldComparator
  • class \ExtendedFieldComparator

File

examples/changed_fields_extended_field_comparator/includes/changed_fields_extended_field_comparator.field_comparator.inc, line 11

Extended field comparator example.

class ExtendedFieldComparator extends CFDefaultFieldComparator {

  /**
   * {@inheritdoc}
   */
  public function getDefaultComparableProperties(array $fieldInfo) {
    $properties = [];

    // Return comparable field properties for extra or custom field type.
    if ($fieldInfo['field_base']['type'] == 'changed_fields_custom_field') {
      $properties = [
        'value_1',
      ];
    }
    return $properties;
  }

  /**
   * {@inheritdoc}
   */
  public function extendComparableProperties(array $fieldInfo, array $properties) {

    // Return extended field properties for a given field type based on
    // $fieldInfo['field_base'] or $fieldInfo['field_instance'] data.
    if ($fieldInfo['field_base']['type'] == 'changed_fields_custom_field') {
      $properties[] = 'value_2';
    }
    return $properties;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CFDefaultFieldComparator::compareFieldValues	private	function	Method that compares old and new field values.
CFDefaultFieldComparator::getComparableProperties	private	function	Method that returns comparable properties for existing field type.
CFDefaultFieldComparator::makeResultArray	private	function	Method that generates result array for CFDefaultFieldComparator::compareFieldValues().
CFDefaultFieldComparator::runFieldComparison	public	function	Method that runs comparison of field values.
ExtendedFieldComparator::extendComparableProperties	public	function	Method that returns extended comparable properties for field type. Overrides CFDefaultFieldComparator::extendComparableProperties
ExtendedFieldComparator::getDefaultComparableProperties	public	function	Method that returns comparable properties for extra or custom field type. Overrides CFDefaultFieldComparator::getDefaultComparableProperties