CLXIII. Swish Functions

Introduktion

The swish extension provides the bindings for Swish-e API. Swish-e stands for "Simple Web Indexing System for Humans - Enhanced" and is an open source system for indexing and search. Swish-e itself is licensed under GPL license, but uses a clause that allows applications to link against the library if every copy of the combined work is accompanied by the URL to Swish-e source code. Here it is: http://swish-e.org.

Advarsel

Denne udvidelse er EKSPERIMENTABEL. Virkemåden af denne udvidelse -- inklusiv navnene på des funktioner og alt andet dokumenteret om udvidelsen -- ændres muligvis uden advarsel, i en fremtidig version af PHP. Brug af denne udvidelse er på ejet ansvar.

Systemkrav

PECL/swish requires PHP 5.1.3 or newer.

Installation

Uddybende information så som nye udgivelser, downloads, kildekoder, vedligeholder information samt en CHANGELOG, kan findes her: http://pecl.php.net/package/swish.

The latest PECL/swish Win32 DLL can be downloaded here: php_swish.dll.

Runtime Konfiguration

Denne udvidelse har intet konfigurations-direktiv defineret i php.ini.

Eksempler

Eksempel 1. Basic search query

<?php

try
{

    
$swish = new Swish("index.swish-e");
    
$results = $swish->query("test OR text");

    echo
"Found ", $results->hits, " results\n";
    while (
$result = $results->nextResult()) {
        
var_dump($result);
        break;
//break after the first result
    
}

}
catch (SwishException $e) {
    echo
"Error: ", $e->getMessage(), "\n";
}

?>

Ovenstående eksempel vil udskrive noget der ligner:

Found 9 results
object(SwishResult)#3 (8) {
  ["swishreccount"]=>
  int(1)
  ["swishrank"]=>
  int(1000)
  ["swishfilenum"]=>
  int(10)
  ["swishdbfile"]=>
  string(13) "index.swish-e"
  ["swishdocpath"]=>
  string(23) "README.SUBMITTING_PATCH"
  ["swishtitle"]=>
  NULL
  ["swishdocsize"]=>
  int(4557)
  ["swishlastmodified"]=>
  int(1072136752)
}

Foruddefinerede Konstanter

Konstanterne nedenunder er defineret af denne udvidelse, og vil kun være tilgængelige når denne udvidelse enten er blevet kompileret ind i PHP eller dynamisk indsat under runtime.

Swish::META_TYPE_UNDEF (integer)

Swish::META_TYPE_STRING (integer)

Swish::META_TYPE_ULONG (integer)

Swish::META_TYPE_DATE (integer)

Swish::IN_FILE_BIT (integer)

Swish::IN_TITLE_BIT (integer)

Swish::IN_HEAD_BIT (integer)

Swish::IN_BODY_BIT (integer)

Swish::IN_COMMENTS_BIT (integer)

Swish::IN_HEADER_BIT (integer)

Swish::IN_EMPHASIZED_BIT (integer)

Swish::IN_META_BIT (integer)

Swish::IN_FILE (integer)

Swish::IN_TITLE (integer)

Swish::IN_HEAD (integer)

Swish::IN_BODY (integer)

Swish::IN_COMMENTS (integer)

Swish::IN_HEADER (integer)

Swish::IN_EMPHASIZED (integer)

Swish::IN_META (integer)

Swish::IN_ALL (integer)

Foruddefinerede Klasser

Foruddefinerede Klasser

Swish

Egenskaber

  • indexes - the array of indexes used and their properties. Certain list of properties depends on Swish-e version.

Metoder

  • Swish::__construct - constructs new Swish object. Throws SwishException on error.

  • Swish->prepare - prepares and returns SwishSearch object. Throws SwishException on error.

  • Swish->query - executes the query and returns SwishResults object. Throws SwishException on error.

  • Swish->getMetaList - returns an array of meta entries for the given index file.

  • Swish->getPropertyList - returns an array of properties for the given index file.

SwishSearch

Metoder

SwishResults

Egenskaber

  • hits - the number of results in this SwishResults object.

  • indexes - the array of indexes used in the search.

Metoder

SwishResult

Egenskaber

  • Properties list depends on Swish-e version, see examples.

Metoder

  • SwishResult->getMetaList - returns an array of meta entries for the index used in this result.

  • SwishResult->stem - stems the word and returns result as an array of strings. Throws SwishException on error.

SwishException

SwishException extends the built in Exception class and possesses the same set of properties and methods. See sektionen med navn Extending Exceptions i Kapitel 20 for more details.

Indholdsfortegnelse
Swish::__construct -- Construct a Swish object
Swish->getMetaList -- Get the list of meta entries for the index
Swish->getPropertyList -- Get the list of properties for the index
Swish->prepare -- Prepare a search query
Swish->query -- Execute a query and return results object
SwishResult->getMetaList -- Get a list of meta entries
SwishResult->stem -- Stems the given word
SwishResults->getParsedWords -- Get an array of parsed words
SwishResults->getRemovedStopwords -- Get an array of stopwords removed from the query
SwishResults->nextResult -- Get the next search result
SwishResults->seekResult -- Set current seek pointer to the given position
SwishSearch->execute -- Execute the search and get the results
SwishSearch->resetLimit -- Reset the search limits
SwishSearch->setLimit -- Set the search limits
SwishSearch->setPhraseDelimiter -- Set the phrase delimiter
SwishSearch->setSort -- Set the sort order
SwishSearch->setStructure -- Set the structure flag in the search object