Riak PHP Client
Back to top  

Link

Link

category

Basho
author

Riak team (https://github.com/basho/riak-php-client/contributors)

Methods

Construct a Link object.

__construct(string $bucket, string $key, string $tag = NULL)

Arguments

$bucket

string

  • The bucket name.

$key

string

  • The key.

$tag

string

  • The tag.

Retrieve the Object to which this link points.

get(integer $r = NULL) : Object

Arguments

$r

integer

  • The R-value to use.

Response

Object

Retrieve the Object to which this link points, as a binary.

getBinary(integer $r = NULL) : Object

Arguments

$r

integer

  • The R-value to use.

Response

Object

Get the bucket name of this link.

getBucket() : string

Response

string

Set the bucket name of this link.

setBucket($bucket) : $this

Arguments

$bucket

Response

$this

Get the key of this link.

getKey() : string

Response

string

Set the key of this link.

setKey(string $key) : $this

Arguments

$key

string

  • The key.

Response

$this

Get the tag of this link.

getTag() : string

Response

string

Set the tag of this link.

setTag(string $tag) : $this

Arguments

$tag

string

  • The tag.

Response

$this

Convert this Link object to a link header string. Used internally.

toLinkHeader($client)

Arguments

$client

Return true if the links are equal.

isEqual(\Basho\Riak\Link $link) : boolean

Arguments

$link

\Basho\Riak\Link

  • A Link object.

Response

boolean