ScopeInterface
in
Scope is an object for providing access to collections.
Table of Contents
- analyticsQuery() : AnalyticsResult
- collection() : CollectionInterface
- name() : string
- query() : QueryResult
- search() : SearchResult
- searchIndexes() : ScopeSearchIndexManagerInterface
Methods
analyticsQuery()
public
analyticsQuery(string $statement[, AnalyticsOptions|null $options = null ]) : AnalyticsResult
Parameters
- $statement : string
- $options : AnalyticsOptions|null = null
Return values
AnalyticsResult —collection()
public
collection(string $name) : CollectionInterface
Parameters
- $name : string
Return values
CollectionInterface —name()
public
name() : string
Return values
string —query()
public
query(string $statement[, QueryOptions|null $options = null ]) : QueryResult
Parameters
- $statement : string
- $options : QueryOptions|null = null
Return values
QueryResult —search()
public
search(string $indexName, SearchRequest $request[, SearchOptions|null $options = null ]) : SearchResult
Parameters
- $indexName : string
- $request : SearchRequest
- $options : SearchOptions|null = null
Return values
SearchResult —searchIndexes()
public
searchIndexes() : ScopeSearchIndexManagerInterface