Official Riak Client for PHP
  • Namespace
  • Class
  • Tree

Namespaces

  • Basho
    • Riak
      • Api
        • Http
          • Translator
      • Command
        • Bucket
        • Builder
          • MapReduce
          • Search
          • TimeSeries
        • DataType
          • Counter
          • Map
          • Set
        • Indexes
        • MapReduce
        • Object
        • Search
          • Index
          • Schema
        • Stats
        • TimeSeries
          • Query
      • DataType
      • Node
        • Builder
      • Search
      • TimeSeries

Classes

  • Query
  • Response

Class Response

Container for a response related to an index query

Basho\Riak\Command\Response
Extended by Basho\Riak\Command\Indexes\Response
Namespace: Basho\Riak\Command\Indexes
Author: Alex Moore
Located at Riak/Command/Indexes/Response.php

Methods summary

public
# __construct( $success = true, $code = 0, $message = '', $results = [], $termsReturned = false, $continuation = null, $done = true, $date = '' )

Overrides

Basho\Riak\Command\Response::__construct
public array
# getResults( )

Get the array of keys that match the query

Get the array of keys that match the query

Returns

array
public boolean
# hasReturnTerms( )

Indicates whether the terms are included in the results array.

Indicates whether the terms are included in the results array.

Returns

boolean
public null|string
# getContinuation( )

Get the continuation string for paged queries.

Get the continuation string for paged queries.

Returns

null|string
public string
# getDate( )

Retrieves the date of the counter's retrieval

Retrieves the date of the counter's retrieval

Returns

string

Throws

Basho\Riak\Command\Exception
public
# isDone( )

Methods inherited from Basho\Riak\Command\Response

getCode(), getMessage(), isNotFound(), isSuccess(), isUnauthorized()

Properties summary

protected array $results
# []
protected boolean $termsReturned
# false
protected boolean $done
# false
protected string|null $continuation
# null
protected string $date
# ''

Properties inherited from Basho\Riak\Command\Response

$code, $message, $success

Official Riak Client for PHP API documentation generated by ApiGen