You are here

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

class BasicAuthTestSolrCloudConnector in Search API Solr 8.3

Same name and namespace in other branches
  1. 4.x tests/modules/search_api_solr_test/src/Plugin/SolrConnector/BasicAuthTestSolrCloudConnector.php \Drupal\search_api_solr_test\Plugin\SolrConnector\BasicAuthTestSolrCloudConnector

Basic auth Solr test connector.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of BasicAuthTestSolrCloudConnector

File

tests/modules/search_api_solr_test/src/Plugin/SolrConnector/BasicAuthTestSolrCloudConnector.php, line 22

Namespace

Drupal\search_api_solr_test\Plugin\SolrConnector
View source 
class BasicAuthTestSolrCloudConnector extends BasicAuthSolrCloudConnector {

  /**
   * The Solarium query.
   *
   * @var \Solarium\Core\Query\QueryInterface
   */
  protected static $query;

  /**
   * The Solarium request.
   *
   * @var \Solarium\Core\Client\Request
   */
  protected static $request;

  /**
   * Whether to intercept the query/request or not.
   *
   * @var bool
   */
  protected $intercept = FALSE;

  /**
   * {@inheritdoc}
   */
  public function execute(QueryInterface $query, Endpoint $endpoint = NULL) {
    self::$query = $query;
    if ($this->intercept) {

      /** @var \Solarium\Core\Query\AbstractQuery $query */
      return new Result($query, new Response(''));
    }
    return parent::execute($query, $endpoint);
  }

  /**
   * {@inheritdoc}
   */
  public function executeRequest(Request $request, Endpoint $endpoint = NULL) {
    self::$request = $request;
    if ($this->intercept) {
      return new Response('');
    }
    return parent::executeRequest($request, $endpoint);
  }

  /**
   * Gets the Solarium query.
   */
  public function getQuery() {
    return self::$query;
  }

  /**
   * Gets the Solarium request.
   */
  public function getRequest() {
    return self::$request;
  }

  /**
   * Gets the Solarium request parameters.
   */
  public function getRequestParams() {
    return Utility::parseRequestParams(self::$request);
  }

