File Riak/Command/Search/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

<?php

namespace Basho\Riak\Command\Search;

use Basho\Riak\Search\Doc;

/**
 * Container for a response for receiving data back from a Search request on Riak
 *
 * @author Christopher Mancini <cmancini at basho d0t com>
 */
class Response extends \Basho\Riak\Command\Response
{
    /**
     * @var int
     */
    protected $numFound = 0;

    /**
     * @var Doc[]
     */
    protected $docs = [];

    /**
     * Response constructor.
     * @param bool|true $success
     * @param int $code
     * @param string $message
     * @param int $numFound
     * @param \Basho\Riak\Search\Doc[] $docs
     */
    public function __construct($success = true, $code = 0, $message = '', $numFound = 0, $docs = [])
    {
        parent::__construct($success, $code, $message);

        $this->numFound = $numFound;
        $this->docs = $docs;
    }

    /**
     * @return int
     */
    public function getNumFound()
    {
        return $this->numFound;
    }

    /**
     * @return \Basho\Riak\Search\Doc[]
     */
    public function getDocs()
    {
        return $this->docs;
    }
}

Namespaces

Classes

Interfaces

Traits

Exceptions