trait SearchContentTrait (View source)

Helpful search methods

Methods

bool
applyQueryFilters(Runner $report, QueryBuilder|QueryBuilder $query, bool $having = true, string $filterColumn = 'content')

Take a query object and add "or having" or "and having" for each filter on the Report This object gives us one place to implement new types of filters added to the Report class

iterable
iterateQuery($query, int $perPage = 1000)

Take a query and paginate over it in chunks defined by $perPage You can iterate over the return value and expect to receive all rows one by one.

auditDbal(Runner $report, string $table, string $idSelect, array $scanColumns, array $joins, callable $findingPopulator)

Audit a dbal table or set of tables

addBlockWarning(Runner $report, Block $block, string $content = '')

No description

Details

protected bool applyQueryFilters(Runner $report, QueryBuilder|QueryBuilder $query, bool $having = true, string $filterColumn = 'content')

Take a query object and add "or having" or "and having" for each filter on the Report This object gives us one place to implement new types of filters added to the Report class

Parameters

Runner $report
QueryBuilder|QueryBuilder $query
bool $having
string $filterColumn

Return Value

bool

protected iterable iterateQuery($query, int $perPage = 1000)

Take a query and paginate over it in chunks defined by $perPage You can iterate over the return value and expect to receive all rows one by one.

Parameters

$query
int $perPage

Return Value

iterable

protected auditDbal(Runner $report, string $table, string $idSelect, array $scanColumns, array $joins, callable $findingPopulator)

Audit a dbal table or set of tables

Parameters

Runner $report
string $table
string $idSelect
array $scanColumns
array $joins

[[$joinTable, $fromTable, $alias, $criteria]]

callable $findingPopulator

function($item, $report)

protected addBlockWarning(Runner $report, Block $block, string $content = '')

No description

Parameters

Runner $report
Block $block
string $content