PHP Класс Basho\Riak\Object

Автор: Riak team (https://github.com/basho/riak-php-client/contributors)
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
__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 )

Приватные методы

Метод Описание
validateIndexNameAndValue ( $indexName, $value )

Описание методов

__construct() публичный метод

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

addValueToIndex() публичный метод

public addValueToIndex ( $indexName, $value )

getCharset() публичный метод

public getCharset ( ) : string
Результат string

getContentEncoding() публичный метод

public getContentEncoding ( ) : string
Результат string

getContentType() публичный метод

public getContentType ( )

getData() публичный метод

public getData ( )

getIndex() публичный метод

public getIndex ( $indexName )

getIndexes() публичный метод

public getIndexes ( )

getMetaData() публичный метод

public getMetaData ( )

getMetaDataValue() публичный метод

public getMetaDataValue ( $key )

getRawData() публичный метод

Getter for raw non-decoded response data [HTTP ONLY]
public getRawData ( ) : mixed | null
Результат mixed | null

getVclock() публичный метод

public getVclock ( )

removeMetaDataValue() публичный метод

public removeMetaDataValue ( $key )

removeValueFromIndex() публичный метод

public removeValueFromIndex ( $indexName, $value )

setCharset() публичный метод

public setCharset ( string $charset )
$charset string

setContentEncoding() публичный метод

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() публичный метод

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 setData ( $data )

setMetaDataValue() публичный метод

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

setRawData() публичный метод

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

setVclock() публичный метод

public setVclock ( string $vclock )
$vclock string

Описание свойств

$charset защищенное свойство

protected $charset

$content_encoding защищенное свойство

protected $content_encoding

$content_type защищенное свойство

protected $content_type

$data защищенное свойство

Stored data or object
protected mixed|null $data
Результат mixed | null

$indexes защищенное свойство

protected $indexes

$metadata защищенное свойство

protected $metadata

$raw_data защищенное свойство

Stores raw non-decoded response data
protected mixed|null $raw_data
Результат mixed | null

$vclock защищенное свойство

protected $vclock