class RegistryPageController extends PageController (View source)

Properties

static private bool $output_headers

Whether to output headers when sending the export file. This can be disabled for example in unit tests.

Methods

string
AllQueryVars()

Get all search query vars, compiled into a query string for a URL.

string
QueryLink()

Get all search query vars except Sort and Dir, compiled into a query link.

Sort()

No description

string
OppositeDirection()

Return the opposite direction from the currently sorted column's direction.

RegistryFilterForm()

No description

array
doRegistryFilter(array $data, $form, $request)

Build up search filters from user's search criteria and hand off to the {@link query()} method to search against the database.

doRegistryFilterReset($data, $form, $request)

No description

RegistryEntries($paginated = true)

No description

bool
canSortBy(string $property)

Loosely check if the record can be sorted by a property

Columns(int $id = null)

Format a set of columns, used for headings and row data

export($request)

Exports out all the data for the current search results.

show($request)

No description

getTemplateList($action)

No description

string
getClassNameForUrl($className)

Sanitise a PHP class name for display in URLs etc

Details

string AllQueryVars()

Get all search query vars, compiled into a query string for a URL.

This will escape all the variables to avoid XSS.

Return Value

string

Get all search query vars except Sort and Dir, compiled into a query link.

This will escape all the variables to avoid XSS.

Return Value

string

Sort()

string OppositeDirection()

Return the opposite direction from the currently sorted column's direction.

Return Value

string

RegistryFilterForm()

array doRegistryFilter(array $data, $form, $request)

Build up search filters from user's search criteria and hand off to the {@link query()} method to search against the database.

Parameters

array $data

Form request data

$form
$request

Return Value

array

doRegistryFilterReset($data, $form, $request)

Parameters

$data
$form
$request

RegistryEntries($paginated = true)

Parameters

$paginated

bool canSortBy(string $property)

Loosely check if the record can be sorted by a property

Parameters

string $property

Return Value

bool

ArrayList Columns(int $id = null)

Format a set of columns, used for headings and row data

Parameters

int $id

The result ID to reference

Return Value

ArrayList

Exceptions

RegistryException

If parameters are used in column names

export($request)

Exports out all the data for the current search results.

Sends the data to the browser as a CSV file.

Parameters

$request

show($request)

Parameters

$request

getTemplateList($action)

Parameters

$action

string getClassNameForUrl($className)

Sanitise a PHP class name for display in URLs etc

Parameters

$className

Return Value

string