Swish::prepare

(PECL swish >= 0.1.0)

Prepare a search query

object Swish::prepare ([ string $query ] )

Prepare and return a search object, which you can later use for unlimited number of queries.

Parameters:

query

Optional query string. The query can be also set using SwishSearch::execute() method.

Returns:

Returns SwishSearch object.

This function is EXPERIMENTAL. The behaviour of this function, its name, and surrounding documentation may change without notice in a future release of PHP. This function should be used at your own risk.

Exception:

Throws SwishException on error.

Examples:

Basic Swish::prepare() example

<?php
 
try {
 
    $swish = new Swish("index.swish-e");
    $search = $swish->prepare("search query");
    $results = $search->execute();
    echo "Found: ", $results->hits, " hits\n";
 
    $results = $search->execute("new search");
 
    echo "Found: ", $results->hits, " hits\n";
} catch (SwishException $e) {
    echo $e->getMessage(), "\n";
}
 
?>

The above example will output something similar to:

Found: 2 hits
Found: 5 hits

Links:

http://php.net/manual/en/swish.prepare.php

doc_php

2025-01-10 15:47:30

Comments