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 <?php
namespace Basho\Riak\Command\Builder;
use Basho\Riak;
use Basho\Riak\Command;
/**
* Used to fetch KV objects from Riak
*
* <code>
* $command = (new Command\Builder\FetchObject($riak))
* ->buildLocation($user_id, 'users', 'default')
* ->build();
*
* $response = $command->execute($command);
*
* $user = $response->getObject();
* </code>
*
* @author Christopher Mancini <cmancini at basho d0t com>
*/
class FetchObject extends Command\Builder implements Command\BuilderInterface
{
use ObjectTrait;
use LocationTrait;
/**
* @var bool
*/
protected $decodeAsAssociative = false;
public function __construct(Riak $riak)
{
parent::__construct($riak);
}
/**
* {@inheritdoc}
*
* @return Command\Object\Fetch;
*/
public function build()
{
$this->validate();
return new Command\Object\Fetch($this);
}
/**
* Tells the client to decode the data as an associative array instead of a PHP stdClass object.
* Only works if the fetched object type is JSON.
*
* @return $this
*/
public function withDecodeAsAssociative()
{
$this->decodeAsAssociative = true;
return $this;
}
/**
* Fetch the setting for decodeAsAssociative.
*
* @return bool
*/
public function getDecodeAsAssociative()
{
return $this->decodeAsAssociative;
}
/**
* {@inheritdoc}
*/
public function validate()
{
$this->required('Location');
}
}