modules/Reports/SubpanelFromReports.php

Show:

inherited

Classes
- \SubpanelFromReports

Table of Contents

\SubpanelFromReports
jump to top

Package:

Parent(s): \Report

Properties


                 $addedColumns= '0'

inheritedInherited from: \Report::$$addedColumns

Default value0Details

Type: n/a
Inherited_from: \Report::$$addedColumns


                 $alias_lookup= 'array()'

inheritedInherited from: \Report::$$alias_lookup

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$alias_lookup


                 $all_fields= 'array()'

inheritedInherited from: \Report::$$all_fields

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$all_fields


                 $chart_description= ''''

inheritedInherited from: \Report::$$chart_description

Default value''Details

Type: n/a
Inherited_from: \Report::$$chart_description


                 $chart_group_position= 'array()'

inheritedInherited from: \Report::$$chart_group_position

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$chart_group_position


                 $chart_header_row= 'array()'

inheritedInherited from: \Report::$$chart_header_row

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$chart_header_row


                 $chart_numerical_position= '0'

inheritedInherited from: \Report::$$chart_numerical_position

Default value0Details

Type: n/a
Inherited_from: \Report::$$chart_numerical_position


                 $chart_rows= 'array()'

inheritedInherited from: \Report::$$chart_rows

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$chart_rows


                 $chart_total_header_row= 'array()'

inheritedInherited from: \Report::$$chart_total_header_row

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$chart_total_header_row


                 $chart_type= ''vBarF''

inheritedInherited from: \Report::$$chart_type

Default value'vBarF'Details

Type: n/a
Inherited_from: \Report::$$chart_type


                 $currency_obj= ''

inheritedInherited from: \Report::$$currency_obj

Details

Type: n/a
Inherited_from: \Report::$$currency_obj


                 $currency_symbol= ''

inheritedInherited from: \Report::$$currency_symbol

Details

Type: n/a
Inherited_from: \Report::$$currency_symbol


                 $current_summary_row_count= '0'

inheritedInherited from: \Report::$$current_summary_row_count

Default value0Details

Type: n/a
Inherited_from: \Report::$$current_summary_row_count


                 $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":""}''

inheritedInherited from: \Report::$$default_report_def_str

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
Inherited_from: \Report::$$default_report_def_str


                 $do_chart= 'true'

inheritedInherited from: \Report::$$do_chart

Default valuetrueDetails

Type: n/a
Inherited_from: \Report::$$do_chart


                 $do_export= 'false'

inheritedInherited from: \Report::$$do_export

Default valuefalseDetails

Type: n/a
Inherited_from: \Report::$$do_export


                 $enable_paging= 'true'

inheritedInherited from: \Report::$$enable_paging

Default valuetrueDetails

Type: n/a
Inherited_from: \Report::$$enable_paging


                 $focus= ''

inheritedInherited from: \Report::$$focus

Details

Type: n/a
Inherited_from: \Report::$$focus


                 $full_table_beans= 'array()'

inheritedInherited from: \Report::$$full_table_beans

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$full_table_beans


                 $full_table_list= 'array()'

inheritedInherited from: \Report::$$full_table_list

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$full_table_list


                 $group_by= ''

inheritedInherited from: \Report::$$group_by

Details

Type: n/a
Inherited_from: \Report::$$group_by


                 $group_column_is_invisible= '0'

inheritedInherited from: \Report::$$group_column_is_invisible

Default value0Details

Type: n/a
Inherited_from: \Report::$$group_column_is_invisible


                 $group_defs_Info= 'array()'

inheritedInherited from: \Report::$$group_defs_Info

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$group_defs_Info


                 $group_fields_map= 'array()'

inheritedInherited from: \Report::$$group_fields_map

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$group_fields_map


                 $group_header= ''

inheritedInherited from: \Report::$$group_header

Details

Type: n/a
Inherited_from: \Report::$$group_header


                 $group_order_by= ''''

inheritedInherited from: \Report::$$group_order_by

Default value''Details

Type: n/a
Inherited_from: \Report::$$group_order_by

array
                 $invalid_fields= 'array()'

inherited

Array of invalid report fields. Populated during is_definition_valid() call.

Inherited from: \Report::$$invalid_fields

Default valuearray()Details

