File Riak/Command/Indexes/Response.php | Official Riak Client for PHP

 1  2  3  4  5  6  7  8  9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94

<?php

namespace Basho\Riak\Command\Indexes;


/**
 * Container for a response related to an index query
 *
 * @author Alex Moore <amoore at basho d0t com>
 */
class Response extends \Basho\Riak\Command\Response
{
    /**
     * @var array
     */
    protected $results = [];

    /**
     * @var bool
     */
    protected $termsReturned = false;

    protected $done = false;

    /**
     * @var string|null
     */
    protected $continuation = null;

    protected $date = '';

    public function __construct($success = true, $code = 0, $message = '', $results = [], $termsReturned = false, $continuation = null, $done = true, $date = '')
    {
        parent::__construct($success, $code, $message);

        $this->results = $results;
        $this->termsReturned = $termsReturned;
        $this->continuation = $continuation;
        $this->done = $done;
        $this->date = $date;

        // when timeout is used, cURL returns success for some reason
        if (in_array($code, ['501', '503'])) {
            $this->success = false;
        }
    }

    /**
     * Get the array of keys that match the query
     *
     * @return array
     */
    public function getResults()
    {
        return $this->results;
    }

    /**
     * Indicates whether the terms are included in the results array.
     *
     * @return bool
     */
    public function hasReturnTerms()
    {
        return $this->termsReturned;
    }

    /**
     * Get the continuation string for paged queries.
     *
     * @return null|string
     */
    public function getContinuation()
    {
        return $this->continuation;
    }

    /**
     * Retrieves the date of the counter's retrieval
     *
     * @return string
     * @throws \Basho\Riak\Command\Exception
     */
    public function getDate()
    {
        return $this->date;
    }

    public function isDone()
    {
        return $this->done;
    }
}

Namespaces

Classes

Interfaces

Traits

Exceptions