interface RecordSearchInterface (View source)

The search page's record half: matching records with their zone owner, paged and sorted, and the unpaged match count. Rows carry disabled as a bool.

Methods

array
searchRecords(array $parameters, string $permissionView, int|null $userId, string $sortBy, string $sortDirection, bool $groupRecords, int $rowAmount, bool $includeComments, int $page)

No description

int
getTotalRecords(array $parameters, string $permissionView, int|null $userId, bool $groupRecords)

No description

bool
commentMatchesTruncated()

Whether the last searchRecords() call dropped comment matches because it hit the per-search zone cap.

Details

array searchRecords(array $parameters, string $permissionView, int|null $userId, string $sortBy, string $sortDirection, bool $groupRecords, int $rowAmount, bool $includeComments, int $page)

No description

Parameters

array $parameters

query, zones, records, comments, wildcard, reverse, type_filter, content_filter

string $permissionView

'all', or 'own' to limit to zones $userId owns

int|null $userId

The user an 'own' view is limited to; null matches nothing

string $sortBy
string $sortDirection
bool $groupRecords

Collapse rows with the same name and content

int $rowAmount
bool $includeComments

Add the record comment to each row

int $page

Return Value

array

int getTotalRecords(array $parameters, string $permissionView, int|null $userId, bool $groupRecords)

No description

Parameters

array $parameters
string $permissionView
int|null $userId
bool $groupRecords

Return Value

int

bool commentMatchesTruncated()

Whether the last searchRecords() call dropped comment matches because it hit the per-search zone cap.

Return Value

bool