vertex_ai_search-1.0.0-beta4/src/Plugin/VertexConfigurableJavaScriptPluginBase.php

<?php

namespace Drupal\vertex_ai_search\Plugin;

use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Cache\RefinableCacheableDependencyTrait;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\PluginBase;

/**
 * Provides a base implementation for a Vertex Configurable JavaScript plugin.
 *
 * This class implements the VertexConfigurableJavaScriptPluginInterface and
 * provides default methods for configuration management, form building, and
 * JavaScript library handling.
 */
class VertexConfigurableJavaScriptPluginBase extends PluginBase implements VertexConfigurableJavaScriptPluginInterface {

  use RefinableCacheableDependencyTrait;

  /**
   * {@inheritdoc}
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);

    $this->setConfiguration($configuration);
  }

  /**
   * {@inheritdoc}
   */
  public static function create(array $configuration, $plugin_id, $plugin_definition) {
    return new static(
      $configuration,
      $plugin_id,
      $plugin_definition
    );
  }

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

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = NestedArray::mergeDeep($this->defaultConfiguration(), $configuration);
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    return $form;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getJavaScriptLibrary() {
    return '';
  }

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

  /**
   * {@inheritdoc}
   */
  public function alterSearchForm(array &$form, FormStateInterface $form_state) {
    // Allow plugins to attach their libraries.
  }

}