class SolrMultisiteDocument in Search API Solr 4.x

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

• class \Drupal\search_api_solr\Plugin\search_api\datasource\SolrDocument extends \Drupal\search_api\Datasource\DatasourcePluginBase implements PluginFormInterface uses \Drupal\search_api\Plugin\PluginFormTrait, \Drupal\search_api\LoggerTrait
  • class \Drupal\search_api_solr\Plugin\search_api\datasource\SolrMultisiteDocument

File

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

Namespace

Drupal\search_api_solr\Plugin\search_api\datasource

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

Name	Modifiers	Type	Description	Overrides
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
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
SolrDocument::getItemLabel	public	function
SolrDocument::getItemLanguage	public	function
SolrDocument::getItemUrl	public	function
SolrDocument::getPropertyDefinitions	public	function
SolrDocument::getSolrDocumentFactory	public	function	Returns the Solr document factory.
SolrDocument::getSolrFieldManager	public	function	Returns the Solr field manager.
SolrDocument::loadMultiple	public	function
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 PluginFormInterface::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	Overrides SolrDocument::defaultConfiguration