class AddressFieldHandler in CRM Core 8.2

Class for evaluating address field fields.

Implementation of FieldHandlerInterface for address field.

Hierarchy

• class \Drupal\crm_core_match\Plugin\crm_core_match\field\FieldHandlerBase implements ContainerFactoryPluginInterface, FieldHandlerInterface
  • class \Drupal\crm_core_match\Plugin\crm_core_match\field\AddressFieldHandler

File

modules/crm_core_match/src/Plugin/crm_core_match/field/AddressFieldHandler.php, line 10

Namespace

Drupal\crm_core_match\Plugin\crm_core_match\field

class AddressFieldHandler extends FieldHandlerBase {

  /**
   * This function is going to add all addressfield components..
   *
   * @see DefaultMatchingEngineFieldType::fieldRender()
   */
  public function fieldRender($field, $field_info, &$form) {
    foreach ($field_info['columns'] as $item => $info) {

      // This separation is rather logical than formal  at the moment.
      $text_items = array(
        'name_line',
        'first_name',
        'last_name',
        'organisation_name',
        'administrative_area',
        'sub_administrative_area',
        'locality',
        'dependent_locality',
        'thoroughfare',
        'premise',
        'sub_premise',
      );
      $select_items = array(
        'country',
        'postal_code',
      );
      $field_item['field_name'] = $field['field_name'];
      $field_item['label'] = $field['label'] . ': ' . $info['description'];
      $field_item['bundle'] = $field['bundle'];
      $field_item['field_item'] = $item;
      if (in_array($item, $select_items)) {
        $item = new SelectFieldHandler();
        $item
          ->fieldRender($field_item, $field_info, $form);
      }
      if (in_array($item, $text_items)) {
        $item = new textMatchField();
        $item
          ->fieldRender($field_item, $field_info, $form);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getOperators($property = 'value') {
    return array(
      'equals' => t('Equals'),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AddressFieldHandler::fieldRender	public	function	This function is going to add all addressfield components..
AddressFieldHandler::getOperators	public	function	Gets the operators. Overrides FieldHandlerInterface::getOperators
FieldHandlerBase::$configuration	protected	property	The settings.	1
FieldHandlerBase::$definition	protected	property	The plugin definition.
FieldHandlerBase::$field	protected	property	The field.
FieldHandlerBase::$id	protected	property	The plugin id.
FieldHandlerBase::$queryFactory	protected	property	A Contact query object.
FieldHandlerBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldHandlerBase::getLabel	public	function	Gets the property label. Overrides FieldHandlerInterface::getLabel
FieldHandlerBase::getOperator	public	function	Gets the current selected operator. Overrides FieldHandlerInterface::getOperator
FieldHandlerBase::getOptions	public	function	Gets the operator options. Overrides FieldHandlerInterface::getOptions
FieldHandlerBase::getPropertyNames	public	function	Returns the names of the field's subproperties. Overrides FieldHandlerInterface::getPropertyNames	1
FieldHandlerBase::getScore	public	function	Gets the score. Overrides FieldHandlerInterface::getScore
FieldHandlerBase::getStatus	public	function	Gets the property status. Overrides FieldHandlerInterface::getStatus
FieldHandlerBase::getType	public	function	Gets the field type. Overrides FieldHandlerInterface::getType
FieldHandlerBase::getWeight	public	function	Gets the weight. Overrides FieldHandlerInterface::getWeight
FieldHandlerBase::match	public	function	Executes the match query. Overrides FieldHandlerInterface::match	2
FieldHandlerBase::WEIGHT_DELTA		constant	The weight.
FieldHandlerBase::__construct	public	function	Constructs an plugin instance.