class SearchApiAcquiaSearchConnection in Acquia Search for Search API 7

Establishes a connection to the Acquia Search service.

Hierarchy

• class \SearchApiSolrConnection implements SearchApiSolrConnectionInterface
  • class \SearchApiAcquiaSearchConnection

File

includes/SearchApiAcquiaSearchConnection.php, line 11

Contains SearchApiAcquiaSearchConnection.

class SearchApiAcquiaSearchConnection extends SearchApiSolrConnection {

  /**
   * Overrides SearchApiSolrConnection::__construct().
   *
   * Uses the Acquia Search HTTP transport instead of the transport provided by
   * the Search API Solr module. This allows us to add the tokens and variables
   * required to authenticate against Acquia's HMAC authentication scheme.
   *
   * @see SearchApiAcquiaSearchHttpTransport
   */
  public function __construct(array $options) {
    parent::__construct($options);
    $this->newClient = trim(parent::SVN_REVISION, '$ :A..Za..z') > 40;
    if ($this->newClient) {
      $this->_httpTransport = new SearchApiAcquiaSearchHttpTransport($this->http_auth);
      if (isset($options['derived_key'])) {
        $this->_httpTransport
          ->setDerivedKey($options['derived_key']);
      }
    }
    else {
      throw new Exception(t('This module only works with the latest version of SolrPhpClient'));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SearchApiAcquiaSearchConnection::__construct	public	function	Overrides SearchApiSolrConnection::__construct(). Overrides SearchApiSolrConnection::__construct
SearchApiSolrConnection::$base_url	protected	property	The Solr server's URL.
SearchApiSolrConnection::$http_auth	protected	property	HTTP Basic Authentication header to set for requests to the Solr server.
SearchApiSolrConnection::$luke	protected	property	Cache for the metadata from admin/luke.
SearchApiSolrConnection::$options	protected	property	The options passed when creating this connection.
SearchApiSolrConnection::$soft_commit	protected	property	Flag that denotes whether to use soft commits for Solr 4.x.
SearchApiSolrConnection::$stats	protected	property	Cache for information about the Solr core.
SearchApiSolrConnection::$stream_context	protected	property	The stream context to use for requests to the Solr server.
SearchApiSolrConnection::$system_info	protected	property	Cache for system information.
SearchApiSolrConnection::$update_url	protected	property	Cached URL to the update servlet.
SearchApiSolrConnection::addDocuments	public	function	Adds an array of Solr Documents to the index all at once Overrides SearchApiSolrConnectionInterface::addDocuments
SearchApiSolrConnection::checkResponse	protected	function	Checks the reponse code and throws an exception if it's not 200.
SearchApiSolrConnection::clearCache	public	function	Clears the cached Solr data. Overrides SearchApiSolrConnectionInterface::clearCache
SearchApiSolrConnection::commit	public	function	Sends a commit command to the Solr server. Overrides SearchApiSolrConnectionInterface::commit
SearchApiSolrConnection::constructUrl	protected	function	Returns the HTTP URL for a certain servlet on the Solr server.
SearchApiSolrConnection::deleteById	public	function	Sends a delete request based on a document ID. Overrides SearchApiSolrConnectionInterface::deleteById
SearchApiSolrConnection::deleteByMultipleIds	public	function	Sends a delete request for several documents, based on the document IDs. Overrides SearchApiSolrConnectionInterface::deleteByMultipleIds
SearchApiSolrConnection::deleteByQuery	public	function	Sends a delete request for all documents that match the given Solr query. Overrides SearchApiSolrConnectionInterface::deleteByQuery
SearchApiSolrConnection::escape	public static	function	Escapes special characters from a Solr query. Overrides SearchApiSolrConnectionInterface::escape
SearchApiSolrConnection::escapeFieldName	public static	function	Escapes a Search API field name for passing to Solr. Overrides SearchApiSolrConnectionInterface::escapeFieldName
SearchApiSolrConnection::escapePhrase	public static	function	Escapes a string that should be included in a Solr phrase. Overrides SearchApiSolrConnectionInterface::escapePhrase
SearchApiSolrConnection::FILE_SERVLET		constant	Path to the file servlet.
SearchApiSolrConnection::getBaseUrl	public	function	Gets the base URL of the Solr server. Overrides SearchApiSolrConnectionInterface::getBaseUrl
SearchApiSolrConnection::getCacheId	protected	function	Computes the cache ID to use for this connection.
SearchApiSolrConnection::getFields	public	function	Get metadata about fields in the Solr/Lucene index. Overrides SearchApiSolrConnectionInterface::getFields
SearchApiSolrConnection::getLuke	public	function	Gets meta-data about the index. Overrides SearchApiSolrConnectionInterface::getLuke
SearchApiSolrConnection::getSoftCommit	public	function	Tells whether this connection will use soft commits when comitting. Overrides SearchApiSolrConnectionInterface::getSoftCommit
SearchApiSolrConnection::getSolrVersion	public	function	Gets the current solr version. Overrides SearchApiSolrConnectionInterface::getSolrVersion
SearchApiSolrConnection::getStats	public	function	Gets information about the Solr core. Overrides SearchApiSolrConnectionInterface::getStats
SearchApiSolrConnection::getStatsSummary	public	function	Gets summary information about the Solr Core. Overrides SearchApiSolrConnectionInterface::getStatsSummary
SearchApiSolrConnection::getStreamContext	public	function	Returns the stream context to use for requests to the Solr server. Overrides SearchApiSolrConnectionInterface::getStreamContext
SearchApiSolrConnection::getSystemInfo	public	function	Implements SearchApiSolrConnectionInterface::getSystemInfo(). Overrides SearchApiSolrConnectionInterface::getSystemInfo
SearchApiSolrConnection::httpBuildQuery	protected	function	Generates an URL-encoded query string.
SearchApiSolrConnection::logResponse	protected	function	Logs a Solr response object.
SearchApiSolrConnection::LUKE_SERVLET		constant	Path to the luke servlet.
SearchApiSolrConnection::makeHttpRequest	protected	function	Sends an HTTP request to Solr.
SearchApiSolrConnection::makeServletRequest	public	function	Makes a request to a servlet (a path) that's not a standard path. Overrides SearchApiSolrConnectionInterface::makeServletRequest
SearchApiSolrConnection::NAMED_LIST_FORMAT		constant	Defines how NamedLists should be formatted in the output.
SearchApiSolrConnection::optimize	public	function	Sends an optimize command to the Solr server. Overrides SearchApiSolrConnectionInterface::optimize
SearchApiSolrConnection::optimizeOrCommit	protected	function	Sends a commit or optimize command to the Solr server.
SearchApiSolrConnection::phrase	public static	function	Converts a string to a Solr phrase. Overrides SearchApiSolrConnectionInterface::phrase
SearchApiSolrConnection::ping	public	function	Calls the /admin/ping servlet, to test the connection to the server. Overrides SearchApiSolrConnectionInterface::ping
SearchApiSolrConnection::PING_SERVLET		constant	Path to the ping servlet.
SearchApiSolrConnection::search	public	function	Executes a search on the Solr server. Overrides SearchApiSolrConnectionInterface::search
SearchApiSolrConnection::SEARCH_SERVLET		constant	Path to the search servlet.
SearchApiSolrConnection::sendRawGet	protected	function	Sends a GET request to the Solr server.
SearchApiSolrConnection::sendRawPost	protected	function	Sends a PUT request to the Solr server.
SearchApiSolrConnection::setBaseUrl	public	function	Sets the base URL of the Solr server. Overrides SearchApiSolrConnectionInterface::setBaseUrl
SearchApiSolrConnection::setLuke	protected	function	Sets $this->luke with the metadata about the index from admin/luke.
SearchApiSolrConnection::setSoftCommit	public	function	Sets whether this connection will use soft commits when comitting. Overrides SearchApiSolrConnectionInterface::setSoftCommit
SearchApiSolrConnection::setStats	protected	function	Stores information about the Solr core in $this->stats.
SearchApiSolrConnection::setStreamContext	public	function	Set the stream context to use for requests to the Solr server. Overrides SearchApiSolrConnectionInterface::setStreamContext
SearchApiSolrConnection::setSystemInfo	protected	function	Call the /admin/system servlet to retrieve system information.
SearchApiSolrConnection::STATS_SERVLET		constant	Path to the stats servlet.
SearchApiSolrConnection::STATS_SERVLET_4		constant	Path to the stats servlet for Solr 4.x servers.
SearchApiSolrConnection::SYSTEM_SERVLET		constant	Path to the system servlet.
SearchApiSolrConnection::update	public	function	Sends a raw update request to the Solr server. Overrides SearchApiSolrConnectionInterface::update
SearchApiSolrConnection::UPDATE_SERVLET		constant	Path to the update servlet.