File Riak/Command.php | Official Riak Client for PHP

  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  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

<?php

namespace Basho\Riak;

use Basho\Riak\Command\Builder;

/**
 * The command class is used to build a read or write command to be executed against a Riak node.
 *
 * @author Christopher Mancini <cmancini at basho d0t com>
 */
abstract class Command
{
    /**
     * Request method
     *
     * This can be GET, POST, PUT, or DELETE
     *
     * @see http://docs.basho.com/riak/latest/dev/references/http/
     *
     * @var string
     */
    protected $method = 'GET';

    /**
     * Command parameters
     *
     * @var array
     */
    protected $parameters = [];

    /**
     * @var Bucket|null
     */
    protected $bucket = null;

    /**
     * @var Command\Response|null
     */
    protected $response = null;

    /**
     * @var \Basho\Riak|null
     */
    protected $riak = null;

    protected $verbose = false;

    public function __construct(Builder $builder)
    {
        $this->riak = $builder->getConnection();
        $this->parameters = $builder->getParameters();
        $this->verbose = $builder->getVerbose();
    }

    public function isVerbose()
    {
        return $this->verbose;
    }

    /**
     * Executes the command against the API
     *
     * @return Command\Response
     */
    public function execute()
    {
        return $this->riak->execute($this);
    }

    /**
     * Gets the request that was issued to the API by this Command.
     *
     * @return string
     */
    public function getRequest()
    {
        return $this->riak->getLastRequest();
    }

    public function getBucket()
    {
        return $this->bucket;
    }

    /**
     * @param $key string
     *
     * @return null|string
     */
    public function getParameter($key)
    {
        if (isset($this->parameters[$key])) {
            return $this->parameters[$key];
        }

        return null;
    }

    /**
     * @return array
     */
    public function getParameters()
    {
        return $this->parameters;
    }

    /**
     * Command has parameters?
     *
     * @return bool
     */
    public function hasParameters()
    {
        return (bool)count($this->parameters);
    }

    public function getMethod()
    {
        return $this->method;
    }

    public function getResponse()
    {
        return $this->response;
    }

    /**
     * @return Location|null
     */
    public function getLocation()
    {
        return null;
    }

    /**
     * @return Object|null
     */
    public function getObject()
    {
        return null;
    }

    abstract public function getData();

    abstract public function getEncodedData();
}

Namespaces

Classes

Interfaces

Traits

Exceptions