class PageIndexer implements IndexingDriverInterface, ApplicationAwareInterface (View source)

Traits

Trait ApplicationAwareTrait A trait used with ApplicationAwareInterface

Properties

protected Application $app from ApplicationAwareTrait
$search

Methods

setApplication(Application $app)

Setter method for the application

__construct(IndexedSearch $search)

DefaultPageDriver constructor.

bool
index(string|int|Page $page)

Add a page to the index

bool
forget($page)

Remove a page from the index

getPage(string|int|Page|Collection $page)

Get a page based on criteria

Details

setApplication(Application $app)

Setter method for the application

Parameters

Application $app

__construct(IndexedSearch $search)

DefaultPageDriver constructor.

Parameters

IndexedSearch $search

bool index(string|int|Page $page)

Add a page to the index

Parameters

string|int|Page $page Page to index. String is path, int is cID

Return Value

bool Success or fail

bool forget($page)

Remove a page from the index

Parameters

$page

Return Value

bool Success or fail

protected Page getPage(string|int|Page|Collection $page)

Get a page based on criteria

Parameters

string|int|Page|Collection $page

Return Value

Page