\Everyman\Neo4j\IndexNodeFulltextIndex

Represents a fulltext node index in the database

Summary

Methods
Properties
Constants
__construct()
add()
delete()
find()
findOne()
getConfig()
getName()
getType()
query()
queryOne()
remove()
save()
No public properties found
TypeNode
TypeRelationship
No protected methods found
$client
$type
$name
$config
N/A
No private methods found
No private properties found
N/A

Constants

TypeNode

TypeNode

TypeRelationship

TypeRelationship

Properties

$client

$client : 

Type

$type

$type : 

Type

$name

$name : 

Type

$config

$config : 

Type

Methods

__construct()

__construct(\Everyman\Neo4j\Client $client, string $name, array $config)

Initialize the index

Parameters

\Everyman\Neo4j\Client $client
string $name
array $config

add()

add(\Everyman\Neo4j\PropertyContainer $entity, string $key, string $value) : boolean

Add an entity to the index

Parameters

\Everyman\Neo4j\PropertyContainer $entity
string $key
string $value

Returns

boolean

delete()

delete() : boolean

Delete this index

Returns

boolean

find()

find(string $key, string $value) : array

Find entities

Parameters

string $key
string $value

Returns

array

findOne()

findOne(string $key, string $value) : \Everyman\Neo4j\PropertyContainer

Find a single entity

Parameters

string $key
string $value

Returns

\Everyman\Neo4j\PropertyContainer

getConfig()

getConfig() : array

Get the configuration options for this index

Configuration options are only used during index creation, see save

Returns

array

getName()

getName() : string

Get the index name

Returns

string

getType()

getType() : string

Get the index type

Returns

string

query()

query(string $query) : array

Query index to find entities

Parameters

string $query

Returns

array

queryOne()

queryOne(string $query) : \Everyman\Neo4j\PropertyContainer

Query index to find a single entity

Parameters

string $query

Returns

\Everyman\Neo4j\PropertyContainer

remove()

remove(\Everyman\Neo4j\PropertyContainer $entity, string $key, string $value) : boolean

Remove an entity from the index If $value is not given, all reference of the entity for the key are removed.

If $key is not given, all reference of the entity are removed.

Parameters

\Everyman\Neo4j\PropertyContainer $entity
string $key
string $value

Returns

boolean

save()

save() : boolean

Save this index

Returns

boolean