  /**
   * Sets the intercept property.
   */
  public function setIntercept(bool $intercept) {
    $this->intercept = $intercept;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BasicAuthTestSolrCloudConnector::$intercept protected property Whether to intercept the query/request or not.
BasicAuthTestSolrCloudConnector::$query protected static property The Solarium query.
BasicAuthTestSolrCloudConnector::$request protected static property The Solarium request.
BasicAuthTestSolrCloudConnector::execute public function Executes any query. Overrides SolrConnectorPluginBase::execute
BasicAuthTestSolrCloudConnector::executeRequest public function Executes a request and returns the response. Overrides SolrConnectorPluginBase::executeRequest
BasicAuthTestSolrCloudConnector::getQuery public function Gets the Solarium query.
BasicAuthTestSolrCloudConnector::getRequest public function Gets the Solarium request.
BasicAuthTestSolrCloudConnector::getRequestParams public function Gets the Solarium request parameters.
BasicAuthTestSolrCloudConnector::setIntercept public function Sets the intercept property.
BasicAuthTrait::buildConfigurationForm public function
BasicAuthTrait::defaultConfiguration public function
BasicAuthTrait::search public function
BasicAuthTrait::submitConfigurationForm public function
BasicAuthTrait::viewSettings public function
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::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
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. Aliased as: traitSubmitConfigurationForm 7
SolrConnectorInterface::FINALIZE_TIMEOUT constant
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::adjustTimeout public function Sets a new timeout for queries, but not for indexing or optimization. Overrides SolrConnectorInterface::adjustTimeout
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::createEndpoint public function Creates an endpoint. Overrides SolrConnectorInterface::createEndpoint
SolrConnectorPluginBase::createSearchResult public function Creates a result from a response. Overrides SolrConnectorInterface::createSearchResult
SolrConnectorPluginBase::customizeRequest protected function Creates a CustomizeRequest object.
SolrConnectorPluginBase::extract public function Executes an extract query. Overrides SolrConnectorInterface::extract
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::getFinalizeTimeout public function Get the finalize timeout. Overrides SolrConnectorInterface::getFinalizeTimeout
SolrConnectorPluginBase::getIndexTimeout public function Get the index timeout. Overrides SolrConnectorInterface::getIndexTimeout
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::getOptimizeTimeout public function Get the optimize timeout. Overrides SolrConnectorInterface::getOptimizeTimeout
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::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::getTimeout public function Get the query timeout. Overrides SolrConnectorInterface::getTimeout
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::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::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurablePluginBase::setConfiguration
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
StandardSolrCloudConnector::alterConfigFiles public function Alter the newly assembled Solr configuration files. Overrides SolrConnectorPluginBase::alterConfigFiles
StandardSolrCloudConnector::deleteCheckpoints public function Deletes all checkpoints for given index/site. Overrides SolrCloudConnectorInterface::deleteCheckpoints
StandardSolrCloudConnector::getAutocompleteQuery public function Creates a new Solarium autocomplete query. Overrides SolrConnectorPluginBase::getAutocompleteQuery
StandardSolrCloudConnector::getCheckpointsCollectionEndpoint public function Returns the Solr collection endpoint used to store topic checkpoints. Overrides SolrCloudConnectorInterface::getCheckpointsCollectionEndpoint
StandardSolrCloudConnector::getCheckpointsCollectionName public function Returns the Solr collection name used to store topic checkpoints. Overrides SolrCloudConnectorInterface::getCheckpointsCollectionName
StandardSolrCloudConnector::getCollectionInfo public function Gets information about the Solr Collection. Overrides SolrCloudConnectorInterface::getCollectionInfo
StandardSolrCloudConnector::getCollectionLink public function Returns a link to the Solr collection, if the necessary options are set. Overrides SolrCloudConnectorInterface::getCollectionLink
StandardSolrCloudConnector::getCollectionName public function Returns the Solr collection name. Overrides SolrCloudConnectorInterface::getCollectionName
StandardSolrCloudConnector::getGraphQuery public function Creates a new Solarium graph query. Overrides SolrCloudConnectorInterface::getGraphQuery
StandardSolrCloudConnector::getMoreLikeThisQuery public function Creates a new Solarium more like this query. Overrides SolrConnectorPluginBase::getMoreLikeThisQuery
StandardSolrCloudConnector::getSelectQuery public function Creates a new Solarium update query. Overrides SolrConnectorPluginBase::getSelectQuery
StandardSolrCloudConnector::getSpellcheckQuery public function Creates a new Solarium suggester query. Overrides SolrConnectorPluginBase::getSpellcheckQuery
StandardSolrCloudConnector::getStatsSummary public function Gets summary information about the Solr Core. Overrides SolrConnectorPluginBase::getStatsSummary
StandardSolrCloudConnector::getStreamQuery public function Creates a new Solarium stream query. Overrides SolrCloudConnectorInterface::getStreamQuery
StandardSolrCloudConnector::getSuggesterQuery public function Creates a new Solarium suggester query. Overrides SolrConnectorPluginBase::getSuggesterQuery
StandardSolrCloudConnector::getTermsQuery public function Creates a new Solarium terms query. Overrides SolrConnectorPluginBase::getTermsQuery
StandardSolrCloudConnector::graph public function Executes a graph query. Overrides SolrCloudConnectorInterface::graph
StandardSolrCloudConnector::isCloud public function Returns TRUE for Cloud. Overrides SolrConnectorPluginBase::isCloud
StandardSolrCloudConnector::pingCollection public function Pings the Solr collection to tell whether it can be accessed. Overrides SolrCloudConnectorInterface::pingCollection
StandardSolrCloudConnector::pingCore public function Pings the Solr core to tell whether it can be accessed. Overrides SolrConnectorPluginBase::pingCore
StandardSolrCloudConnector::reloadCollection public function Reloads collection.
StandardSolrCloudConnector::reloadCore public function Reloads the Solr core. Overrides StandardSolrConnector::reloadCore
StandardSolrCloudConnector::setCollectionNameFromEndpoint public function Temporarily set a different collection name for the connection. Overrides SolrCloudConnectorInterface::setCollectionNameFromEndpoint
StandardSolrCloudConnector::stream public function Executes a stream query. Overrides SolrCloudConnectorInterface::stream
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.