File Riak/Command/Builder/Search/FetchObjects.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  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185

<?php

namespace Basho\Riak\Command\Builder\Search;

use Basho\Riak;
use Basho\Riak\Command;

/**
 * Builds the command to fetch a collection of objects from Riak using Yokozuna search
 *
 * @author Christopher Mancini <cmancini at basho d0t com>
 */
class FetchObjects extends Command\Builder implements Command\BuilderInterface
{
    protected $default_field = '';

    protected $default_operation = '';

    protected $index_name = '';

    public function __construct(Riak $riak)
    {
        parent::__construct($riak);

        $this->parameters['wt'] = 'json';
        $this->parameters['rows'] = 10;
        $this->parameters['start'] = 0;
    }

    /**
     * {@inheritdoc}
     *
     * @return Command\Search\Fetch;
     */
    public function build()
    {
        $this->validate();

        return new Command\Search\Fetch($this);
    }

    /**
     * {@inheritdoc}
     */
    public function validate()
    {
        $this->required('IndexName');
        $this->required('Query');
        $this->required('MaxRows');
        $this->required('StartRow');
    }

    public function withIndexName($name)
    {
        $this->index_name = $name;

        return $this;
    }

    public function getIndexName()
    {
        return $this->index_name;
    }

    /**
     * @return string
     */
    public function getQuery()
    {
        return $this->parameters['q'];
    }

    /**
     * @return int
     */
    public function getMaxRows()
    {
        return $this->parameters['rows'];
    }

    /**
     * @return int
     */
    public function getStartRow()
    {
        return $this->parameters['start'];
    }

    /**
     * @return string
     */
    public function getFilterQuery()
    {
        return $this->parameters['fq'];
    }

    /**
     * @return string
     */
    public function getSortField()
    {
        return $this->parameters['sort'];
    }

    /**
     * @return string
     */
    public function getDefaultField()
    {
        return $this->default_field;
    }

    /**
     * @return string
     */
    public function getDefaultOperation()
    {
        return $this->default_operation;
    }

    /**
     * @return string
     */
    public function getReturnFields()
    {
        return $this->parameters['fl'];
    }

    public function withQuery($query)
    {
        $this->parameters['q'] = $query;

        return $this;
    }

    public function withMaxRows($rows)
    {
        $this->parameters['rows'] = $rows;

        return $this;
    }

    public function withStartRow($row_num)
    {
        $this->parameters['start'] = $row_num;

        return $this;
    }

    public function withSortField($field_name)
    {
        $this->parameters['sort'] = $field_name;

        return $this;
    }

    public function withFilterQuery($filter_query)
    {
        $this->parameters['fq'] = $filter_query;

        return $this;
    }

    public function withDefaultField($default_field)
    {
        $this->parameters['df'] = $default_field;

        return $this;
    }

    public function withDefaultOperation($default_operation)
    {
        $this->parameters['op'] = $default_operation;

        return $this;
    }

    public function withReturnFields($return_fields)
    {
        $this->parameters['fl'] = $return_fields;

        return $this;
    }
}

Namespaces

Classes

Interfaces

Traits

Exceptions