interface IndexInterface implements IndexingDriverInterface (View source)

Interface IndexInterface

Methods

bool
index(mixed $object)

Add an object to the index

bool
forget(mixed $object)

Remove an object from the index

void
clear()

Clear out all indexed items

Details

bool index(mixed $object)

Add an object to the index

Parameters

mixed $object

Object to index

Return Value

bool

Success or fail

bool forget(mixed $object)

Remove an object from the index

Parameters

mixed $object

Object to forget

Return Value

bool

Success or fail

void clear()

Clear out all indexed items

Return Value

void