PHP Класс Elastica\AbstractUpdateAction

Автор: Nik Everett ([email protected])
Наследование: extends Param
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$_upsert Document

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

Метод Описание
getConsistency ( ) : string
getFields ( ) : string
getId ( ) : string | integer Returns document id.
getIndex ( ) : string Get the document index name.
getOpType ( ) : string Get operation type.
getOptions ( array $fields = [], boolean $withUnderscore = false ) : array
getParent ( ) : string | integer Returns the parent document id.
getRefresh ( ) : boolean
getReplication ( ) : string
getRetryOnConflict ( ) : integer
getRouting ( ) : string Get routing parameter.
getTimeout ( ) : boolean
getTimestamp ( ) : integer
getTtl ( ) : string
getType ( ) : string Return document type name.
getUpsert ( ) : Document
getVersion ( ) : string | integer Returns document version.
getVersionType ( ) : string | integer Returns document version type.
hasConsistency ( ) : boolean
hasFields ( ) : boolean
hasId ( ) : boolean
hasOpType ( ) : boolean
hasParent ( ) : boolean
hasRefresh ( ) : boolean
hasReplication ( ) : boolean
hasRetryOnConflict ( ) : boolean
hasRouting ( ) : boolean
hasTimeout ( ) : boolean
hasTimestamp ( ) : boolean
hasTtl ( ) : boolean
hasUpsert ( ) : boolean
hasVersion ( ) : boolean
hasVersionType ( ) : boolean
setConsistency ( string $timeout )
setFields ( array | string $fields )
setFieldsSource ( )
setId ( string $id ) Sets the id of the document.
setIndex ( Index | string $index ) Sets the document index name.
setOpType ( string $opType ) Set operation type.
setParent ( string | integer $parent ) Sets parent document id.
setRefresh ( boolean $refresh = true )
setReplication ( string $timeout )
setRetryOnConflict ( integer $num )
setRouting ( string $value ) Set routing query param.
setTimeout ( string $timeout )
setTimestamp ( string $timestamp )
setTtl ( string $ttl ) Sets lifetime of document.
setType ( Type | string $type ) Sets the document type name.
setUpsert ( Document | array $data )
setVersion ( integer $version ) Sets the version of a document for use with optimistic concurrency control.
setVersionType ( string $versionType ) Sets the version_type of a document Default in ES is internal, but you can set to external to use custom versioning.

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

getConsistency() публичный Метод

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

getFields() публичный Метод

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

getId() публичный Метод

Returns document id.
public getId ( ) : string | integer
Результат string | integer Document id

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

Get the document index name.
public getIndex ( ) : string
Результат string Index name

getOpType() публичный Метод

Get operation type.
public getOpType ( ) : string
Результат string

getOptions() публичный Метод

public getOptions ( array $fields = [], boolean $withUnderscore = false ) : array
$fields array if empty array all options will be returned, field names can be either with underscored either without, i.e. _percolate, routing
$withUnderscore boolean should option keys contain underscore prefix
Результат array

getParent() публичный Метод

Returns the parent document id.
public getParent ( ) : string | integer
Результат string | integer Parent document id

getRefresh() публичный Метод

public getRefresh ( ) : boolean
Результат boolean

getReplication() публичный Метод

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

getRetryOnConflict() публичный Метод

public getRetryOnConflict ( ) : integer
Результат integer

getRouting() публичный Метод

Get routing parameter.
public getRouting ( ) : string
Результат string

getTimeout() публичный Метод

public getTimeout ( ) : boolean
Результат boolean

getTimestamp() публичный Метод

public getTimestamp ( ) : integer
Результат integer

getTtl() публичный Метод

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

getType() публичный Метод

Return document type name.
public getType ( ) : string
Результат string Document type name

getUpsert() публичный Метод

public getUpsert ( ) : Document
Результат Document

getVersion() публичный Метод

Returns document version.
public getVersion ( ) : string | integer
Результат string | integer Document version

getVersionType() публичный Метод

Returns document version type.
public getVersionType ( ) : string | integer
Результат string | integer Document version type

hasConsistency() публичный Метод

public hasConsistency ( ) : boolean
Результат boolean

hasFields() публичный Метод

public hasFields ( ) : boolean
Результат boolean

hasId() публичный Метод

public hasId ( ) : boolean
Результат boolean

hasOpType() публичный Метод

public hasOpType ( ) : boolean
Результат boolean

hasParent() публичный Метод

public hasParent ( ) : boolean
Результат boolean

hasRefresh() публичный Метод

public hasRefresh ( ) : boolean
Результат boolean

hasReplication() публичный Метод

public hasReplication ( ) : boolean
Результат boolean

hasRetryOnConflict() публичный Метод

public hasRetryOnConflict ( ) : boolean
Результат boolean

hasRouting() публичный Метод

public hasRouting ( ) : boolean
Результат boolean

hasTimeout() публичный Метод

public hasTimeout ( ) : boolean
Результат boolean

hasTimestamp() публичный Метод

public hasTimestamp ( ) : boolean
Результат boolean

hasTtl() публичный Метод

public hasTtl ( ) : boolean
Результат boolean

hasUpsert() публичный Метод

public hasUpsert ( ) : boolean
Результат boolean

hasVersion() публичный Метод

public hasVersion ( ) : boolean
Результат boolean

hasVersionType() публичный Метод

public hasVersionType ( ) : boolean
Результат boolean

setConsistency() публичный Метод

public setConsistency ( string $timeout )
$timeout string

setFields() публичный Метод

public setFields ( array | string $fields )
$fields array | string

setFieldsSource() публичный Метод

public setFieldsSource ( )

setId() публичный Метод

Sets the id of the document.
public setId ( string $id )
$id string

setIndex() публичный Метод

Sets the document index name.
public setIndex ( Index | string $index )
$index Index | string Index name

setOpType() публичный Метод

Set operation type.
public setOpType ( string $opType )
$opType string Only accept create

setParent() публичный Метод

Sets parent document id.
public setParent ( string | integer $parent )
$parent string | integer Parent document id

setRefresh() публичный Метод

public setRefresh ( boolean $refresh = true )
$refresh boolean

setReplication() публичный Метод

public setReplication ( string $timeout )
$timeout string

setRetryOnConflict() публичный Метод

public setRetryOnConflict ( integer $num )
$num integer

setRouting() публичный Метод

Set routing query param.
public setRouting ( string $value )
$value string routing

setTimeout() публичный Метод

public setTimeout ( string $timeout )
$timeout string

setTimestamp() публичный Метод

public setTimestamp ( string $timestamp )
$timestamp string

setTtl() публичный Метод

Sets lifetime of document.
public setTtl ( string $ttl )
$ttl string

setType() публичный Метод

Sets the document type name.
public setType ( Type | string $type )
$type Type | string Type name

setUpsert() публичный Метод

public setUpsert ( Document | array $data )
$data Document | array

setVersion() публичный Метод

Sets the version of a document for use with optimistic concurrency control.
public setVersion ( integer $version )
$version integer Document version

setVersionType() публичный Метод

Sets the version_type of a document Default in ES is internal, but you can set to external to use custom versioning.
public setVersionType ( string $versionType )
$versionType string Document version type

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

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

protected Document,Elastica $_upsert
Результат Document