Type: array
Inherited_from: \Report::$$invalid_fields


                 $is_saved_report= 'false'

inheritedInherited from: \Report::$$is_saved_report

Default valuefalseDetails

Type: n/a
Inherited_from: \Report::$$is_saved_report


                 $jtcount= '0'

inheritedInherited from: \Report::$$jtcount

Default value0Details

Type: n/a
Inherited_from: \Report::$$jtcount


                 $layout_manager= 'null'

inheritedInherited from: \Report::$$layout_manager

Default valuenullDetails

Type: n/a
Inherited_from: \Report::$$layout_manager


                 $loaded_links= 'array()'

inheritedInherited from: \Report::$$loaded_links

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$loaded_links


                 $module= ''Accounts''

inheritedInherited from: \Report::$$module

Default value'Accounts'Details

Type: n/a
Inherited_from: \Report::$$module


                 $module_dir= ''Reports''

inheritedInherited from: \Report::$$module_dir

Default value'Reports'Details

Type: n/a
Inherited_from: \Report::$$module_dir


                 $name= ''

inheritedInherited from: \Report::$$name

Details

Type: n/a
Inherited_from: \Report::$$name


                 $obj_array= 'array()'

inheritedInherited from: \Report::$$obj_array

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$obj_array


                 $order_by= ''

inheritedInherited from: \Report::$$order_by

Details

Type: n/a
Inherited_from: \Report::$$order_by


                 $order_by_arr= 'array()'

inheritedInherited from: \Report::$$order_by_arr

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$order_by_arr


                 $order_by_special= ''

inheritedInherited from: \Report::$$order_by_special

Details

Type: n/a
Inherited_from: \Report::$$order_by_special


                 $plain_text_output= 'false'

inheritedInherited from: \Report::$$plain_text_output

Default valuefalseDetails

Type: n/a
Inherited_from: \Report::$$plain_text_output


                 $query= ''''

inheritedInherited from: \Report::$$query

Default value''Details

Type: n/a
Inherited_from: \Report::$$query


                 $query_list= 'array()'

inheritedInherited from: \Report::$$query_list

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$query_list


                 $relationships= 'array()'

inheritedInherited from: \Report::$$relationships

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$relationships


                 $report_def= 'array()'

inheritedInherited from: \Report::$$report_def

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$report_def


                 $report_type= ''tabular''

inheritedInherited from: \Report::$$report_type

Default value'tabular'Details

Type: n/a
Inherited_from: \Report::$$report_type


                 $requested_fields_map= 'array()'

inheritedInherited from: \Report::$$requested_fields_map

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$requested_fields_map


                 $result= ''

inheritedInherited from: \Report::$$result

Details

Type: n/a
Inherited_from: \Report::$$result


                 $row_count= '0'

inheritedInherited from: \Report::$$row_count

Default value0Details

Type: n/a
Inherited_from: \Report::$$row_count


                 $row_end= '0'

inheritedInherited from: \Report::$$row_end

Default value0Details

Type: n/a
Inherited_from: \Report::$$row_end


                 $row_start= '0'

inheritedInherited from: \Report::$$row_start

Default value0Details

Type: n/a
Inherited_from: \Report::$$row_start


                 $saved_report= 'null'

inheritedInherited from: \Report::$$saved_report

Default valuenullDetails

Type: n/a
Inherited_from: \Report::$$saved_report


                 $saved_report_id= ''''

inheritedInherited from: \Report::$$saved_report_id

Default value''Details

Type: n/a
Inherited_from: \Report::$$saved_report_id


                 $select_already_defined_hash= 'array()'

inheritedInherited from: \Report::$$select_already_defined_hash

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$select_already_defined_hash


                 $select_fields= 'array()'

inheritedInherited from: \Report::$$select_fields

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$select_fields


                 $selected_loaded_custom_links= 'array()'

inheritedInherited from: \Report::$$selected_loaded_custom_links

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$selected_loaded_custom_links


                 $selected_loaded_links= 'array()'

inheritedInherited from: \Report::$$selected_loaded_links

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$selected_loaded_links


                 $show_columns= 'false'

inheritedInherited from: \Report::$$show_columns

Default valuefalseDetails

Type: n/a
Inherited_from: \Report::$$show_columns


                 $summary_fields_map= 'array()'

