class PageIndex extends AbstractIndex implements ApplicationAwareInterface (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected IndexingDriverInterface $indexDriver from AbstractIndex
protected Application $app from ApplicationAwareTrait

Methods

__construct()

PageIndex constructor.

bool
index(mixed $object)

Add an object to the index

bool
forget(mixed $object)

Remove an object from the index

setApplication(Application $app)

Setter method for the application

void
clear()

Clear out all indexed items

Details

__construct()

PageIndex constructor.

Doesn't require any constructor arguments

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()

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

void clear()

Clear out all indexed items

Return Value

void