Class FetchObjects

Builds the command to fetch a collection of objects from Riak using Yokozuna search

Basho\Riak\Command\Builder\MapReduce\FetchObjects implements Basho\Riak\Command\BuilderInterface

Namespace: Basho\Riak\Command\Builder\MapReduce
Author: Christopher Mancini
Located at Riak/Command/Builder/MapReduce/FetchObjects.php

Methods summary

`public Basho\Riak\Command\MapReduce\Fetch;`	# `build( )` Command build Command build Returns Basho\Riak\Command\MapReduce\Fetch; Implementation of `Basho\Riak\Command\BuilderInterface::build()`
`public boolean`	# `validate( )` Validate command Validate command Returns boolean Throws Builder\Exception Overrides `Basho\Riak\Command\Builder::validate`
`public`	# `addBucketInput( Basho\Riak\Bucket $bucket )` addBucketInput addBucketInput Parameters `$bucket` Returns $this
`public`	# `addLocationInput( Basho\Riak\Location $location )` addLocationInput addLocationInput Parameters `$location` Returns $this
`public`	# `withInput( $input )` withInput withInput Sets a single input value as a string. Can be: - a bucket with the default bucket type - a 2i index name - a Search/Yokozuna index name Parameters `$input` Returns $this
`public`	# `withInputs( array $inputs )` withInputs withInputs Sets an array of inputs for the MR request Parameters `$inputs` Returns $this
`public`	# `getInputs( )`
`public string`	# `getQuery( )` Returns string
`public`	# `buildMapPhase( string $bucket = '', string $key = '', string $source = '', string $language = 'javascript', boolean $keep = false )` buildMapPhase buildMapPhase Allows you to define the Map Query Phase by using parameters Parameters `$bucket` `$key` `$source` `$language` `$keep` Returns $this
`protected`	# `setPhase( $type, $data, boolean $keep = false )` setPhase setPhase Parameters `$type` `$data` `$keep`
`protected array`	# `assemblePhaseData( string $bucket = '', string $key = '', string $source = '', string $language = '', string $tag = '' )` assemblePhaseData assemblePhaseData Assembles the parameters into a data structure to define a Query Phase Parameters `$bucket` `$key` `$source` `$language` `$tag` Returns array
`public`	# `buildReducePhase( string $bucket = '', string $key = '', string $source = '', string $language = 'javascript', boolean $keep = true )` buildReducePhase buildReducePhase Allows you to define the Reduce Query Phase by using parameters Parameters `$bucket` `$key` `$source` `$language` `$keep` Returns $this
`public`	# `buildLinkPhase( string $bucket = '', string $tag = '', boolean $keep = false )` buildReducePhase buildReducePhase Allows you to define the Reduce Query Phase by using parameters Parameters `$bucket` `$tag` `$keep` Returns $this
`public`	# `withQuery( array $query )` withQuery withQuery Sets the Query Phase/s for the MR request. This value gets converted directly into a JSON array and passed to Riak Parameters `$query` Returns $this

Methods inherited from Basho\Riak\Command\Builder

__construct(), getConnection(), getParameters(), getVerbose(), required(), withParameter(), withParameters(), withVerboseMode()

Constants summary

Constants inherited from Basho\Riak\Command\BuilderInterface

COMMAND

Properties summary

`protected array\|string`	`$inputs` MR inputs used by query phase MR inputs used by query phase	# `[]`
`protected array`	`$query` MR Query phases - options include map, reduce or link MR Query phases - options include map, reduce or link	# `[]`
`protected integer`	`$timeout` Timeout for MR query Timeout for MR query	# `0`

Properties inherited from Basho\Riak\Command\Builder

$headers, $parameters, $riak, $verbose

Namespaces

Classes

Class FetchObjects

Methods summary

Returns

Implementation of

Returns

Throws

Overrides

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Methods inherited from Basho\Riak\Command\Builder

Constants summary

Constants inherited from Basho\Riak\Command\BuilderInterface

Properties summary

Properties inherited from Basho\Riak\Command\Builder