Overview

Namespaces

  • PHP
  • vierbergenlars
    • Forage
      • ODM
        • HydrationSettings
      • QueryParser
      • SearchIndex
      • SearchQuery
      • SearchResult
      • Transport

Classes

  • Query
  • QueryBuilder
  • Overview
  • Namespace
  • Class
  • Tree

Class QueryBuilder

Helps building search queries

Namespace: vierbergenlars\Forage\SearchQuery
Located at vierbergenlars/Forage/SearchQuery/QueryBuilder.php
Methods summary
public
# __construct( vierbergenlars\Forage\SearchQuery\Query $query )

Creates a new query builder

Creates a new query builder

Parameters

$query
vierbergenlars\Forage\SearchQuery\Query
$query Override the query object that is built
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# setSearchQuery( string $query )

Sets the search query

Sets the search query

Parameters

$query
string
$query

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# setOffset( integer $offset )

Sets the offset for the search query

Sets the offset for the search query

Parameters

$offset
integer
$offset

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# setLimit( integer $limit )

Sets the limit for the search query

Sets the limit for the search query

Parameters

$limit
integer
$limit

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# addSearchField( string $field )

Adds a new field to search in

Adds a new field to search in

Parameters

$field
string
$field

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# removeSearchField( string $field )

Removes a field from the list to search in

Removes a field from the list to search in

Parameters

$field
string
$field

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# addFacet( string $facet )

Adds a new facet

Adds a new facet

Parameters

$facet
string
$facet

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# removeFacet( string $facet )

Removes a facet

Removes a facet

Parameters

$facet
string
$facet

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# addFilter( string $field, string|array $value )

Adds a filter on a field

Adds a filter on a field

Parameters

$field
string
$field The field to add a filter to
$value
string|array
$value The value(s) to limit the field to

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# removeFilter( string $field, string|array|null $value = null )

Removes a filter on a field

Removes a filter on a field

Parameters

$field
string
$field The field to remove a filter from
$value
string|array|null
$value The values to remove from the filter. If null, remove all filters on the field.

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# addWeight( string $field, integer|array $value )

Adds a weight to a field

Adds a weight to a field

Parameters

$field
string
$field
$value
integer|array
$value

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\QueryBuilder
# removeWeight( string $field, integer|array $value = null )

Removes a weight from a field

Removes a weight from a field

Parameters

$field
string
$field
$value
integer|array
$value

Returns

vierbergenlars\Forage\SearchQuery\QueryBuilder
public vierbergenlars\Forage\SearchQuery\Query
# getQuery( )

Gets the completed query

Gets the completed query

Returns

vierbergenlars\Forage\SearchQuery\Query
public
# __clone( )
Properties summary
protected vierbergenlars\Forage\SearchQuery\Query $query
#

The query that is under construction

The query that is under construction

Forage-PHP-Client API documentation generated by ApiGen 2.8.0