FieldHandlerBase.php in CRM Core 8.3

Namespace

Drupal\crm_core_match\Plugin\crm_core_match\field

File

modules/crm_core_match/src/Plugin/crm_core_match/field/FieldHandlerBase.php

<?php

namespace Drupal\crm_core_match\Plugin\crm_core_match\field;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\crm_core_contact\ContactInterface;
use Drupal\field\FieldConfigInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class FieldHandlerBase.
 *
 * @package Drupal\crm_core_match\Plugin\crm_core_match\field
 */
abstract class FieldHandlerBase implements FieldHandlerInterface, ContainerFactoryPluginInterface {

  /**
   * The weight.
   *
   * @var integer
   */
  const WEIGHT_DELTA = 25;

  /**
   * The plugin id.
   *
   * @var string
   */
  protected $id;

  /**
   * The plugin definition.
   *
   * @var array
   */
  protected $definition;

  /**
   * The settings.
   *
   * @var array
   */
  protected $configuration;

  /**
   * The field.
   *
   * @var \Drupal\Core\Field\FieldDefinitionInterface
   */
  protected $field;

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * Constructs an plugin instance.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field
   *   Field definition.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity Type Manager.
   * @param array $configuration
   *   Configuration.
   * @param string $id
   *   ID.
   * @param mixed $definition
   *   Definition.
   */
  public function __construct(FieldDefinitionInterface $field, EntityTypeManagerInterface $entity_type_manager, array $configuration, $id, $definition) {
    $this->configuration = $configuration;
    $this->definition = $definition;
    $this->id = $id;
    $this->field = $field;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    $field = $configuration['field'];
    unset($configuration['field']);
    return new static($field, $container
      ->get('entity_type.manager'), $configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public function getPropertyNames() {
    return [
      'value',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getLabel($property = 'value') {
    return $this->field
      ->getLabel();
  }

  /**
   * {@inheritdoc}
   */
  public function getStatus($property = 'value') {
    return isset($this->configuration[$property]['status']) ? $this->configuration[$property]['status'] : FALSE;
  }

  /**
   * {@inheritdoc}
   */
  public function getType() {
    return $this->field
      ->getType();
  }

  /**
   * {@inheritdoc}
   */
  public function getOperator($property = 'value') {
    return isset($this->configuration[$property]['operator']) ? $this->configuration[$property]['operator'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function getOptions($property = 'value') {
    return isset($this->configuration[$property]['options']) ? $this->configuration[$property]['options'] : '';
  }

  /**
   * {@inheritdoc}
   */
  public function getScore($property = 'value') {
    return isset($this->configuration[$property]['score']) ? $this->configuration[$property]['score'] : 0;
  }

  /**
   * {@inheritdoc}
   */
  public function getWeight($property = 'value') {
    return isset($this->configuration[$property]['weight']) ? $this->configuration[$property]['weight'] : 0;
  }

  /**
   * {@inheritdoc}
   */
  public function match(ContactInterface $contact, $property = 'value') {
    $ids = [];
    $field = $this->field
      ->getName();
    $needle = $contact
      ->get($field)->{$property};
    $query = $this->entityTypeManager
      ->getStorage('crm_core_individual')
      ->getQuery();
    if (!empty($needle)) {
      $query
        ->condition('type', $contact
        ->bundle());
      if ($contact
        ->id()) {
        $query
          ->condition('individual_id', $contact
          ->id(), '<>');
      }
      if ($field instanceof FieldConfigInterface) {
        $field .= '.' . $property;
      }
      $query
        ->condition($field, $needle, $this
        ->getOperator($property));
      $ids = $query
        ->execute();
    }

    // Get the score for this field/propery.
    $score = [
      $this->field
        ->getName() . '.' . $property => $this
        ->getScore($property),
    ];

    // Returning an array holding the score as value and the contact id as key.
    return array_fill_keys($ids, $score);
  }

}

Classes

Name	Description
FieldHandlerBase	Class FieldHandlerBase.