_getRefineClause() function - Documentation for SproutCMS

function _getRefineClause()

Return the WHERE clause to use for a given key which is provided by the RefineBar

Allows custom non-table clauses to be added.
Is only called for key names which begin with an underscore.
The base table is aliased to 'item'.

File: /sprout/Controllers/Admin/HasCategoriesAdminController.php, line 237
Namespace: Sprout\Controllers\Admin
Class: HasCategoriesAdminController

Usage

string $HasCategoriesAdminController->_getRefineClause ( string $key , string $val , array &$query_params );

Arguments

string $key
```
The key name, including underscore
```
string $val
```
The value which is being refined.
```

array $query_params (by reference)

&$query_params Parameters to add to the query which will use the WHERE clause

Return value

string

WHERE clause, e.g. "item.name LIKE CONCAT('%', ?, '%')", "item.status IN (?, ?, ?)"