You are here

Home » API reference » Search API Solr 4.x » BasicAuthTestSolrConnector.php

class BasicAuthTestSolrConnector in Search API Solr 4.x

Same name and namespace in other branches
  1. 8.3 tests/modules/search_api_solr_test/src/Plugin/SolrConnector/BasicAuthTestSolrConnector.php \Drupal\search_api_solr_test\Plugin\SolrConnector\BasicAuthTestSolrConnector

Basic auth Solr test connector.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of BasicAuthTestSolrConnector

File

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

Namespace

Drupal\search_api_solr_test\Plugin\SolrConnector
View source 
class BasicAuthTestSolrConnector extends BasicAuthSolrConnector {

  /**
   * 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
BasicAuthTestSolrConnector::$intercept protected property Whether to intercept the query/request or not.
BasicAuthTestSolrConnector::$query protected static property The Solarium query.
BasicAuthTestSolrConnector::$request protected static property The Solarium request.
BasicAuthTestSolrConnector::execute public function Executes any query. Overrides SolrConnectorPluginBase::execute
BasicAuthTestSolrConnector::executeRequest public function Executes a request and returns the response. Overrides SolrConnectorPluginBase::executeRequest
BasicAuthTestSolrConnector::getQuery public function Gets the Solarium query.
BasicAuthTestSolrConnector::getRequest public function Gets the Solarium request.
BasicAuthTestSolrConnector::getRequestParams public function Gets the Solarium request parameters.
BasicAuthTestSolrConnector::setIntercept public function Sets the intercept property.
BasicAuthTrait::buildConfigurationForm public function
BasicAuthTrait::defaultConfiguration public function
BasicAuthTrait::submitConfigurationForm public function
BasicAuthTrait::viewSettings public function
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 15
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::alterConfigZip public function Alter the zip archive of newly assembled Solr configuration files. Overrides SolrConnectorInterface::alterConfigZip
SolrConnectorPluginBase::autocomplete public function Executes a search query and returns the raw response. Overrides SolrConnectorInterface::autocomplete
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 1
SolrConnectorPluginBase::coreRestPost public function Sends a REST POST request to the Solr core and returns the result. Overrides SolrConnectorInterface::coreRestPost 1
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::getAutocompleteQuery public function Creates a new Solarium autocomplete query. Overrides SolrConnectorInterface::getAutocompleteQuery 1
SolrConnectorPluginBase::getConfigSetName public function Gets the name of the used configset. Overrides SolrConnectorInterface::getConfigSetName 1
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::getEndpointUri protected function Gets a string representation of the endpoint URI.
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::getMoreLikeThisQuery public function Creates a new Solarium more like this query. Overrides SolrConnectorInterface::getMoreLikeThisQuery 1
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::getSchemaTargetedSolrBranch public function Gets the Solr branch targeted by the schema. Overrides SolrConnectorInterface::getSchemaTargetedSolrBranch
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 1
SolrConnectorPluginBase::getServerInfo public function Gets information about the Solr server. Overrides SolrConnectorInterface::getServerInfo 1
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::getSpellcheckQuery public function Creates a new Solarium suggester query. Overrides SolrConnectorInterface::getSpellcheckQuery 1
SolrConnectorPluginBase::getStatsSummary public function Gets summary information about the Solr Core. Overrides SolrConnectorInterface::getStatsSummary 1
SolrConnectorPluginBase::getSuggesterQuery public function Creates a new Solarium suggester query. Overrides SolrConnectorInterface::getSuggesterQuery 1
SolrConnectorPluginBase::getTermsQuery public function Creates a new Solarium terms query. Overrides SolrConnectorInterface::getTermsQuery 1
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 final protected function Converts a HttpException in an easier to read SearchApiSolrException.
SolrConnectorPluginBase::isCloud public function Returns TRUE for Cloud. Overrides SolrConnectorInterface::isCloud 1
SolrConnectorPluginBase::isJumpStartConfigSet public function Indicates if the Solr config-set is our jum-start config-set. Overrides SolrConnectorInterface::isJumpStartConfigSet
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 1
SolrConnectorPluginBase::pingEndpoint public function Pings the Solr endpoint to tell whether it can be accessed. Overrides SolrConnectorInterface::pingEndpoint
SolrConnectorPluginBase::pingServer public function Pings the Solr server to tell whether it can be accessed. Overrides SolrConnectorInterface::pingServer 1
SolrConnectorPluginBase::restRequest protected function Sends a REST request to the Solr server endpoint and returns the result.
SolrConnectorPluginBase::search public function Executes a search query and returns the raw response. Overrides SolrConnectorInterface::search 1
SolrConnectorPluginBase::serverRestGet public function Sends a REST GET request to the Solr server and returns the result. Overrides SolrConnectorInterface::serverRestGet 1
SolrConnectorPluginBase::serverRestPost public function Sends a REST POST request to the Solr server and returns the result. Overrides SolrConnectorInterface::serverRestPost 1
SolrConnectorPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration 1
SolrConnectorPluginBase::setEventDispatcher public function Sets the event dispatcher. Overrides SolrConnectorInterface::setEventDispatcher
SolrConnectorPluginBase::update public function Executes an update query and applies some tweaks. Overrides SolrConnectorInterface::update
SolrConnectorPluginBase::useTimeout protected function Set the timeout.
SolrConnectorPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
SolrConnectorPluginBase::__sleep public function
StandardSolrConnector::alterConfigFiles public function Alter the newly assembled Solr configuration files. Overrides SolrConnectorPluginBase::alterConfigFiles 1
StandardSolrConnector::reloadCore public function Reloads the Solr core. Overrides SolrConnectorInterface::reloadCore 1