SunshinePHP Developer Conference 2015

Swish::prepare

(PECL swish >= 0.1.0)

Swish::preparePrepare a search query

Description

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

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.

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.

Return Values

Returns SwishSearch object.

Errors/Exceptions

Throws SwishException on error.

Examples

Example #1 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

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top