PHP Class Basho\Riak\Object

Author: Riak team (https://github.com/basho/riak-php-client/contributors)
Afficher le fichier Open project: basho/riak-php-client Class Usage Examples

Protected Properties

Свойство Type Description
$charset
$content_encoding
$content_type
$data mixed | null Stored data or object
$indexes
$metadata
$raw_data mixed | null Stores raw non-decoded response data
$vclock

Méthodes publiques

Méthode Description
__construct ( mixed | null $data = null, array | null $headers = [] )
addValueToIndex ( $indexName, $value )
getCharset ( ) : string
getContentEncoding ( ) : string
getContentType ( )
getData ( )
getIndex ( $indexName )
getIndexes ( )
getMetaData ( )
getMetaDataValue ( $key )
getRawData ( ) : mixed | null Getter for raw non-decoded response data [HTTP ONLY]
getVclock ( )
removeMetaDataValue ( $key )
removeValueFromIndex ( $indexName, $value )
setCharset ( string $charset )
setContentEncoding ( string $content_encoding ) Used to identify the encoding of the object data
setContentType ( string $content_type ) Used to identify the mime-type of the object data
setData ( $data )
setMetaDataValue ( $key, $value = '' )
setRawData ( mixed | null $raw_data )
setVclock ( string $vclock )

Private Methods

Méthode Description
validateIndexNameAndValue ( $indexName, $value )

Method Details

__construct() public méthode

public __construct ( mixed | null $data = null, array | null $headers = [] )
$data mixed | null
$headers array | null DEPRECATED

addValueToIndex() public méthode

public addValueToIndex ( $indexName, $value )

getCharset() public méthode

public getCharset ( ) : string
Résultat string

getContentEncoding() public méthode

public getContentEncoding ( ) : string
Résultat string

getContentType() public méthode

public getContentType ( )

getData() public méthode

public getData ( )

getIndex() public méthode

public getIndex ( $indexName )

getIndexes() public méthode

public getIndexes ( )

getMetaData() public méthode

public getMetaData ( )

getMetaDataValue() public méthode

public getMetaDataValue ( $key )

getRawData() public méthode

Getter for raw non-decoded response data [HTTP ONLY]
public getRawData ( ) : mixed | null
Résultat mixed | null

getVclock() public méthode

public getVclock ( )

removeMetaDataValue() public méthode

public removeMetaDataValue ( $key )

removeValueFromIndex() public méthode

public removeValueFromIndex ( $indexName, $value )

setCharset() public méthode

public setCharset ( string $charset )
$charset string

setContentEncoding() public méthode

If set to base64, object data will be automatically encoded to base64 upon transfer to Riak. If set to binary or none, object data will NOT be rawurlencoded upon transfer to Riak.
public setContentEncoding ( string $content_encoding )
$content_encoding string

setContentType() public méthode

If set to application/json or text/json the object data will automatically be json_encoded upon transfer to Riak.
public setContentType ( string $content_type )
$content_type string

setData() public méthode

public setData ( $data )

setMetaDataValue() public méthode

public setMetaDataValue ( $key, $value = '' )

setRawData() public méthode

public setRawData ( mixed | null $raw_data )
$raw_data mixed | null

setVclock() public méthode

public setVclock ( string $vclock )
$vclock string

Property Details

$charset protected_oe property

protected $charset

$content_encoding protected_oe property

protected $content_encoding

$content_type protected_oe property

protected $content_type

$data protected_oe property

Stored data or object
protected mixed|null $data
Résultat mixed | null

$indexes protected_oe property

protected $indexes

$metadata protected_oe property

protected $metadata

$raw_data protected_oe property

Stores raw non-decoded response data
protected mixed|null $raw_data
Résultat mixed | null

$vclock protected_oe property

protected $vclock