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

AbstractIndex

abstract class AbstractIndex implements IndexInterface (View source)

Pretty much all the Index anyone ever needs.

Properties

protected IndexingDriverInterface $indexDriver

Methods

__construct(IndexingDriverInterface $indexDriver)

AbstractIndex constructor.

bool
index(mixed $object)

Add an object to the index

bool
forget(mixed $object)

Remove an object from the index

IndexingDriverInterface
getIndexer()

No description

Details

at line 21
__construct(IndexingDriverInterface $indexDriver)

AbstractIndex constructor.

Parameters

IndexingDriverInterface $indexDriver

at line 31
bool index(mixed $object)

Add an object to the index

Parameters

mixed $object

Object to index

Return Value

bool

Success or fail

at line 41
bool forget(mixed $object)

Remove an object from the index

Parameters

mixed $object

Object to forget

Return Value

bool

Success or fail

at line 49
protected IndexingDriverInterface getIndexer()

No description

Return Value

IndexingDriverInterface