OpenPSA API Documentation
API Documentation
Packages
Default
fi
midcom
midgard
net
no
org
Charts
Class hierarchy diagram
Reports
Errors
3909
Markers
todo
374
fixme
51
Deprecated elements
3
Back to top
Javascript is disabled; several features are only available if Javascript is enabled.
Public
Protected
Private
Inherited
Methods
__construct
(
$source
,
$datatype
)
add_order
(
string
$field
,
string
$direction
)
Adds an initial order to the resultset.
count_rows
(
)
get_column_total
(
$column
)
get_grid
(
$identifier
)
get_query
(
)
returns the query (uncached)
get_rows
(
)
render
(
)
set_grid
(
\org_openpsa_widgets_grid
$grid
)
set_query
(
\midcom_core_query
$query
)
set_rows
(
array
$rows
)
setup_grid
(
)
» Private
_convert_to_localdata
(
)
_get_grid_option
(
$key
,
$default
)
_get_rows
(
)
_parse_query
(
array
$query
)
_prepare_query
(
)
_render_json
(
)
Properties
» Private
\org_openpsa_widgets_grid_provider_client
$_client
The class responsible for getting and formatting rows
string
$_datatype
The datatype we're working with
\org_openpsa_widgets_grid
$_grid
The grid we're working with
int
$_offset
The current offset
\midcom_core_query
$_query
The midcom query object
int
$_results_per_page
How many items should be shown per page
array
$_rows
The rows to show
string
$_sort_direction
The direction for sorting (ASC or DESC)
string
$_sort_field
The field for sorting
int
$_total_rows
The total number of rows
\
global
\
org_openpsa_widgets_grid_provider
Manager for retrieving grid data by AJAX
package
org.openpsa.widgets
Methods
__construct
(
$source
,
$datatype
)
Parameters
$source
$datatype
add_order
(
string
$field
,
string
$direction
)
Adds an initial order to the resultset.
This can be overwritten by GET parameters
Parameters
$field
string
The column name
$direction
string
The sort direction
count_rows
(
)
get_column_total
(
$column
)
Parameters
$column
get_grid
(
$identifier
)
Parameters
$identifier
get_query
(
)
returns the query (uncached)
get_rows
(
)
render
(
)
set_grid
(
\org_openpsa_widgets_grid
$grid
)
Parameters
$grid
set_query
(
\midcom_core_query
$query
)
Parameters
$query
set_rows
(
array
$rows
)
Parameters
$rows
setup_grid
(
)
_convert_to_localdata
(
)
_get_grid_option
(
$key
,
$default
)
Parameters
$key
$default
_get_rows
(
)
_parse_query
(
array
$query
)
Parameters
$query
_prepare_query
(
)
_render_json
(
)
Properties
\org_openpsa_widgets_grid_provider_client
$_client
The class responsible for getting and formatting rows
string
$_datatype
The datatype we're working with
\org_openpsa_widgets_grid
$_grid
The grid we're working with
int
$_offset
The current offset
\midcom_core_query
$_query
The midcom query object
int
$_results_per_page
How many items should be shown per page
array
$_rows
The rows to show
string
$_sort_direction
The direction for sorting (ASC or DESC)
string
$_sort_field
The field for sorting
int
$_total_rows
The total number of rows