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 <?php
namespace Basho\Riak\Command\Builder;
use Basho\Riak;
use Basho\Riak\Command;
/**
* Used to increment counter objects in Riak by the provided positive / negative integer
*
* <code>
* $command = (new Command\Builder\IncrementCounter($riak))
* ->buildLocation($user_name, 'user_visit_count', 'visit_counters')
* ->build();
*
* $response = $command->execute($command);
*
* $counter = $response->getCounter();
* </code>
*
* @author Christopher Mancini <cmancini at basho d0t com>
*/
class IncrementCounter extends Command\Builder implements Command\BuilderInterface
{
use LocationTrait;
/**
* @var int|null
*/
protected $increment = NULL;
/**
* {@inheritdoc}
*
* @return Command\DataType\Counter\Store
*/
public function build()
{
$this->validate();
return new Command\DataType\Counter\Store($this);
}
/**
* {@inheritdoc}
*/
public function validate()
{
$this->required('Bucket');
$this->required('Increment');
}
/**
* @param int $increment
*
* @return $this
*/
public function withIncrement($increment = 1)
{
$this->increment = $increment;
return $this;
}
/**
* @return int|null
*/
public function getIncrement()
{
return $this->increment;
}
}