vierbergenlars/forage-client

This package is abandoned and no longer maintained. No replacement package was suggested.

PHP client for the forage search server

v0.2.0-alpha2 2013-10-05 16:29 UTC

Requires

• ext-curl: *
• vierbergenlars/defer: ~1.0.1

Requires (Dev)

• vierbergenlars/simpletest: 1.1.2

MIT

• Lars Vierbergen

README

A PHP client for the Forage search server

License: MIT

Installation

$ composer require vierbergenlars/forage-client:~0.2@alpha

Usage example

<?php

use vierbergenlars\Forage\Transport\Http as HttpTransport;
use vierbergenlars\Forage\Client;

$transport = new HttpTransport;
$client = new Client($transport);

$query = $client->createQueryBuilder()
               ->setSearchQuery('Funny cat')
               ->setOffset(($_GET['page']-1)*10)
               ->setLimit(10)
               ->addSearchField('title')
               ->addFacet('media_type')
               ->addFilter('animal', 'cat')
               ->addFilter('categories', array('funny', 'lol'))
               ->addWeight('title', 3)
               ->getQuery();

$results = $query->execute();

echo 'Total hits: '.$results->getTotalHits();
foreach($result as $hit) {
    /* @var $hit \vierbergenlars\Forage\SearchResult\Hit */
    echo ' - '.$hit->getDocument()['title'].' (score: '.$hit->getScore().'; id='.$hit->getId().')';
}

Full documentation is available in the wiki, or have a look at the API documentation