Class Builder

This class follows the Builder design pattern and is the preferred method for creating Basho\Riak\Command objects for interacting with your Riak data cluster.

use Basho\Riak\Command;
use Basho\Riak\Bucket;
use Basho\Riak\Location;

$bucket = new Bucket('users');

$command = (new Command\Builder(Command::STORE_OBJECT))
     ->withObject(new Object('test_data'))
     ->atLocation(new Location('test_key', $bucket))
     ->build();

Direct known subclasses

Indirect known subclasses

Basho\Riak\Command\Builder\Search\AssociateIndex, Basho\Riak\Command\Builder\Search\DissociateIndex, Basho\Riak\Command\Builder\TimeSeries\DescribeTable

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

Methods summary

`public`	# `__construct( Basho\Riak $riak )`
`abstract public`	# `build( )` Command build Command build Validates then returns the built command object.
`public`	# `withParameter( $key, $value = true )`
`public`	# `withParameters( $parameters = [] )`
`public`	# `withVerboseMode( $verbose = true )`
`public`	# `getParameters( )`
`public`	# `getConnection( )`
`public`	# `getVerbose( )`
`protected boolean`	# `validate( )` Validate command Validate command Method validates if the builder has the parameters / objects required to successfully execute the command Returns boolean Throws `Basho\Riak\Command\Builder\Exception`
`protected`	# `required( $objectName )` Used to verify a property within the builder is not null and is instantiated Used to verify a property within the builder is not null and is instantiated Parameters `$objectName` Throws `Basho\Riak\Command\Builder\Exception`

Properties summary

`protected Basho\Riak\|null`	`$riak`	# `null`
`protected array`	`$parameters` Command parameters Command parameters	# `[]`
`protected array`	`$headers` Command request headers Command request headers	# `[]`
`protected boolean`	`$verbose`	# `false`

Namespaces

Classes

Interfaces

Exceptions

Class Builder

Direct known subclasses

Indirect known subclasses

Methods summary

Returns

Throws

Parameters

Throws

Properties summary