1. interface
  2. Concrete
  3. \
  4. Core
  5. \
  6. Search
  7. \
  8. Index
  9. \
  10. IndexInterface

IndexInterface

interface IndexInterface implements IndexingDriverInterface (View source)

Interface IndexInterface

Methods

bool
index(mixed $object)

Add an object to the index

from  IndexingDriverInterface
bool
forget(mixed $object)

Remove an object from the index

from  IndexingDriverInterface
void
clear()

Clear out all indexed items

Details

in IndexingDriverInterface at line 13
bool index(mixed $object)

Add an object to the index

Parameters

mixed $object

Object to index

Return Value

bool

Success or fail

in IndexingDriverInterface at line 20
bool forget(mixed $object)

Remove an object from the index

Parameters

mixed $object

Object to forget

Return Value

bool

Success or fail

at line 18
void clear()

Clear out all indexed items

Return Value

void