Heratio Framework API Reference

ResultPresenter
in package

Result Presenter.

Formats search results for API and frontend display. Handles thumbnail generation, snippet creation, and metadata formatting.

Table of Contents

Methods

formatFacets()  : array<string|int, mixed>
Format facet counts for display.
formatForGrid()  : array<string|int, mixed>
Format results for grid/card display.
formatForList()  : array<string|int, mixed>
Format results for list display.
formatResult()  : array<string|int, mixed>
Format a single result.
formatResults()  : array<string|int, mixed>
Format search results for API response.
formatStats()  : array<string|int, mixed>
Format statistics for display.
highlightTerms()  : string
Highlight search terms in text.

Methods

formatFacets()

Format facet counts for display.

public formatFacets(array<string|int, mixed> $facets) : array<string|int, mixed>
Parameters
$facets : array<string|int, mixed>
Return values
array<string|int, mixed>

formatForGrid()

Format results for grid/card display.

public formatForGrid(Collection $results[, string $culture = 'en' ]) : array<string|int, mixed>
Parameters
$results : Collection
$culture : string = 'en'
Return values
array<string|int, mixed>

formatForList()

Format results for list display.

public formatForList(Collection $results[, string $culture = 'en' ]) : array<string|int, mixed>
Parameters
$results : Collection
$culture : string = 'en'
Return values
array<string|int, mixed>

formatResult()

Format a single result.

public formatResult(object $row[, string $culture = 'en' ]) : array<string|int, mixed>
Parameters
$row : object
$culture : string = 'en'
Return values
array<string|int, mixed>

formatResults()

Format search results for API response.

public formatResults(Collection $results[, string $culture = 'en' ]) : array<string|int, mixed>
Parameters
$results : Collection
$culture : string = 'en'
Return values
array<string|int, mixed>

formatStats()

Format statistics for display.

public formatStats(array<string|int, mixed> $stats) : array<string|int, mixed>
Parameters
$stats : array<string|int, mixed>
Return values
array<string|int, mixed>

highlightTerms()

Highlight search terms in text.

public highlightTerms(string $text, string $query) : string
Parameters
$text : string
$query : string
Return values
string

        
On this page

Search results