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 Command

The command class is used to build a read or write command to be executed against a Riak node.

Direct known subclasses

Basho\Riak\Command\Bucket\Fetch, Basho\Riak\Command\Bucket\Store, Basho\Riak\Command\Object, Basho\Riak\Command\Ping, Basho\Riak\Command\Search\Fetch, Basho\Riak\Command\Search\Index\Delete, Basho\Riak\Command\Search\Index\Fetch, Basho\Riak\Command\Search\Index\Store, Basho\Riak\Command\Search\Schema\Fetch, Basho\Riak\Command\Search\Schema\Store, Basho\Riak\Command\Stats, Basho\Riak\Command\TimeSeries\Delete, Basho\Riak\Command\DataType\Counter\Fetch, Basho\Riak\Command\TimeSeries\Fetch, Basho\Riak\Command\TimeSeries\Query\Fetch, Basho\Riak\Command\TimeSeries\Store, Basho\Riak\Command\DataType\Counter\Store, Basho\Riak\Command\DataType\Map\Fetch, Basho\Riak\Command\DataType\Map\Store, Basho\Riak\Command\DataType\Set\Fetch, Basho\Riak\Command\DataType\Set\Store, Basho\Riak\Command\Indexes\Query, Basho\Riak\Command\MapReduce\Fetch

Indirect known subclasses

Basho\Riak\Command\Bucket\Delete, Basho\Riak\Command\Object\Delete, Basho\Riak\Command\Object\Fetch, Basho\Riak\Command\Object\FetchPreflist, Basho\Riak\Command\Object\Store

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

Methods summary

public
# __construct( Basho\Riak\Command\Builder $builder )
public
# isVerbose( )
public Basho\Riak\Command\Response
# execute( )

Executes the command against the API

Executes the command against the API

Returns

Basho\Riak\Command\Response
public string
# getRequest( )

Gets the request that was issued to the API by this Command.

Gets the request that was issued to the API by this Command.

Returns

string
public
# getBucket( )
public null|string
# getParameter( $key )

Parameters

$key
string

Returns

null|string
public array
# getParameters( )

Returns

array
public boolean
# hasParameters( )

Command has parameters?

Command has parameters?

Returns

boolean
public
# getMethod( )
public
# getResponse( )
public Basho\Riak\Location|null
# getLocation( )

Returns

Basho\Riak\Location|null
public Basho\Riak\Object|null
# getObject( )

Returns

Basho\Riak\Object|null
abstract public
# getData( )
abstract public
# getEncodedData( )

Properties summary

protected string $method

Request method

Request method

This can be GET, POST, PUT, or DELETE

See

http://docs.basho.com/riak/latest/dev/references/http/
# 'GET'
protected array $parameters

Command parameters

Command parameters

# []
protected Basho\Riak\Bucket|null $bucket
# null
protected Basho\Riak\Command\Response|null $response
# null
protected Basho\Riak|null $riak
# null
protected boolean $verbose
# false
Official Riak Client for PHP API documentation generated by ApiGen