Trait IndexTrait

Allows easy code sharing for Bucket getters / setters within the Command Builders

Direct Known Users

Basho\Riak\Command\Builder\QueryIndex

Namespace: Basho\Riak\Command\Builder
Author: Alex Moore
Located at Riak/Command/Builder/IndexTrait.php

Methods summary

`public string\|null`	# `getIndexName( )` Gets the index name Gets the index name Returns string\|null
`public string\|integer\|null`	# `getMatchValue( )` Returns string\|integer\|null
`public string\|integer\|null`	# `getLowerBound( )` Returns string\|integer\|null
`public string\|integer\|null`	# `getUpperBound( )` Returns string\|integer\|null
`public boolean`	# `isMatchQuery( )` Returns boolean
`public boolean`	# `isRangeQuery( )` Returns boolean
`public null\|string`	# `getContinuation( )` Returns null\|string
`public integer\|null`	# `getMaxResults( )` Returns integer\|null
`public boolean\|null`	# `getReturnTerms( )` Returns boolean\|null
`public boolean\|null`	# `getPaginationSort( )` Returns boolean\|null
`public null\|string`	# `getTermFilter( )` Returns null\|string
`public integer\|null`	# `getTimeout( )` Returns integer\|null
`public boolean`	# `isParamSet( $param )` Parameters `$param` Returns boolean
`public`	# `withIndexName( $indexName )` Adds the index name information to the Command Adds the index name information to the Command Parameters `$indexName` Returns $this
`public`	# `withScalarValue( $value )` Adds the scalar index query information to the Command Adds the scalar index query information to the Command Parameters `$value` Returns $this
`public`	# `withRangeValue( $lowerBound, $upperBound )` Adds the range index query information to the Command Adds the range index query information to the Command Parameters `$lowerBound` `$upperBound` Returns $this
`public`	# `withContinuation( null\|string $continuation )` Parameters `$continuation` Returns $this
`public`	# `withMaxResults( integer\|null $maxResults )` Parameters `$maxResults` Returns $this
`public`	# `withReturnTerms( boolean\|null $returnTerms = true )` Parameters `$returnTerms` Returns $this
`public`	# `withPaginationSort( boolean\|null $paginationSort )` Parameters `$paginationSort` Returns $this
`public`	# `withTermFilter( null\|string $termFilter )` Parameters `$termFilter` Returns $this
`public`	# `withTimeout( integer\|null $timeout )` Parameters `$timeout` Returns $this

Properties summary

`protected string\|null`	`$indexName` The name of the index to query. The name of the index to query.	# `NULL`
`protected string\|integer\|null`	`$match` The index match value for scalar queries. The index match value for scalar queries.	# `NULL`
`protected string\|integer\|null`	`$lowerBound` The index lower bound value for range queries. The index lower bound value for range queries.	# `NULL`
`protected string\|integer\|null`	`$upperBound` The index upper bound value for range queries. The index upper bound value for range queries.	# `NULL`
`protected string\|null`	`$continuation` The continuation string for this query. Used to page results when combined with MaxResults. The continuation string for this query. Used to page results when combined with MaxResults.	# `NULL`
`protected integer\|null`	`$maxResults` The maximum number of results returned by the query. The maximum number of results returned by the query.	#
`protected boolean\|null`	`$returnTerms` The option to return the index keys with the Riak object keys. The option to return the index keys with the Riak object keys.	#
`protected boolean\|null`	`$paginationSort` 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. 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.	#
`protected string\|null`	`$termFilter` The option to filter result terms with a Regex. The option to filter result terms with a Regex.	#
`protected integer\|null`	`$timeout`	#

`public string\|null`	# `getIndexName( )` Gets the index name Gets the index name Returns string\|null
`public string\|integer\|null`	# `getMatchValue( )` Returns string\|integer\|null
`public string\|integer\|null`	# `getLowerBound( )` Returns string\|integer\|null
`public string\|integer\|null`	# `getUpperBound( )` Returns string\|integer\|null
`public boolean`	# `isMatchQuery( )` Returns boolean
`public boolean`	# `isRangeQuery( )` Returns boolean
`public null\|string`	# `getContinuation( )` Returns null\|string
`public integer\|null`	# `getMaxResults( )` Returns integer\|null
`public boolean\|null`	# `getReturnTerms( )` Returns boolean\|null
`public boolean\|null`	# `getPaginationSort( )` Returns boolean\|null
`public null\|string`	# `getTermFilter( )` Returns null\|string
`public integer\|null`	# `getTimeout( )` Returns integer\|null
`public boolean`	# `isParamSet( $param )` Parameters `$param` Returns boolean
`public`	# `withIndexName( $indexName )` Adds the index name information to the Command Adds the index name information to the Command Parameters `$indexName` Returns $this
`public`	# `withScalarValue( $value )` Adds the scalar index query information to the Command Adds the scalar index query information to the Command Parameters `$value` Returns $this
`public`	# `withRangeValue( $lowerBound, $upperBound )` Adds the range index query information to the Command Adds the range index query information to the Command Parameters `$lowerBound` `$upperBound` Returns $this
`public`	# `withContinuation( null\|string $continuation )` Parameters `$continuation` Returns $this
`public`	# `withMaxResults( integer\|null $maxResults )` Parameters `$maxResults` Returns $this
`public`	# `withReturnTerms( boolean\|null $returnTerms = true )` Parameters `$returnTerms` Returns $this
`public`	# `withPaginationSort( boolean\|null $paginationSort )` Parameters `$paginationSort` Returns $this
`public`	# `withTermFilter( null\|string $termFilter )` Parameters `$termFilter` Returns $this
`public`	# `withTimeout( integer\|null $timeout )` Parameters `$timeout` Returns $this

Namespaces

Classes

Traits

Exceptions

Trait IndexTrait

Direct Known Users

Methods summary

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Properties summary