Skip to content
This repository

A Chainable (Fluent) PHP API for building Solr queries.

branch: master
README.md

SolrAPI: A PHP library for working with Solr

This library provides a chainable (Fluent) API for building and executing Solr queries.

Installation

This library depends on the SolrPHPClient library, which handles Solr client-server communication.

With Packagist/Composer (recommended)

  1. Get Composer if you don't have it already.
  2. In your own composer.json, add technosophos/LibRIS in the "require" section.
{
  "require" {
    "technosophos/LibRIS": ">=1.0.0"
  }
}

When you run php composer.phar install or php composer.phar update in your package, the latest stable version of SolrAPI (along with its dependencies) will be added.

Note that you can use Composer to manage many, if not all, of your library dependencies.

Ye Olde-Fashioned Way

  1. Install the SolrPHPClient library.
  2. Download this libary
  3. Put this library somewhere where your PHP interpreter can see it
  4. Include it in your scripts (require 'solrapi.inc')

That's all there is to it.

For Drupal Users

UPDATE: The Drupal version is on branch 1.0.0. Drupal has drifted away from mainstream PHP, and may or may not work with the 2.x version of SolrAPI.

This library contains some additional features targeted toward the Drupal apachesolr module.

To use this under Drupal, you merely need to install and configure the apachesolr module, and then include this library. (I wrote a simple module to do the including.)

Using the library

Since SolrAPI uses a function, and functions cannot be autoloaded, if you want to use solarq() you will need to do this:

<?php
require_once 'SolrAPI.php';
?>

If you would rather have SPR-0 autoloading, and don't care about the solarq() function, you can put the SolrAPI source in your include path, turn on your autoloader, and use SolrAPI like this:

<?php
$query = new \SolrAPI\Query($string, $options);

$query->search();
?>

The query object can be chained just like a solrq() can.

The code is documented very well. Here's a simple example of how this library is used:

<?php
// Execute a search
$results = solrq('Search me')->search();

// $result now has a SolrPHPClient search result object.
foreach ($results->response->docs as $doc)) {
  print $doc->title;
}
?>

The above executes a simple query for the string 'Search me'. Far more sophisticated queries can be built, though:

<?php
$results = solrq('monkey wrench')
   ->useQueryParser(SolrAPI::QUERY_PARSER_DISMAX) // Use the DisMax parser.
   ->limit(20)           // Return 20 items
   ->offset(1)           // Skip the first result (why? I don't know... this is just an example)
   ->boostQueries('sticky:true^5.0')     // Increase ranking on sticky nodes.
   ->queryFields('title^5.0 body^20.0')   // Fields to query, along with their boosts.
   ->retrieveFields('title, body')       // just get the title and body.
   ->highlight()        // Highlight matches in title and body.
   ->spellcheck()       // Check spelling on query string ('blue smurf') and offer alternatives
   ->sort('title asc')  // Sort by title, ascending
   ->debug(TRUE)        // Include debugging info in the output.
   ->search();          // Execute the search.
?>

Solr is an advanced search server built atop the equally advanced Lucene search engine. To get the most out of this library, you will probably want to become very familiar with the Solr documentation.

This module was coded against the Drupal coding standards. Documentation can be extracted with Doxygen.

  • More information is in the wiki

License

This is released under the GPL for Drupal compatibility. You may also opt to use it in accordance with the MIT license.

Copyright (c) 2010-2012, Matt Butcher

Initially sponsored by ConsumerSearch.com, a New York Times company.

Something went wrong with that request. Please try again.