Properties

$_rows

$_rows : array

The rows to show

Type

array

$_total_rows

$_total_rows : integer

The total number of rows

Type

integer

$_results_per_page

$_results_per_page : integer

How many items should be shown per page

Type

integer

$_offset

$_offset : integer

The current offset

Type

integer

$_sort_field

$_sort_field : string

The field for sorting

Type

string

$_sort_direction

$_sort_direction : string

The direction for sorting (ASC or DESC)

Type

string

$_grid

$_grid : \midcom\grid\grid

The grid we're working with

Type

\midcom\grid\grid

$_datatype

$_datatype : string

The datatype we're working with

Type

string

$_search

$_search : array

Search parameters

Type

array

Methods

__construct()

__construct(  $source,   $datatype = 'json') 

Parameters

$source
$datatype

add_order()

add_order(string  $field, string  $direction = 'ASC') 

Adds an initial order to the resultset.

This can be overwritten by GET parameters

Parameters

string $field

The column name

string $direction

The sort direction

get_grid()

get_grid(  $identifier = null) 

Parameters

$identifier

set_rows()

set_rows(array  $rows) 

Parameters

array $rows

get_rows()

get_rows() 

get_query()

get_query() 

returns the query (uncached)

count_rows()

count_rows() 

get_column_total()

get_column_total(  $column) 

Parameters

$column

setup_grid()

setup_grid() 

render()

render() 

_get_grid_option()

_get_grid_option(  $key,   $default = null) 

Parameters

$key
$default

_convert_to_localdata()

_convert_to_localdata() 

_render_json()

_render_json() 

_parse_query()

_parse_query(array  $query) 

Parameters

array $query

_prepare_query()

_prepare_query() 

_get_rows()

_get_rows()