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

  • Api
  • Bucket
  • Command
  • DataType
  • Location
  • Node
  • Object

Interfaces

  • ApiInterface
  • CommandInterface

Traits

  • HeadersTrait

Exceptions

  • Exception

Class Api

Extend this class to implement your own API bridge.

Direct known subclasses

Basho\Riak\Api\Http

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

Methods summary

public
# __construct( array $config = [] )
public string
# getError( )

Returns

string
public Basho\Riak\Command|null
# getCommand( )

Returns

Basho\Riak\Command|null
protected
# setCommand( Basho\Riak\Command|null $command )

Parameters

$command

Returns


$this
public Basho\Riak\Node|null
# getNode( )

Returns

Basho\Riak\Node|null
public
# setNode( Basho\Riak\Node|null $node )

Parameters

$node

Returns


$this
public string
# getRequest( )

Returns

string
public
# prepare( Basho\Riak\Command $command, Basho\Riak\Node $node )

Prepare the api connection

Prepare the api connection

Parameters

$command
$node

Returns


$this
public Basho\Riak\Command\Response|null
# getResponse( )

Returns

Basho\Riak\Command\Response|null
public null
# getSuccess( )

Returns

null
public array
# getConfig( )

Returns

array
abstract public boolean
# send( )

send

send

Returns

boolean
abstract public null
# closeConnection( )

Closes the connection to the Riak Interface

Closes the connection to the Riak Interface

Returns

null

Properties summary

protected string $request

Request string to be sent

Request string to be sent

# ''
protected Basho\Riak\Command\Response|null $response
# null
protected Basho\Riak\Command|null $command
# null
protected Basho\Riak\Node|null $node
# null
protected $success
# null
protected string $error
# ''
protected array $config
# []
Official Riak Client for PHP API documentation generated by ApiGen