Introduction

These functions allow you to access the ASPseek free search engine. ASPseek is developed by SWsoft and licensed as free software under the GNU license.

ASPseek consists of an indexing robot, a search daemon and a CGI search frontend. It can index as many as a few million URLs and search for words and phrases, use wildcards and do a boolean search. Search results can be limited to time period given, site or Web space (set of sites) and sorted by relevance (PageRank is used) or date.

ASPseek is optimized for multiple sites (threaded index, async DNS lookups, grouping results by site, Web spaces), but can be used for searching one site as well. ASPseek can work with multiple languages/encodings at once (including multibyte encodings such as Chinese) due to Unicode storage mode. Other features include stopwords and ispell support, a charset and language guesser, HTML templates for search results, excerpts and query words highlighting.

More information about ASPseek can be found at http://www.aspseek.org/.

Documentation for ASPseek can be found at http://www.aspseek.org/man/.

This extension is not available on Windows platforms.

Requirements

Download ASPseek from http://www.aspseek.org/ and install it on your system. You need at least version 1.3.0 of ASPseek installed to use these functions. In order to have these functions available, you must also compile PHP with ASPseek support.

Installation

By using the --with-aspseek[=DIR] configuration option you enable PHP to access ASPseek search daemons.

If you are running a version of ASPseek prior to version 1.3.0 then it is assumed that you will have patched your installation of ASPseek according to the instuctions at http://aspseek.unixatwork.com/.

Runtime Configuration

The behaviour of these functions is affected by settings in php.ini.

Here is a short explanation of the configuration directives.

Resource Types

There are five resource types used in the ASPseek module. The first one is the link identifier for a searchd connection, the second a resource which holds the result of a search query, the third a resource which holds the urlset parameters of a result, the fourth a resource which holds the url data of an urlset and the fifth and final resource holds parameters of a cached page.

Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

Examples

This simple example shows how to connect, execute a search query, print results and disconnect from an ASPseek search daemon.

<?php
    /* Connecting */
    $link = aspseek_connect("searchd_host:searchd_port")
        or die("Could not connect");
    print "Connected successfully";

    /* Performing search query */
    $query = "ASPseek PHP Home";
    $result = aspseek_query($query) or die("Query failed");

    /* Printing results in HTML */
    print "<table>\n";
    while (($urlset = aspseek_fetch_urlset($result)) &&
            ($url = aspseek_fetch_url($urlset))) {
        $url_data = aspseek_url_data($url);
        print "\t<tr>\n";
        foreach ($url_data as $col_value) {
          print "\t\t<td>$col_value</td>\n";
        }
        print "\t</tr>\n";
    }
    print "</table>\n";

    /* Closing connection */
    aspseek_close($link);
?>