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 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 <?php
namespace Basho\Riak\Command\Builder;
/**
* Allows easy code sharing for Bucket getters / setters within the Command Builders
*
* @author Alex Moore <amoore at basho d0t com>
*/
trait IndexTrait
{
/**
* The name of the index to query.
*
* @var string|null
*/
protected $indexName = NULL;
/**
* The index match value for scalar queries.
*
* @var string|integer|null
*/
protected $match = NULL;
/**
* The index lower bound value for range queries.
*
* @var string|integer|null
*/
protected $lowerBound = NULL;
/**
* The index upper bound value for range queries.
*
* @var string|integer|null
*/
protected $upperBound = NULL;
/**
* The continuation string for this query.
* Used to page results when combined with MaxResults.
*
* @var string|null
*/
protected $continuation = NULL; //Binary
/**
* The maximum number of results returned by the query.
*
* @var integer|null
*/
protected $maxResults; // Int
/**
* The option to return the index keys with the Riak object keys.
*
* @var boolean|null
*/
protected $returnTerms; // Bool
/**
* The option to sort, or not sort, the results of a non-paginated secondary index query.
* If MaxResults is set, this property is ignored.
* By default results are sorted first by index value, then by key value.
*
* @var boolean|null
*/
protected $paginationSort; // Bool
/**
* The option to filter result terms with a Regex.
*
* @var string|null
*/
protected $termFilter; // string
/**
*
* @var integer|null
*/
protected $timeout; // timeout
/**
* Gets the index name
*
* @return string|null
*/
public function getIndexName()
{
return $this->indexName;
}
/**
* @return string|integer|null
*/
public function getMatchValue()
{
return $this->match;
}
/**
* @return string|integer|null
*/
public function getLowerBound()
{
return $this->lowerBound;
}
/**
* @return string|integer|null
*/
public function getUpperBound()
{
return $this->upperBound;
}
/**
* @return boolean
*/
public function isMatchQuery()
{
return isset($this->match);
}
/**
* @return boolean
*/
public function isRangeQuery()
{
return isset($this->lowerBound) && isset($this->upperBound);
}
/**
* @return null|string
*/
public function getContinuation()
{
return $this->continuation;
}
/**
* @return int|null
*/
public function getMaxResults()
{
return $this->maxResults;
}
/**
* @return bool|null
*/
public function getReturnTerms()
{
return $this->returnTerms;
}
/**
* @return bool|null
*/
public function getPaginationSort()
{
return $this->paginationSort;
}
/**
* @return null|string
*/
public function getTermFilter()
{
return $this->termFilter;
}
/**
* @return int|null
*/
public function getTimeout()
{
return $this->timeout;
}
/**
* @param $param
* @return bool
*/
public function isParamSet($param)
{
return !empty($this->$param);
}
/**
* Adds the index name information to the Command
*
* @param $indexName
*
* @return $this
*/
public function withIndexName($indexName)
{
$this->indexName = $indexName;
return $this;
}
/**
* Adds the scalar index query information to the Command
*
* @param $value
*
* @return $this
*/
public function withScalarValue($value)
{
$this->match = $value;
$this->lowerBound = null;
$this->upperBound = null;
return $this;
}
/**
* Adds the range index query information to the Command
*
* @param $lowerBound
* @param $upperBound
*
* @return $this
*/
public function withRangeValue($lowerBound, $upperBound)
{
$this->lowerBound = $lowerBound;
$this->upperBound = $upperBound;
$this->match = null;
return $this;
}
/**
* @param null|string $continuation
*
* @return $this
*/
public function withContinuation($continuation)
{
$this->continuation = $continuation;
return $this;
}
/**
* @param int|null $maxResults
*
* @return $this
*/
public function withMaxResults($maxResults)
{
$this->maxResults = $maxResults;
return $this;
}
/**
* @param bool|null $returnTerms
*
* @return $this
*/
public function withReturnTerms($returnTerms = true)
{
$this->returnTerms = $returnTerms;
return $this;
}
/**
* @param bool|null $paginationSort
*
* @return $this
*/
public function withPaginationSort($paginationSort)
{
$this->paginationSort = $paginationSort;
return $this;
}
/**
* @param null|string $termFilter
*
* @return $this
*/
public function withTermFilter($termFilter)
{
$this->termFilter = $termFilter;
return $this;
}
/**
* @param int|null $timeout
*
* @return $this
*/
public function withTimeout($timeout)
{
$this->timeout = $timeout;
return $this;
}
}