API Documentation
\
Everyman
Neo4j
Batch
Cache
Command
Batch
Cypher
Geoff
Gremlin
Index
Query

\Everyman\Neo4j\CommandSearchIndex

Search for entities in an index

Summary

Methods
Properties
Constants
__construct()
execute()
No public properties found
No constants found
getData()
getMethod()
getPath()
handleResult()
getEntityCache()
getEntityMapper()
getTransport()
throwException()
$client
$index
$key
$value
N/A
No private methods found
No private properties found
N/A

Properties

$client

$client :

Type

$index

$index :

Type

$key

$key :

Type

$value

$value :

Type

Methods

__construct()

__construct(\Everyman\Neo4j\Client $client, \Everyman\Neo4j\Index $index, string $key, string $value)

Set the index to drive the command

Parameters

\Everyman\Neo4j\Client $client
\Everyman\Neo4j\Index $index
string $key
string $value

execute()

execute() : mixed

Run the command and return a value signalling the result

Throws

\Everyman\Neo4j\Exception

on failure

Returns

mixed

getData()

getData() : mixed

Return the data to pass

Returns

mixed

getMethod()

getMethod() : string

Return the transport method to call

Returns

string

getPath()

getPath() : string

Return the path to use

Returns

string

handleResult()

handleResult(integer $code, array $headers, array $data) : integer

Use the results

Parameters

integer $code
array $headers
array $data

Returns

integer —

on failure

throwException()

throwException(string $message, integer $code, array $headers, array $data)

Throw an exception from handling the results

Parameters

string $message
integer $code
array $headers
array $data

Throws

\Everyman\Neo4j\Exception