Phraseanet PHP SDK API
Class

PhraseanetSDK\Entity\Query

class Query extends AbstractEntity

Methods

__construct(EntityManager $em)

from AbstractEntity
integer getOffsetStart()

The offset start

setOffsetStart($offsetStart)

integer getPerPage()

The number item to retrieve

setPerPage($perPage)

integer getAvailableResults()

Return the available results its depens of the search engine used on the requested instance

setAvailableResults($availableResults)

integer getTotalResults()

Get the total result

setTotalResults($totalResults)

string getError()

Get errors as string

setError($error)

string getWarning()

Get warnings as string

setWarning($warning)

float getQueryTime()

Get the query time

setQueryTime($queryTime)

string getSearchIndexes()

Get search indexes

setSearchIndexes($searchIndexes)

string getQuery()

Get the query string

setQuery($query)

ArrayCollection getSuggestions()

Get query suggestions as a collection of PhraseanetSDK\Entity\QuerySuggestion objects

setSuggestions(ArrayCollection $suggestions)

ArrayCollection getResults($type = 'record')

Get result as a collection of PhraseanetSDK\Entity\Record objects

setResults(Result $results)

Details

in AbstractEntity at line 21
final public __construct(EntityManager $em)

Parameters

EntityManager $em

at line 45
public integer getOffsetStart()

The offset start

Return Value

integer

at line 50
public setOffsetStart($offsetStart)

Parameters

$offsetStart

at line 60
public integer getPerPage()

The number item to retrieve

Return Value

integer

at line 65
public setPerPage($perPage)

Parameters

$perPage

at line 76
public integer getAvailableResults()

Return the available results its depens of the search engine used on the requested instance

Return Value

integer

at line 81
public setAvailableResults($availableResults)

Parameters

$availableResults

at line 91
public integer getTotalResults()

Get the total result

Return Value

integer

at line 96
public setTotalResults($totalResults)

Parameters

$totalResults

at line 106
public string getError()

Get errors as string

Return Value

string

at line 111
public setError($error)

Parameters

$error

at line 121
public string getWarning()

Get warnings as string

Return Value

string

at line 126
public setWarning($warning)

Parameters

$warning

at line 136
public float getQueryTime()

Get the query time

Return Value

float

at line 141
public setQueryTime($queryTime)

Parameters

$queryTime

at line 151
public string getSearchIndexes()

Get search indexes

Return Value

string

at line 156
public setSearchIndexes($searchIndexes)

Parameters

$searchIndexes

at line 166
public string getQuery()

Get the query string

Return Value

string

at line 171
public setQuery($query)

Parameters

$query

at line 182
public ArrayCollection getSuggestions()

Get query suggestions as a collection of PhraseanetSDK\Entity\QuerySuggestion objects

Return Value

ArrayCollection

at line 187
public setSuggestions(ArrayCollection $suggestions)

Parameters

ArrayCollection $suggestions

at line 197
public ArrayCollection getResults($type = 'record')

Get result as a collection of PhraseanetSDK\Entity\Record objects

Parameters

$type

Return Value

ArrayCollection

at line 206
public setResults(Result $results)

Parameters

Result $results