You are here

Home » API reference » Search API Solr 8.3 » SolrMultisiteDocument.php

class SolrMultisiteDocument in Search API Solr 8.3

Same name in this branch
  1. 8.3 src/Plugin/DataType/SolrMultisiteDocument.php \Drupal\search_api_solr\Plugin\DataType\SolrMultisiteDocument
  2. 8.3 src/Plugin/search_api/datasource/SolrMultisiteDocument.php \Drupal\search_api_solr\Plugin\search_api\datasource\SolrMultisiteDocument
Same name and namespace in other branches
  1. 4.x src/Plugin/search_api/datasource/SolrMultisiteDocument.php \Drupal\search_api_solr\Plugin\search_api\datasource\SolrMultisiteDocument

Represents a datasource which exposes external Solr Documents.

Plugin annotation


@SearchApiDatasource(
  id = "solr_multisite_document",
  label = @Translation("Solr Multisite Document"),
  description = @Translation("Search through a different site's content. (Only works if this index is attached to a Solr-based server.)"),
)

Hierarchy

Expanded class hierarchy of SolrMultisiteDocument

File

src/Plugin/search_api/datasource/SolrMultisiteDocument.php, line 16

Namespace

Drupal\search_api_solr\Plugin\search_api\datasource
View source 
class SolrMultisiteDocument extends SolrDocument {
  protected $solr_field = 'solr_multisite_field';
  protected $solr_document = 'solr_multisite_document';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config['id_field'] = 'id';
    $config['language_field'] = 'ss_search_api_language';
    $config['url_field'] = 'site';
    $config['target_index'] = '';
    $config['target_index_machine_name'] = '';
    $config['target_hash'] = '';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['target_index'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Targeted index'),
      '#required' => TRUE,
      '#description' => $this
        ->t('Enter the prefixed name of the targeted index.'),
      '#default_value' => $this->configuration['target_index'],
    ];
    $form['target_index_machine_name'] = [
      '#type' => 'machine_name',
      '#title' => $this
        ->t('Targeted index machine name'),
      '#required' => TRUE,
      '#description' => $this
        ->t('Enter the machine name of the targeted index.'),
      '#default_value' => $this->configuration['target_index_machine_name'],
    ];
    $form['target_hash'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Targeted site hash'),
      '#required' => TRUE,
      '#description' => $this
        ->t('Enter the hash of the targeted site.'),
      '#default_value' => $this->configuration['target_hash'],
    ];
    $form['id_field'] = [
      '#type' => 'value',
      '#value' => $this->configuration['id_field'],
    ];
    $form['advanced']['request_handler'] = [
      '#type' => 'value',
      '#value' => $this->configuration['request_handler'],
    ];
    $form['advanced']['default_query'] = [
      '#type' => 'value',
      '#value' => $this->configuration['default_query'],
    ];
    $form['advanced']['language_field'] = [
      '#type' => 'value',
      '#value' => $this->configuration['language_field'],
    ];
    $form['advanced']['url_field'] = [
      '#type' => 'value',
      '#value' => $this->configuration['url_field'],
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurablePluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
ConfigurablePluginBase::calculatePluginDependencies Deprecated protected function Calculates and adds dependencies of a specific plugin instance.
ConfigurablePluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 4
ConfigurablePluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurablePluginBase::getDescription public function Returns the plugin's description. Overrides ConfigurablePluginInterface::getDescription
ConfigurablePluginBase::getPluginDependencies Deprecated protected function Calculates and returns dependencies of a specific plugin instance.
ConfigurablePluginBase::label public function Returns the label for use on the administration pages. Overrides ConfigurablePluginInterface::label
ConfigurablePluginBase::moduleHandler Deprecated protected function Wraps the module handler.
ConfigurablePluginBase::onDependencyRemoval public function Informs the plugin that some of its dependencies are being removed. Overrides ConfigurablePluginInterface::onDependencyRemoval 5
ConfigurablePluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 3
ConfigurablePluginBase::themeHandler Deprecated protected function Wraps the theme handler.
DatasourcePluginBase::canContainEntityReferences public function Determines whether this datasource can contain entity references. Overrides DatasourceInterface::canContainEntityReferences 1
DatasourcePluginBase::checkItemAccess public function Checks whether a user has permission to view the given item. Overrides DatasourceInterface::checkItemAccess
DatasourcePluginBase::getAffectedItemsForEntityChange public function Identifies items affected by a change to a referenced entity. Overrides DatasourceInterface::getAffectedItemsForEntityChange 1
DatasourcePluginBase::getBundles public function Retrieves the bundles associated to this datasource. Overrides DatasourceInterface::getBundles 1
DatasourcePluginBase::getEntityTypeId public function Retrieves the entity type ID of items from this datasource, if any. Overrides DatasourceInterface::getEntityTypeId 1
DatasourcePluginBase::getFieldDependencies public function Retrieves any dependencies of the given fields. Overrides DatasourceInterface::getFieldDependencies 1
DatasourcePluginBase::getItemAccessResult public function Checks whether a user has permission to view the given item. Overrides DatasourceInterface::getItemAccessResult 1
DatasourcePluginBase::getItemBundle public function Retrieves the item's bundle. Overrides DatasourceInterface::getItemBundle 1
DatasourcePluginBase::getItemIds public function Returns a list of IDs of items from this datasource. Overrides DatasourceInterface::getItemIds 1
DatasourcePluginBase::getListCacheContexts public function Returns the list cache contexts associated with this datasource. Overrides DatasourceInterface::getListCacheContexts 1
DatasourcePluginBase::getViewModes public function Returns the available view modes for this datasource. Overrides DatasourceInterface::getViewModes 1
DatasourcePluginBase::load public function Loads an item. Overrides DatasourceInterface::load
DatasourcePluginBase::viewItem public function Returns the render array for the provided item and view mode. Overrides DatasourceInterface::viewItem 1
DatasourcePluginBase::viewMultipleItems public function Returns the render array for the provided items and view mode. Overrides DatasourceInterface::viewMultipleItems 1
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
HideablePluginBase::isHidden public function Determines whether this plugin should be hidden in the UI. Overrides HideablePluginInterface::isHidden 1
IndexPluginBase::$index protected property The index this processor is configured for.
IndexPluginBase::getIndex public function Retrieves the index this plugin is configured for. Overrides IndexPluginInterface::getIndex
IndexPluginBase::setIndex public function Sets the index this plugin is configured for. Overrides IndexPluginInterface::setIndex
IndexPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides ConfigurablePluginBase::__construct 2
LoggerTrait::$logger protected property The logging channel to use.
LoggerTrait::getLogger public function Retrieves the logger.
LoggerTrait::logException protected function Logs an exception.
LoggerTrait::setLogger public function Sets the logger.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. Aliased as: traitCalculatePluginDependencies 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance. Aliased as: traitGetPluginDependencies
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. Aliased as: traitModuleHandler 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. Aliased as: traitThemeHandler 1
PluginFormTrait::submitConfigurationForm public function Form submission handler. 7
SolrDocument::$solrDocumentFactory protected property The Solr document factory.
SolrDocument::$solrFieldManager protected property The Solr field manager.
SolrDocument::getFieldValue protected function Retrieves a scalar field value from a result item.
SolrDocument::getItemId public function Overrides DatasourceInterface::getItemId
SolrDocument::getItemLabel public function Overrides DatasourcePluginBase::getItemLabel
SolrDocument::getItemLanguage public function Overrides DatasourcePluginBase::getItemLanguage
SolrDocument::getItemUrl public function Overrides DatasourcePluginBase::getItemUrl
SolrDocument::getPropertyDefinitions public function Retrieves the properties exposed by the underlying complex data type. Overrides DatasourcePluginBase::getPropertyDefinitions
SolrDocument::getSolrDocumentFactory public function Returns the Solr document factory.
SolrDocument::getSolrFieldManager public function Returns the Solr field manager.
SolrDocument::loadMultiple public function Loads multiple items. Overrides DatasourcePluginBase::loadMultiple
SolrDocument::setSolrDocumentFactory public function Sets the Solr document factory.
SolrDocument::setSolrFieldManager public function Sets the Solr field manager.
SolrDocument::validateConfigurationForm public function Form validation handler. Overrides PluginFormTrait::validateConfigurationForm
SolrMultisiteDocument::$solr_document protected property Overrides SolrDocument::$solr_document
SolrMultisiteDocument::$solr_field protected property Overrides SolrDocument::$solr_field
SolrMultisiteDocument::buildConfigurationForm public function Form constructor. Overrides SolrDocument::buildConfigurationForm
SolrMultisiteDocument::defaultConfiguration public function Gets default configuration for this plugin. Overrides SolrDocument::defaultConfiguration
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.