include/SugarSearchEngine/Elastic/Elastica/Document.php

Show:

inherited

Classes
- \Elastica_Document

Table of Contents

Single document stored in elastic search

Author: Nicolas Ruflin
Category: Xodoa
Package: Elastica

\Elastica_Document
jump to top

Package: Elastica

Single document stored in elastic search

Author: Nicolas Ruflin
Category: Xodoa

Properties

array
                 $_data= 'array()'

Document data

Default valuearray()Details

Type: array

string|int
                 $_id= ''''

Document id

Default value''Details

Type: string | int


                 $_index= ''''

Default value''Details

Type: n/a

string
                 $_optype= ''''

Optype

Default value''Details

Type: string

string|int
                 $_parent= ''''

Parent document id

Default value''Details

Type: string | int

string
                 $_percolate= ''''

Percolate

Default value''Details

Type: string


                 $_type= ''''

Default value''Details

Type: n/a


                 $_version= ''''

Default value''Details

Type: n/a

Methods

__construct(
          int $id
              =
              '', array $data
              =
              array(), string $type
              =
              '', string $index
              =
              ''
          )
        
        :
          void

Creates a new document

Parameters

Name	Type	Description
$id	int	OPTIONAL $id Id is create if empty
$data	array	OPTIONAL Data array
$type	string	OPTIONAL Type name
$index	string	OPTIONAL Index name

add(
          string $key, mixed $value
          )
        
        :
          \Elastica_Document

Adds the given key/value pair to the document

Parameters

Name	Type	Description
$key	string	Document entry key
$value	mixed	Document entry value

Returns

Type	Description
\Elastica_Document

addFile(
          string $key, string $filepath, string $mimeType
              =
              ''
          )
        
        :
          \Elastica_Document

Adds a file to the index

To use this feature you have to call the following command in the elasticsearch directory:

./bin/plugin install mapper-attachments

This installs the tika file analysis plugin. More infos about supported formats can be found here: {@link http://tika.apache.org/0.7/formats.html}

Parameters

Name	Type	Description
$key	string	Key to add the file to
$filepath	string	Path to add the file
$mimeType	string	OPTIONAL Header mime type

Returns

Type	Description
\Elastica_Document

addFileContent(
          string $key, string $content
          )
        
        :
          \Elastica_Document

Parameters

Name	Type	Description
$key	string	Document key
$content	string	Raw file content

Returns

Type	Description
\Elastica_Document

addGeoPoint(
          string $key, float $latitude, float $longitude
          )
        
        :
          \Elastica_Document

Adds a geopoint to the document

Geohashes re not yet supported

Parameters

Name	Type	Description
$key	string	Field key
$latitude	float	Latitud value
$longitude	float	Longitude value

Returns

Type	Description
\Elastica_Document

Details

Link: http://www.elasticsearch.com/docs/elasticsearch/mapping/geo_point/

getData(
          
          )
        
        :
          array

Returns the document data

Returns

Type	Description
array	Document data

getId(
          
          )
        
        :
          string | int

Returns document id

Returns

Type	Description
string \| int	Document id

getIndex(
          
          )
        
        :
          string

Returns

Type	Description
string	Index name

Throws

Exception	Description
\Elastica_Exception_Invalid

getOpType(
          
          )
        
        :
          void

Get operation type

getParent(
          
          )
        
        :
          string | int

Returns the parent document id

Returns

Type	Description
string \| int	Parent document id

getPercolate(
          
          )
        
        :
          string

Get percolate parameter

Returns

Type	Description
string

getType(
          
          )
        
        :
          string

Returns

Type	Description
string	Document type name

Throws

Exception	Description
\Elastica_Exception_Invalid

getVersion(
          
          )
        
        :
          string | int

Returns document version

Returns

Type	Description
string \| int	Document version

setData(
          array $data
          )
        
        :
          \Elastica_Document

Overwrites the curent document data with the given data

Parameters

Name	Type	Description
$data	array	Data array

Returns

Type	Description
\Elastica_Document

setIndex(
          string $index
          )
        
        :
          \Elastica_Document

Sets the document index name

Parameters

Name	Type	Description
$index	string	Index name

Returns

Type	Description
\Elastica_Document	Current object

setOpType(
          string $optype
          )
        
        :
          \Elastica_Document

Set operation type

Parameters

Name	Type	Description
$optype	string	Only accept create

Returns

Type	Description
\Elastica_Document	Current object

setParent(
          string | int $parent
          )
        
        :
          \Elastica_Document

Sets parent document id

Parameters

Name	Type	Description
$parent	string \| int	Parent document id

Returns

Type	Description
\Elastica_Document	Current object

Details

Link: http://www.elasticsearch.org/guide/reference/mapping/parent-field.html

setPercolate(
          string $value
              =
              '*'
          )
        
        :
          \Elastica_Document

Set percolate query param

Parameters

Name	Type	Description
$value	string	percolator filter

Returns

Type	Description
\Elastica_Document

setTTL(
          string $ttl
          )
        
        :
          \Elastica_Document

Sets lifetime of document

Parameters

Name	Type	Description
$ttl	string

Returns

Type	Description
\Elastica_Document

setType(
          string $type
          )
        
        :
          \Elastica_Document

Sets the document type name

Parameters

Name	Type	Description
$type	string	Type name

Returns

Type	Description
\Elastica_Document	Current object

setVersion(
          int $version
          )
        
        :
          \Elastica_Document

Sets the version of a document for use with optimistic concurrency control

Parameters

Name	Type	Description
$version	int	Document version

Returns

Type	Description
\Elastica_Document	Current object

Details

Link: http://www.elasticsearch.org/blog/2011/02/08/versioning.html

toArray(
          
          )
        
        :
          array

Returns the document as an array

Returns

Type	Description
array

include/SugarSearchEngine/Elastic/Elastica/Document.php

\Elastica_Documentjump to top

Properties

Methods

\Elastica_Document
jump to top