Scope
in package
implements
ScopeInterface
Interfaces, Classes, Traits and Enums
- ScopeInterface
- Scope is an object for providing access to collections.
Table of Contents
- DEFAULT_NAME = "_default"
- $bucketName : string
- $client : Client
- $name : string
- __construct() : mixed
- analyticsQuery() : AnalyticsResult
- collection() : Collection
- name() : string
- query() : QueryResult
Constants
DEFAULT_NAME
public
mixed
DEFAULT_NAME
= "_default"
Properties
$bucketName
private
string
$bucketName
$client
private
Client
$client
$name
private
string
$name
Methods
__construct()
public
__construct(Client $client, string $bucketName, string $name) : mixed
Parameters
- $client : Client
- $bucketName : string
- $name : string
Return values
mixed —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) : Collection
Parameters
- $name : string
Return values
Collection —name()
public
name() : string
Return values
string —query()
public
query(string $statement[, QueryOptions|null $options = null ]) : QueryResult
Parameters
- $statement : string
- $options : QueryOptions|null = null