ConfigurablePropertyBase.php in Search API 8

Namespace

Drupal\search_api\Processor

File

src/Processor/ConfigurablePropertyBase.php

<?php

namespace Drupal\search_api\Processor;

use Drupal\Core\Form\FormStateInterface;
use Drupal\search_api\Item\FieldInterface;

/**
 * Provides a base class for configurable processor-defined properties.
 */
abstract class ConfigurablePropertyBase extends ProcessorProperty implements ConfigurablePropertyInterface {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(FieldInterface $field, array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(FieldInterface $field, array &$form, FormStateInterface $form_state) {
    $values = array_intersect_key($form_state
      ->getValues(), $this
      ->defaultConfiguration());
    $field
      ->setConfiguration($values);
  }

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

}

Classes

Name	Description
ConfigurablePropertyBase	Provides a base class for configurable processor-defined properties.