inheritedInherited from: \Report::$$summary_fields_map

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$summary_fields_map


                 $summary_order_by_arr= 'array()'

inheritedInherited from: \Report::$$summary_order_by_arr

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$summary_order_by_arr


                 $summary_query= ''''

inheritedInherited from: \Report::$$summary_query

Default value''Details

Type: n/a
Inherited_from: \Report::$$summary_query


                 $summary_result= ''

inheritedInherited from: \Report::$$summary_result

Details

Type: n/a
Inherited_from: \Report::$$summary_result


                 $summary_row_count= '0'

inheritedInherited from: \Report::$$summary_row_count

Default value0Details

Type: n/a
Inherited_from: \Report::$$summary_row_count


                 $summary_row_end= '0'

inheritedInherited from: \Report::$$summary_row_end

Default value0Details

Type: n/a
Inherited_from: \Report::$$summary_row_end


                 $summary_row_start= '0'

inheritedInherited from: \Report::$$summary_row_start

Default value0Details

Type: n/a
Inherited_from: \Report::$$summary_row_start


                 $summary_select_fields= 'array()'

inheritedInherited from: \Report::$$summary_select_fields

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$summary_select_fields


                 $table_name= ''saved_reports''

inheritedInherited from: \Report::$$table_name

Default value'saved_reports'Details

Type: n/a
Inherited_from: \Report::$$table_name


                 $time_date_obj= 'null'

inheritedInherited from: \Report::$$time_date_obj

Default valuenullDetails

Type: n/a
Inherited_from: \Report::$$time_date_obj


                 $total_query= ''''

inheritedInherited from: \Report::$$total_query

Default value''Details

Type: n/a
Inherited_from: \Report::$$total_query


                 $total_result= ''

inheritedInherited from: \Report::$$total_result

Details

Type: n/a
Inherited_from: \Report::$$total_result


                 $total_select_fields= 'array()'

inheritedInherited from: \Report::$$total_select_fields

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$total_select_fields


                 $upgrade_lookup= 'array()'

inheritedInherited from: \Report::$$upgrade_lookup

Default valuearray()Details

Type: n/a
Inherited_from: \Report::$$upgrade_lookup


                 $where= ''

inheritedInherited from: \Report::$$where

Details

Type: n/a
Inherited_from: \Report::$$where

Methods

Report(
           $report_def_str
              =
              '',  $filters_def_str
              =
              '',  $panels_def_str
              =
              ''
          )
        
        :
          void

inherited

Inherited from: \Report::Report()

Parameters

Name	Type	Description
$report_def_str
$filters_def_str
$panels_def_str

__construct(
           $report
          )
        
        :
          void

Parameters

Name	Type	Description
$report

_appendNecessaryColumn(
          
          )
        
        :
          void

Because one self column needed to generate primaryid for subpanel list

_check_user_permissions(
          
          )
        
        :
          void

inherited

Inherited from: \Report::_check_user_permissions()

