View source
<?php
namespace Drupal\search_api_solr\Plugin\search_api\datasource;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\PluginFormInterface;
use Drupal\Core\TypedData\ComplexDataInterface;
use Drupal\Core\Url;
use Drupal\search_api\Datasource\DatasourcePluginBase;
use Drupal\search_api\LoggerTrait;
use Drupal\search_api\Plugin\PluginFormTrait;
use Drupal\search_api\SearchApiException;
use Drupal\search_api_solr\SolrDocumentFactoryInterface;
use Drupal\search_api_solr\SolrFieldManagerInterface;
class SolrDocument extends DatasourcePluginBase implements PluginFormInterface {
protected $solr_field = 'solr_field';
protected $solr_document = 'solr_document';
use PluginFormTrait;
use LoggerTrait;
protected $solrDocumentFactory;
protected $solrFieldManager;
public function setSolrDocumentFactory(SolrDocumentFactoryInterface $factory) {
$this->solrDocumentFactory = $factory;
return $this;
}
public function getSolrDocumentFactory() {
return $this->solrDocumentFactory ?: \Drupal::getContainer()
->get($this->solr_document . '.factory');
}
public function setSolrFieldManager(SolrFieldManagerInterface $solr_field_manager) {
$this->solrFieldManager = $solr_field_manager;
return $this;
}
public function getSolrFieldManager() {
return $this->solrFieldManager ?: \Drupal::getContainer()
->get($this->solr_field . '.manager');
}
public function getItemId(ComplexDataInterface $item) {
return $this
->getFieldValue($item, 'id_field');
}
public function getItemLabel(ComplexDataInterface $item) {
return $this
->getFieldValue($item, 'label_field');
}
public function getItemLanguage(ComplexDataInterface $item) {
if ($this->configuration['language_field']) {
return $this
->getFieldValue($item, 'language_field');
}
return parent::getItemLanguage($item);
}
public function getItemUrl(ComplexDataInterface $item) {
try {
return Url::fromUri($this
->getFieldValue($item, 'url_field'));
} catch (\InvalidArgumentException $e) {
$this
->logException($e);
}
}
protected function getFieldValue(ComplexDataInterface $item, $config_key) {
if (empty($this->configuration[$config_key])) {
return NULL;
}
$values = $item
->get($this->configuration[$config_key])
->getValue();
if (is_array($values)) {
$values = $values ? reset($values) : NULL;
}
return $values ?: NULL;
}
public function getPropertyDefinitions() {
return $this
->getSolrFieldManager()
->getFieldDefinitions($this->index);
}
public function loadMultiple(array $ids) {
$documents = [];
try {
$results = $this->index
->query()
->addCondition('search_api_id', $ids, 'IN')
->execute()
->getResultItems();
foreach ($results as $id => $result) {
$documents[$id] = $this->solrDocumentFactory
->create($result);
}
} catch (SearchApiException $e) {
}
return $documents;
}
public function defaultConfiguration() {
$config = [];
$config['id_field'] = '';
$config['request_handler'] = '';
$config['label_field'] = '';
$config['language_field'] = '';
$config['url_field'] = '';
$config['default_query'] = '*:*';
return $config;
}
public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
$fields = $single_valued_fields = [];
foreach ($this
->getPropertyDefinitions() as $name => $property) {
$fields[$name] = $property
->getLabel();
if (!$property
->isList()) {
$single_valued_fields[$name] = $property
->getLabel();
}
}
$form['id_field'] = [
'#type' => 'textfield',
'#title' => $this
->t('ID field'),
'#required' => TRUE,
'#description' => $this
->t('Enter the name of the field from your Solr schema that contains unique ID values.'),
'#default_value' => $this->configuration['id_field'],
];
if ($single_valued_fields) {
$form['id_field']['#type'] = 'select';
$form['id_field']['#options'] = $single_valued_fields;
$form['id_field']['#description'] = $this
->t('Select the Solr index field that contains unique ID values.');
}
$form['advanced'] = [
'#type' => 'details',
'#title' => $this
->t('Advanced configuration'),
];
$form['advanced']['request_handler'] = [
'#type' => 'textfield',
'#title' => $this
->t('Request handler'),
'#description' => $this
->t("Enter the name of a requestHandler from the core's solrconfig.xml file. This should only be necessary if you need to specify a handler to use other than the default."),
'#default_value' => $this->configuration['request_handler'],
];
$form['advanced']['default_query'] = [
'#type' => 'textfield',
'#title' => $this
->t('Default query'),
'#description' => $this
->t("Enter a default query parameter. This is only necessary if a default query cannot be specified in the solrconfig.xml file."),
'#default_value' => $this->configuration['default_query'],
];
$form['advanced']['label_field'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label field'),
'#description' => $this
->t('Enter the name of the field from your Solr schema that should be considered the label (if any).'),
'#default_value' => $this->configuration['label_field'],
];
$form['advanced']['language_field'] = [
'#type' => 'textfield',
'#title' => $this
->t('Language field'),
'#description' => $this
->t('Enter the name of the field from your Solr schema that should be considered the language (if any).'),
'#default_value' => $this->configuration['language_field'],
];
$form['advanced']['url_field'] = [
'#type' => 'textfield',
'#title' => $this
->t('URL field'),
'#description' => $this
->t('Enter the name of the field from your Solr schema that should be considered the URL (if any).'),
'#default_value' => $this->configuration['url_field'],
];
if ($fields) {
$fields = [
'' => $this
->t('None'),
] + $fields;
$form['advanced']['label_field']['#type'] = 'select';
$form['advanced']['label_field']['#options'] = $fields;
$form['advanced']['label_field']['#description'] = $this
->t('Select the Solr index field that should be considered the label (if any).');
$form['advanced']['language_field']['#type'] = 'select';
$form['advanced']['language_field']['#options'] = $fields;
$form['advanced']['language_field']['#description'] = $this
->t("Select the Solr index field that contains the document's language code (if any).");
$form['advanced']['url_field']['#type'] = 'select';
$form['advanced']['url_field']['#options'] = $fields;
$form['advanced']['url_field']['#description'] = $this
->t("Select the Solr index field that contains the document's URL (if any).");
}
return $form;
}
public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
$values =& $form_state
->getValues();
$values += $values['advanced'];
unset($values['advanced']);
}
}