Official Riak Client for PHP
  • Namespace
  • Class
  • Tree

Namespaces

  • Basho
    • Riak
      • Api
        • Http
          • Translator
      • Command
        • Bucket
        • Builder
          • MapReduce
          • Search
          • TimeSeries
        • DataType
          • Counter
          • Map
          • Set
        • Indexes
        • MapReduce
        • Object
        • Search
          • Index
          • Schema
        • Stats
        • TimeSeries
          • Query
      • DataType
      • Node
        • Builder
      • Search
      • TimeSeries

Classes

  • DeleteObject
  • FetchBucketProperties
  • FetchCounter
  • FetchMap
  • FetchObject
  • FetchPreflist
  • FetchSet
  • FetchStats
  • IncrementCounter
  • Ping
  • QueryIndex
  • SetBucketProperties
  • StoreObject
  • UpdateMap
  • UpdateSet

Traits

  • BucketTrait
  • IndexTrait
  • LocationTrait
  • ObjectTrait

Exceptions

  • Exception

Class IncrementCounter

Used to increment counter objects in Riak by the provided positive / negative integer

$command = (new Command\Builder\IncrementCounter($riak))
  ->buildLocation($user_name, 'user_visit_count', 'visit_counters')
  ->build();

$response = $command->execute($command);

$counter = $response->getCounter();
Basho\Riak\Command\Builder
Extended by Basho\Riak\Command\Builder\IncrementCounter implements Basho\Riak\Command\BuilderInterface uses Basho\Riak\Command\Builder\LocationTrait
Namespace: Basho\Riak\Command\Builder
Author: Christopher Mancini
Located at Riak/Command/Builder/IncrementCounter.php

Methods summary

public Basho\Riak\Command\DataType\Counter\Store
# build( )

Command build

Command build

Returns

Basho\Riak\Command\DataType\Counter\Store

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
# withIncrement( integer $increment = 1 )

Parameters

$increment

Returns


$this
public integer|null
# getIncrement( )

Returns

integer|null

Methods inherited from Basho\Riak\Command\Builder

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

Methods used from Basho\Riak\Command\Builder\LocationTrait

atLocation(), buildLocation(), getLocation()

Constants summary

Constants inherited from Basho\Riak\Command\BuilderInterface

COMMAND

Properties summary

protected integer|null $increment
# NULL

Properties inherited from Basho\Riak\Command\Builder

$headers, $parameters, $riak, $verbose

Properties used from Basho\Riak\Command\Builder\LocationTrait

$location

Official Riak Client for PHP API documentation generated by ApiGen