_get_full_key(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \Report::_get_full_key()

Parameters

Name	Type	Description
$layout_def

_load_all_fields(
          
          )
        
        :
          void

inherited

Inherited from: \Report::_load_all_fields()

_load_currency(
          
          )
        
        :
          void

inherited

Inherited from: \Report::_load_currency()

cache_modules_def_js(
          
          )
        
        :
          void

inherited

Inherited from: \Report::cache_modules_def_js()

cleanLabels(
          
          )
        
        :
          void

inherited

Ensure that report labels do not have HTML inside

Inherited from: \Report::cleanLabels()

clean_report_def(
          
          )
        
        :
          void

inherited

Inherited from: \Report::clean_report_def()

clear_group_by(
          
          )
        
        :
          void

inherited

Inherited from: \Report::clear_group_by()

clear_results(
          
          )
        
        :
          void

inherited

Inherited from: \Report::clear_results()

createFilterStringForUI(
          
          )
        
        :
          void

inherited

Inherited from: \Report::createFilterStringForUI()

create_from(
          
          )
        
        :
          void

inherited

Inherited from: \Report::create_from()

create_group_by(
           $register_group_by
              =
              true
          )
        
        :
          void

inherited

Inherited from: \Report::create_group_by()

Parameters

Name	Type	Description
$register_group_by

create_order_by(
          
          )
        
        :
          void

inherited

Inherited from: \Report::create_order_by()

create_query(
           $query_name
              =
              'query',  $field_list_name
              =
              'select_fields'
          )
        
        :
          void

inherited

Inherited from: \Report::create_query()

Parameters

Name	Type	Description
$query_name
$field_list_name

create_select(
           $key
              =
              'display_columns',  $field_list_name
              =
              'select_fields'
          )
        
        :
          void

inherited

Inherited from: \Report::create_select()

Parameters

Name	Type	Description
$key
$field_list_name

create_summary_query(
          
          )
        
        :
          void

inherited

Inherited from: \Report::create_summary_query()

create_summary_select(
          
          )
        
        :
          void

inherited

Inherited from: \Report::create_summary_select()

create_total_query(
          
          )
        
        :
          void

inherited

Inherited from: \Report::create_total_query()

create_total_select(
          
          )
        
        :
          void

inherited

Inherited from: \Report::create_total_select()

create_where(
          
          )
        
        :
          void

inherited

Inherited from: \Report::create_where()

execute_count_query(
           $query_name
              =
              'query'
          )
        
        :
          void

inherited

Inherited from: \Report::execute_count_query()

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

inherited

Inherited from: \Report::execute_query()

Parameters

Name	Type	Description
$query_name
$result_name
$row_count_name
$row_start_name
$row_end_name
$limit

execute_summary_query(
          
          )
        
        :
          void

inherited

Inherited from: \Report::execute_summary_query()

execute_total_query(
          
          )
        
        :
          void

inherited

Inherited from: \Report::execute_total_query()

filtersIterate(
           $filters,  $where_clause
          )
        
        :
          void

inherited

Inherited from: \Report::filtersIterate()

Parameters

Name	Type	Description
$filters
$where_clause

filtersIterateForUI(
           $filters,  $verdef_arr_for_filters
          )
        
        :
          void

inherited

Inherited from: \Report::filtersIterateForUI()

Parameters

Name	Type	Description
$filters
$verdef_arr_for_filters

fixReportDefs(
          
          )
        
        :
          void

inherited

Bug #52757 Tries to find missed relations and removes them from full_table_list

Inherited from: \Report::fixReportDefs()

getColumnFieldName(
          array $display_column
          )
        
        :
          string

inherited

Get data field name for the display column

Inherited from: \Report::getColumnFieldName()

Parameters

Name	Type	Description
$display_column	array

Returns

Type	Description
string

getDataTypeForColumnsForMatrix(
           $column_field_name
              =
              'summary_columns'
          )
        
        :
          void

inherited

Inherited from: \Report::getDataTypeForColumnsForMatrix()

Parameters

Name	Type	Description
$column_field_name

getExt2FieldDefSelectPiece(
          \$field_def $field_def, \$add_alias $add_alias
              =
              true
          )
        
        :
          void

inherited

getExt2FieldDefSelectPiece

Inherited from: \Report::getExt2FieldDefSelectPiece()

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

Parameters

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

inherited

Inherited from: \Report::getFieldDefFromLayoutDef()

Parameters

Name	Type	Description
$layout_def

getModules(
           $report_def
          )
        
        :
          void

inherited

Inherited from: \Report::getModules()

Parameters

Name	Type	Description
$report_def

getRelatedAliasName(
           $linked_field
          )
        
        :
          void

inherited

Inherited from: \Report::getRelatedAliasName()

Parameters

Name	Type	Description
$linked_field

getRelatedLinkAliasName(
           $linked_field
          )
        
        :
          void

inherited

Inherited from: \Report::getRelatedLinkAliasName()

Parameters

Name	Type	Description
$linked_field

getTableFromField(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \Report::getTableFromField()

Parameters

Name	Type	Description
$layout_def

getTruncatedColumnAlias(
           $column_name
          )
        
        :
          void

inherited

getTruncatedColumnAlias 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.

Inherited from: \Report::getTruncatedColumnAlias()

Parameters

Name	Type	Description
$column_name

get_header_row(
           $column_field_name
              =
              'display_columns',  $skip_non_group
              =
              false,  $exporting
              =
              false,  $force_distinct
              =
              false
          )
        
        :
          void

inherited

Inherited from: \Report::get_header_row()

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

inherited

Inherited from: \Report::get_header_row_generic()

Parameters

Name	Type	Description
$column_field_name
$skip_non_group
$exporting
$force_distinct

get_invalid_fields(
          
          )
        
        :
          array

inherited

Get report invalid fields.

Inherited from: \Report::get_invalid_fields()

Returns

Type	Description
array

get_next_child_row(
           $result_name
          )
        
        :
          void

inherited

Inherited from: \Report::get_next_child_row()

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

inherited

Inherited from: \Report::get_next_row()

Parameters

Name	Type	Description
$result_field_name
$column_field_name
$skip_non_summary_columns
$exporting

get_summary_header_row(
          
          )
        
        :
          void

inherited

Inherited from: \Report::get_summary_header_row()

get_summary_next_row(
          
          )
        
        :
          void

inherited

Inherited from: \Report::get_summary_next_row()

get_summary_total_row(
           $exporting
              =
              false
          )
        
        :
          void

inherited

Inherited from: \Report::get_summary_total_row()

Parameters

Name	Type	Description
$exporting

get_total_header_row(
           $exporting
              =
              false
          )
        
        :
          void

inherited

Inherited from: \Report::get_total_header_row()

Parameters

Name	Type	Description
$exporting

has_summary_columns(
          
          )
        
        :
          void

inherited

Inherited from: \Report::has_summary_columns()

isVisibleModule(
           $related_module
          )
        
        :
          void

inherited

Inherited from: \Report::isVisibleModule()

Parameters

Name	Type	Description
$related_module

is_definition_valid(
          
          )
        
        :
          bool

inherited

Whether the report definition is valid (currently only column definitions are considered).

Inherited from: \Report::is_definition_valid()

Returns

Type	Description
bool

is_group_column(
           $display_column
          )
        
        :
          void

inherited

Inherited from: \Report::is_group_column()

Parameters

Name	Type	Description
$display_column

is_layout_def_valid(
          array $layout_def
          )
        
        :
          bool

inherited

Whether specified layout definition is valid.

Inherited from: \Report::is_layout_def_valid()

Parameters

Name	Type	Description
$layout_def	array

Returns

Type	Description
bool

is_old_content(
           $content
          )
        
        :
          void

inherited

Inherited from: \Report::is_old_content()

Parameters

Name	Type	Description
$content

parseLinkedField(
           $fieldname
          )
        
        :
          void

inherited

Inherited from: \Report::parseLinkedField()

Parameters

Name	Type	Description
$fieldname

parseUIFiltersDef(
           $filters_def_str,  $panels_def_str
          )
        
        :
          void

inherited

Inherited from: \Report::parseUIFiltersDef()

Parameters

Name	Type	Description
$filters_def_str
$panels_def_str

register_field_for_query(
           $layout_def
          )
        
        :
          void

inherited

Inherited from: \Report::register_field_for_query()

Parameters

Name	Type	Description
$layout_def

run_chart_queries(
          
          )
        
        :
          void

inherited

Inherited from: \Report::run_chart_queries()

run_query(
           $do_group_by
              =
              false
          )
        
        :
          void

inherited

Inherited from: \Report::run_query()

Parameters

Name	Type	Description
$do_group_by

run_summary_child_query(
          
          )
        
        :
          void

inherited

Inherited from: \Report::run_summary_child_query()

run_summary_combo_query(
           $run_main_query
              =
              true
          )
        
        :
          void

inherited

Inherited from: \Report::run_summary_combo_query()

Parameters

Name	Type	Description
$run_main_query

run_summary_query(
          
          )
        
        :
          void

inherited

Inherited from: \Report::run_summary_query()

run_total_query(
          
          )
        
        :
          void

inherited

Inherited from: \Report::run_total_query()

save(
           $report_name
          )
        
        :
          void

inherited

Inherited from: \Report::save()

Parameters

Name	Type	Description
$report_name

select_already_defined(
           $select,  $which
              =
              'select_fields'
          )
        
        :
          void

inherited

Inherited from: \Report::select_already_defined()

Parameters

Name	Type	Description
$select
$which

wrapIfNull(
           $field
          )
        
        :
          void

inherited

Inherited from: \Report::wrapIfNull()

Parameters

Name	Type	Description
$field

modules/Reports/SubpanelFromReports.php

\SubpanelFromReportsjump to top

Properties

Methods

\SubpanelFromReports
jump to top