Overview

Namespaces

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

Classes

  • DocumentMapper
  • SearchHit
  • SearchIndex
  • SearchQuery
  • SearchResult

Interfaces

  • HydrationSettingsInterface
  • Indexable
  • Overview
  • Namespace
  • Class
  • Tree

Class SearchQuery

A search query that automatically converts all search results to an hydrated object

vierbergenlars\Forage\SearchQuery\Query
Extended by vierbergenlars\Forage\ODM\SearchQuery
Namespace: vierbergenlars\Forage\ODM
Located at vierbergenlars/Forage/ODM/SearchQuery.php
Methods summary
public vierbergenlars\Forage\ODM\SearchResult
# execute( )

Executes the search and hydrates the result

Executes the search and hydrates the result

Returns

vierbergenlars\Forage\ODM\SearchResult

Overrides

vierbergenlars\Forage\SearchQuery\Query::execute()
Methods inherited from vierbergenlars\Forage\SearchQuery\Query
__construct(), setFacetFields(), setLimit(), setOffset(), setQuery(), setSearchFields(), setSearchFilters(), setWeights()
Properties summary
protected string $searchResultClass '\vierbergenlars\Forage\ODM\SearchResult'
#

The class that parses the results

The class that parses the results

protected vierbergenlars\Forage\ODM\HydrationSettingsInterface $hydrationSettings
#

Settings for object hydration

Settings for object hydration

Properties inherited from vierbergenlars\Forage\SearchQuery\Query
$facetFields, $limit, $offset, $query, $searchFields, $searchFilters, $transport, $weights
Forage-PHP-Client API documentation generated by ApiGen 2.8.0