Swish Functions
Introducción
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: » https://swish-e.org.
Esta extensión es EXPERIMENTAL. Esto significa que el comportamiento de esta extensión, los nombre de sus funciones y en definitiva TODO lo documentado sobre esta extensión, puede cambiar en una futura versión de PHP SIN AVISO. La advertencia queda hecha, y utilizar esta extensión queda bajo su propia responsabilidad.
Requisitos
PECL/swish requires PHP 5.1.3 or newer.
Instalación
Mas informacion sobre nuevos lanzamientos, descargas ficheros de fuentes, informacion sobre los responsables asi como un 'CHANGELOG', se puede encontrar aqui: » https://pecl.php.net/package/swish.
The latest PECL/swish Win32 DLL can be downloaded here: » php_swish.dll.
Configuración en tiempo de ejecución
Esta extensión no tiene directivas de configuración en php.ini.
Ejemplos
Example#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";
}
?>
El resultado del ejemplo seria algo similar a:
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) }
Constantes predefinidas
Estas constantes están definidas por esta extensión y estarán disponibles solamente cuando la extensión ha sido o bien compilada dentro de PHP o grabada dinámicamente en tiempo de ejecución.
- 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)
Clases predefinidas
Clases predefinidas
Swish
Propiedades
-
indexes - the array of indexes used and their properties. Certain list of properties depends on Swish-e version.
Métodos
-
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
Métodos
-
SwishSearch->setStructure - sets the structure flag in the search object. This flag is used to limit search to certain parts of HTML documents.
-
SwishSearch->setPhraseDelimiter - sets the phrase delimiter character. The default delimiter is double-quotes.
-
SwishSearch->setSort - sets the sort order of the results.
-
SwishSearch->setLimit - sets the limits for the search. Throws SwishException on error.
-
SwishSearch->resetLimit - resets the limits.
-
SwishSearch->execute - executes the query and returns SwishResults object. Throws SwishException on error.
SwishResults
Propiedades
-
hits - the number of results in this SwishResults object.
-
indexes - the array of indexes used in the search.
Métodos
-
SwishResults->nextResult - returns next SwishResult object or FALSE if no more results are available.
-
SwishResults->seekResult - sets the current seek position in the SwishResults object. Throws SwishException on error.
-
SwishResults->getParsedWords - returns an array of words in the query with stopwords removed.
-
SwishResults->getRemovedStopwords - returns an array of removed stopwords.
SwishResult
Propiedades
-
Properties list depends on Swish-e version, see examples.
Métodos
-
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 Excepciones for more details.
Table of Contents
- 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