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

Details

__construct(IndexingDriverInterface $indexDriver)

AbstractIndex constructor.

Parameters

IndexingDriverInterface $indexDriver

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

protected IndexingDriverInterface getIndexer()

No description