modules/Reports/Report.php
Classes
\Report
Package:
Parameters
- Children
- \SubpanelFromReports
Properties
$addedColumns= '0'
Default value
0Details- Type
- n/a
$alias_lookup= 'array()'
Default value
array()Details- Type
- n/a
$all_fields= 'array()'
Default value
array()Details- Type
- n/a
$chart_description= ''''
Default value
''Details- Type
- n/a
$chart_group_position= 'array()'
Default value
array()Details- Type
- n/a
$chart_header_row= 'array()'
Default value
array()Details- Type
- n/a
$chart_numerical_position= '0'
Default value
0Details- Type
- n/a
$chart_rows= 'array()'
Default value
array()Details- Type
- n/a
$chart_total_header_row= 'array()'
Default value
array()Details- Type
- n/a
$chart_type= ''vBarF''
Default value
'vBarF'Details- Type
- n/a
$currency_obj= ''
Details
- Type
- n/a
$currency_symbol= ''
Details
- Type
- n/a
$current_summary_row_count= '0'
Default value
0Details- Type
- n/a
$default_report_def_str= ''{"report_type":"tabular","display_columns":[],"summary_columns":[],"order_by":[{"name":"","sort_dir":""}],"filters_def":[],"group_defs":[],"links_def":[],"module":"Accounts","chart_type":"hBarF","chart_description":""}''
Default value
'{"report_type":"tabular","display_columns":[],"summary_columns":[],"order_by":[{"name":"","sort_dir":""}],"filters_def":[],"group_defs":[],"links_def":[],"module":"Accounts","chart_type":"hBarF","chart_description":""}'Details- Type
- n/a
$do_chart= 'true'
Default value
trueDetails- Type
- n/a
$do_export= 'false'
Default value
falseDetails- Type
- n/a
$enable_paging= 'true'
Default value
trueDetails- Type
- n/a
$focus= ''
Details
- Type
- n/a
$full_table_beans= 'array()'
Default value
array()Details- Type
- n/a
$full_table_list= 'array()'
Default value
array()Details- Type
- n/a
$group_by= ''
Details
- Type
- n/a
$group_column_is_invisible= '0'
Default value
0Details- Type
- n/a
$group_defs_Info= 'array()'
Default value
array()Details- Type
- n/a
$group_fields_map= 'array()'
Default value
array()Details- Type
- n/a
$group_header= ''
Details
- Type
- n/a
$group_order_by= ''''
Default value
''Details- Type
- n/a
array
$invalid_fields= 'array()'
Array of invalid report fields. Populated during is_definition_valid() call.
Default value
array()Details- Type
- array
$is_saved_report= 'false'
Default value
falseDetails- Type
- n/a
$jtcount= '0'
Default value
0Details- Type
- n/a
$layout_manager= 'null'
Default value
nullDetails- Type
- n/a
$loaded_links= 'array()'
Default value
array()Details- Type
- n/a
$module= ''Accounts''
Default value
'Accounts'Details- Type
- n/a
$module_dir= ''Reports''
Default value
'Reports'Details- Type
- n/a
$name= ''
Details
- Type
- n/a
$obj_array= 'array()'
Default value
array()Details- Type
- n/a
$order_by= ''
Details
- Type
- n/a
$order_by_arr= 'array()'
Default value
array()Details- Type
- n/a
$order_by_special= ''
Details
- Type
- n/a
$plain_text_output= 'false'
Default value
falseDetails- Type
- n/a
$query= ''''
Default value
''Details- Type
- n/a
$query_list= 'array()'
Default value
array()Details- Type
- n/a
$relationships= 'array()'
Default value
array()Details- Type
- n/a
$report_def= 'array()'
Default value
array()Details- Type
- n/a
$report_type= ''tabular''
Default value
'tabular'Details- Type
- n/a
$requested_fields_map= 'array()'
Default value
array()Details- Type
- n/a
$result= ''
Details
- Type
- n/a
$row_count= '0'
Default value
0Details- Type
- n/a
$row_end= '0'
Default value
0Details- Type
- n/a
$row_start= '0'
Default value
0Details- Type
- n/a
$saved_report= 'null'
Default value
nullDetails- Type
- n/a
$saved_report_id= ''''
Default value
''Details- Type
- n/a
$select_already_defined_hash= 'array()'
Default value
array()Details- Type
- n/a
$select_fields= 'array()'
Default value
array()Details- Type
- n/a
$selected_loaded_custom_links= 'array()'
Default value
array()Details- Type
- n/a
$selected_loaded_links= 'array()'
Default value
array()Details- Type
- n/a
$show_columns= 'false'
Default value
falseDetails- Type
- n/a
$summary_fields_map= 'array()'
Default value
array()Details- Type
- n/a
$summary_order_by_arr= 'array()'
Default value
array()Details- Type
- n/a
$summary_query= ''''
Default value
''Details- Type
- n/a
$summary_result= ''
Details
- Type
- n/a
$summary_row_count= '0'
Default value
0Details- Type
- n/a
$summary_row_end= '0'
Default value
0Details- Type
- n/a
$summary_row_start= '0'
Default value
0Details- Type
- n/a
$summary_select_fields= 'array()'
Default value
array()Details- Type
- n/a
$table_name= ''saved_reports''
Default value
'saved_reports'Details- Type
- n/a
$time_date_obj= 'null'
Default value
nullDetails- Type
- n/a
$total_query= ''''
Default value
''Details- Type
- n/a
$total_result= ''
Details
- Type
- n/a
$total_select_fields= 'array()'
Default value
array()Details- Type
- n/a
$upgrade_lookup= 'array()'
Default value
array()Details- Type
- n/a
$where= ''
Details
- Type
- n/a
Methods
Report(
$report_def_str
=
'', $filters_def_str
=
'', $panels_def_str
=
''
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $report_def_str | ||
| $filters_def_str | ||
| $panels_def_str |
_check_user_permissions(
)
:
void_get_full_key(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
_load_all_fields(
)
:
void_load_currency(
)
:
voidcache_modules_def_js(
)
:
void
cleanLabels(
)
:
voidEnsure that report labels do not have HTML inside
clean_report_def(
)
:
voidclear_group_by(
)
:
voidclear_results(
)
:
voidcreateFilterStringForUI(
)
:
voidcreate_from(
)
:
voidcreate_group_by(
$register_group_by
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $register_group_by |
create_order_by(
)
:
voidcreate_query(
$query_name
=
'query', $field_list_name
=
'select_fields'
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $query_name | ||
| $field_list_name |
create_select(
$key
=
'display_columns', $field_list_name
=
'select_fields'
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $key | ||
| $field_list_name |
create_summary_query(
)
:
voidcreate_summary_select(
)
:
voidcreate_total_query(
)
:
voidcreate_total_select(
)
:
voidcreate_where(
)
:
voidexecute_count_query(
$query_name
=
'query'
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $query_name |
execute_query(
$query_name
=
'query', $result_name
=
'result', $row_count_name
=
'row_count', $row_start_name
=
'row_start', $row_end_name
=
'row_end', $limit
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $query_name | ||
| $result_name | ||
| $row_count_name | ||
| $row_start_name | ||
| $row_end_name | ||
| $limit |
execute_summary_query(
)
:
voidexecute_total_query(
)
:
voidfiltersIterate(
$filters, $where_clause
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filters | ||
| $where_clause |
filtersIterateForUI(
$filters, $verdef_arr_for_filters
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filters | ||
| $verdef_arr_for_filters |
fixReportDefs(
)
:
voidBug #52757 Tries to find missed relations and removes them from full_table_list
getColumnFieldName(
array $display_column
)
:
stringGet data field name for the display column
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $display_column | array |
| Type | Description |
|---|---|
| string |
getDataTypeForColumnsForMatrix(
$column_field_name
=
'summary_columns'
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $column_field_name |
getExt2FieldDefSelectPiece(
\$field_def $field_def, \$add_alias $add_alias
=
true
)
:
voidgetExt2FieldDefSelectPiece
This is a private helper function to separate a piece of code that creates the select statement for a field where there is an aggregation of columns
| Name | Type | Description |
|---|---|---|
| $field_def | \$field_def | Array representing the field definition to build the select piece for |
| $add_alias | \$add_alias | boolean true to add the column alias, false otherwise (you would want false for group by) |
getFieldDefFromLayoutDef(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
getModules(
$report_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $report_def |
getRelatedAliasName(
$linked_field
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $linked_field |
getRelatedLinkAliasName(
$linked_field
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $linked_field |
getTableFromField(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
getTruncatedColumnAlias(
$column_name
)
:
voidgetTruncatedColumnAlias This function ensures that a column alias is no more than 28 characters. Shoulud the column_name argument exceed 28 charcters, it creates an alias using the first 22 characters of the column_name plus an md5 of the first 6 characters of the lowercased column_name value.
Parameters
| Name | Type | Description |
|---|---|---|
| $column_name |
get_header_row(
$column_field_name
=
'display_columns', $skip_non_group
=
false, $exporting
=
false, $force_distinct
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $column_field_name | ||
| $skip_non_group | ||
| $exporting | ||
| $force_distinct |
get_header_row_generic(
$column_field_name
=
'display_columns', $skip_non_group
=
false, $exporting
=
false, $force_distinct
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $column_field_name | ||
| $skip_non_group | ||
| $exporting | ||
| $force_distinct |
get_invalid_fields(
)
:
arrayGet report invalid fields.
Returns
| Type | Description |
|---|---|
| array |
get_next_child_row(
$result_name
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $result_name |
get_next_row(
$result_field_name
=
'result', $column_field_name
=
'display_columns', $skip_non_summary_columns
=
false, $exporting
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $result_field_name | ||
| $column_field_name | ||
| $skip_non_summary_columns | ||
| $exporting |
get_summary_header_row(
)
:
voidget_summary_next_row(
)
:
voidget_summary_total_row(
$exporting
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $exporting |
get_total_header_row(
$exporting
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $exporting |
has_summary_columns(
)
:
voidisVisibleModule(
$related_module
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $related_module |
is_definition_valid(
)
:
boolWhether the report definition is valid (currently only column definitions are considered).
Returns
| Type | Description |
|---|---|
| bool |
is_group_column(
$display_column
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $display_column |
is_layout_def_valid(
array $layout_def
)
:
boolWhether specified layout definition is valid.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $layout_def | array |
| Type | Description |
|---|---|
| bool |
is_old_content(
$content
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $content |
parseLinkedField(
$fieldname
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $fieldname |
parseUIFiltersDef(
$filters_def_str, $panels_def_str
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filters_def_str | ||
| $panels_def_str |
register_field_for_query(
$layout_def
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $layout_def |
run_chart_queries(
)
:
voidrun_query(
$do_group_by
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $do_group_by |
run_summary_child_query(
)
:
voidrun_summary_combo_query(
$run_main_query
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $run_main_query |
run_summary_query(
)
:
voidrun_total_query(
)
:
voidsave(
$report_name
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $report_name |
select_already_defined(
$select, $which
=
'select_fields'
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $select | ||
| $which |
wrapIfNull(
$field
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $field |