class BasicAuthSolrConnector in Search API Solr 8

Same name and namespace in other branches

8.3 src/Plugin/SolrConnector/BasicAuthSolrConnector.php \Drupal\search_api_solr\Plugin\SolrConnector\BasicAuthSolrConnector
8.2 src/Plugin/SolrConnector/BasicAuthSolrConnector.php \Drupal\search_api_solr\Plugin\SolrConnector\BasicAuthSolrConnector
4.x src/Plugin/SolrConnector/BasicAuthSolrConnector.php \Drupal\search_api_solr\Plugin\SolrConnector\BasicAuthSolrConnector

Standard Solr connector.

Plugin annotation


@SolrConnector(
  id = "basic_auth",
  label = @Translation("Basic Auth"),
  description = @Translation("A connector usable for Solr installations protected by basic authentication.")
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\search_api\Plugin\HideablePluginBase implements HideablePluginInterface
    class \Drupal\search_api\Plugin\ConfigurablePluginBase implements ConfigurablePluginInterface uses PluginDependencyTrait
    class \Drupal\search_api_solr\SolrConnector\SolrConnectorPluginBase implements PluginFormInterface, SolrConnectorInterface uses PluginFormTrait
    class \Drupal\search_api_solr\Plugin\SolrConnector\StandardSolrConnector
    class \Drupal\search_api_solr\Plugin\SolrConnector\BasicAuthSolrConnector

Expanded class hierarchy of BasicAuthSolrConnector

File

src/Plugin/SolrConnector/BasicAuthSolrConnector.php, line 19

Namespace

Drupal\search_api_solr\Plugin\SolrConnector

View source

class BasicAuthSolrConnector extends StandardSolrConnector {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'username' => '',
      'password' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildConfigurationForm($form, $form_state);
    $form['auth'] = array(
      '#type' => 'fieldset',
      '#title' => $this
        ->t('HTTP Basic Authentication'),
      '#description' => $this
        ->t('If your Solr server is protected by basic HTTP authentication, enter the login data here.'),
      '#collapsible' => TRUE,
      '#collapsed' => empty($this->configuration['username']),
    );
    $form['auth']['username'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Username'),
      '#default_value' => $this->configuration['username'],
      '#required' => TRUE,
    );
    $form['auth']['password'] = array(
      '#type' => 'password',
      '#title' => $this
        ->t('Password'),
      '#description' => $this
        ->t('If this field is left blank and the HTTP username is filled out, the current password will not be changed.'),
    );
    return $form;
  }

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

    // Since the form is nested into another, we can't simply use #parents for
    // doing this array restructuring magic. (At least not without creating an
    // unnecessary dependency on internal implementation.)
    $values += $values['auth'];

    // For password fields, there is no default value, they're empty by default.
    // Therefore we ignore empty submissions if the user didn't change either.
    if ($values['password'] === '' && isset($this->configuration['username']) && $values['username'] === $this->configuration['username']) {
      $values['password'] = $this->configuration['password'];
    }
    foreach ($values['auth'] as $key => $value) {
      $form_state
        ->setValue($key, $value);
    }

    // Clean-up the form to avoid redundant entries in the stored configuration.
    $form_state
      ->unsetValue('auth');
    parent::submitConfigurationForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function search(Query $query, Endpoint $endpoint = NULL) {
    $this
      ->connect();
    if (!$endpoint) {
      $endpoint = $this->solr
        ->getEndpoint('core');
    }

    // Use the 'postbigrequest' plugin if no specific http method is
    // configured. The plugin needs to be loaded before the request is
    // created.
    if ($this->configuration['http_method'] == 'AUTO') {
      $this->solr
        ->getPlugin('postbigrequest');
    }

    // Use the manual method of creating a Solarium request so we can control
    // the HTTP method.
    $request = $this->solr
      ->createRequest($query);

    // Set the configured HTTP method.
    if ($this->configuration['http_method'] == 'POST') {
      $request
        ->setMethod(Request::METHOD_POST);
    }
    elseif ($this->configuration['http_method'] == 'GET') {
      $request
        ->setMethod(Request::METHOD_GET);
    }

    // Set HTTP Basic Authentication parameter, if login data was set.
    if (strlen($this->configuration['username']) && strlen($this->configuration['password'])) {
      $request
        ->setAuthentication($this->configuration['username'], $this->configuration['password']);
    }
    return $this->solr
      ->executeRequest($request, $endpoint);
  }

  /**
   * {@inheritdoc}
   */
  public function viewSettings() {
    $vars = array(
      '%user' => $this->configuration['username'],
      '%pass' => str_repeat('*', strlen($this->configuration['password'])),
    );
    $info[] = array(
      'label' => $this
        ->t('Basic HTTP authentication'),
      'info' => $this
        ->t('Username: %user | Password: %pass', $vars),
    );
    return $info;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BasicAuthSolrConnector::buildConfigurationForm	public	function	Form constructor. Overrides SolrConnectorPluginBase::buildConfigurationForm
BasicAuthSolrConnector::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides SolrConnectorPluginBase::defaultConfiguration
BasicAuthSolrConnector::search	public	function	Executes a search query and returns the raw response. Overrides SolrConnectorPluginBase::search
BasicAuthSolrConnector::submitConfigurationForm	public	function	Form submission handler. Overrides SolrConnectorPluginBase::submitConfigurationForm
BasicAuthSolrConnector::viewSettings	public	function	Returns additional, connector-specific information about this server. Overrides SolrConnectorPluginBase::viewSettings
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::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.
ConfigurablePluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct	2
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::__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
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. Aliased as: traitSubmitConfigurationForm	7
SolrConnectorInterface::INDEX_TIMEOUT		constant
SolrConnectorInterface::OPTIMIZE_TIMEOUT		constant
SolrConnectorInterface::QUERY_TIMEOUT		constant
SolrConnectorPluginBase::$eventDispatcher	protected	property	The event dispatcher.
SolrConnectorPluginBase::$solr	protected	property	A connection to the Solr server.
SolrConnectorPluginBase::attachServerEndpoint	protected	function	Attaches an endpoint to the Solr connection to communicate with the server.
SolrConnectorPluginBase::autocomplete	public	function
SolrConnectorPluginBase::connect	protected	function	Prepares the connection to the Solr server.
SolrConnectorPluginBase::coreRestGet	public	function	Sends a REST GET request to the Solr core and returns the result. Overrides SolrConnectorInterface::coreRestGet
SolrConnectorPluginBase::coreRestPost	public	function	Sends a REST POST request to the Solr core and returns the result. Overrides SolrConnectorInterface::coreRestPost
SolrConnectorPluginBase::create	public static	function	Creates an instance of the plugin. Overrides ConfigurablePluginBase::create
SolrConnectorPluginBase::createClient	protected	function	Create a Client.
SolrConnectorPluginBase::createSearchResult	public	function	Creates a result from a response. Overrides SolrConnectorInterface::createSearchResult
SolrConnectorPluginBase::customizeRequest	protected	function
SolrConnectorPluginBase::doPing	protected	function	Pings the Solr server to tell whether it can be accessed.
SolrConnectorPluginBase::execute	public	function	Executes any query. Overrides SolrConnectorInterface::execute
SolrConnectorPluginBase::executeRequest	public	function	Executes a request and returns the response. Overrides SolrConnectorInterface::executeRequest
SolrConnectorPluginBase::extract	public	function	Executes an extract query. Overrides SolrConnectorInterface::extract
SolrConnectorPluginBase::getAutocompleteQuery	public	function
SolrConnectorPluginBase::getContentFromExtractResult	public	function	Gets the content from an extract query result. Overrides SolrConnectorInterface::getContentFromExtractResult
SolrConnectorPluginBase::getCoreInfo	public	function	Gets information about the Solr Core. Overrides SolrConnectorInterface::getCoreInfo
SolrConnectorPluginBase::getCoreLink	public	function	Returns a link to the Solr core, if the necessary options are set. Overrides SolrConnectorInterface::getCoreLink
SolrConnectorPluginBase::getDataFromHandler	protected	function	Gets data from a Solr endpoint using a given handler.
SolrConnectorPluginBase::getEndpoint	public	function	Returns an endpoint. Overrides SolrConnectorInterface::getEndpoint
SolrConnectorPluginBase::getExtractQuery	public	function	Creates a new Solarium extract query. Overrides SolrConnectorInterface::getExtractQuery
SolrConnectorPluginBase::getFile	public	function	Retrieves a config file or file list from the Solr server. Overrides SolrConnectorInterface::getFile
SolrConnectorPluginBase::getLuceneMatchVersion	public	function	Gets the LuceneMatchVersion string. Overrides SolrConnectorInterface::getLuceneMatchVersion
SolrConnectorPluginBase::getLuke	public	function	Gets meta-data about the index. Overrides SolrConnectorInterface::getLuke
SolrConnectorPluginBase::getMoreLikeThisQuery	public	function	Creates a new Solarium more like this query. Overrides SolrConnectorInterface::getMoreLikeThisQuery
SolrConnectorPluginBase::getQueryHelper	public	function	Returns a Solarium query helper object. Overrides SolrConnectorInterface::getQueryHelper
SolrConnectorPluginBase::getSchemaVersion	public	function	Gets the schema version number. Overrides SolrConnectorInterface::getSchemaVersion
SolrConnectorPluginBase::getSchemaVersionString	public	function	Gets the full schema version string the core is using. Overrides SolrConnectorInterface::getSchemaVersionString
SolrConnectorPluginBase::getSelectQuery	public	function	Creates a new Solarium update query. Overrides SolrConnectorInterface::getSelectQuery
SolrConnectorPluginBase::getServerInfo	public	function	Gets information about the Solr server. Overrides SolrConnectorInterface::getServerInfo
SolrConnectorPluginBase::getServerLink	public	function	Returns a link to the Solr server. Overrides SolrConnectorInterface::getServerLink
SolrConnectorPluginBase::getServerUri	protected	function	Returns a the Solr server URI.
SolrConnectorPluginBase::getSolrBranch	public	function	Gets the current Solr branch name. Overrides SolrConnectorInterface::getSolrBranch
SolrConnectorPluginBase::getSolrMajorVersion	public	function	Gets the current Solr major version. Overrides SolrConnectorInterface::getSolrMajorVersion
SolrConnectorPluginBase::getSolrVersion	public	function	Gets the current Solr version. Overrides SolrConnectorInterface::getSolrVersion
SolrConnectorPluginBase::getStatsSummary	public	function	Gets summary information about the Solr Core. Overrides SolrConnectorInterface::getStatsSummary
SolrConnectorPluginBase::getTermsQuery	public	function	Creates a new Solarium terms query. Overrides SolrConnectorInterface::getTermsQuery
SolrConnectorPluginBase::getUpdateQuery	public	function	Creates a new Solarium update query. Overrides SolrConnectorInterface::getUpdateQuery
SolrConnectorPluginBase::handleHttpException	protected	function	Converts a HttpException in an easier to read SearchApiSolrException.
SolrConnectorPluginBase::optimize	public	function	Optimizes the Solr index. Overrides SolrConnectorInterface::optimize
SolrConnectorPluginBase::pingCore	public	function	Pings the Solr core to tell whether it can be accessed. Overrides SolrConnectorInterface::pingCore
SolrConnectorPluginBase::pingServer	public	function	Pings the Solr server to tell whether it can be accessed. Overrides SolrConnectorInterface::pingServer
SolrConnectorPluginBase::restRequest	protected	function	Sends a REST request to the Solr server endpoint and returns the result.
SolrConnectorPluginBase::serverRestGet	public	function	Sends a REST GET request to the Solr server and returns the result. Overrides SolrConnectorInterface::serverRestGet
SolrConnectorPluginBase::serverRestPost	public	function	Sends a REST POST request to the Solr server and returns the result. Overrides SolrConnectorInterface::serverRestPost
SolrConnectorPluginBase::update	public	function	Executes an update query and applies some tweaks. Overrides SolrConnectorInterface::update
SolrConnectorPluginBase::useTimeout	public	function
SolrConnectorPluginBase::validateConfigurationForm	public	function	Form validation handler. Overrides PluginFormTrait::validateConfigurationForm
SolrConnectorPluginBase::__sleep	public	function	Overrides DependencySerializationTrait::__sleep
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.

You are here

class BasicAuthSolrConnector in Search API Solr 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation