reportbuilder/upgrade.txt

   1 This file describes API changes in /reportbuilder/*
   2 Information provided here is intended especially for developers.
   3
   4 === 4.1.1 ===
   5
   6 * The `datasource_stress_test_columns` test helper now enables sorting on those columns that support it
   7 * The `create_[column|filter|condition]` test generator methods now allow for setting all persistent properties
   8
   9 === 4.1 ===
  10
  11 * New method `add_action_divider()` in base system report class, to allow adding a divider to the action menu.
  12 * New external method `core_reportbuilder_set_filters` for setting report filter values (plus `setFilters` AJAX repository
  13   export for calling from Javascript modules)
  14 * New method `set_filter_form_default` in base system report class, to override whether the default filters form
  15   should be shown for a report
  16 * The external `core_reportbuilder_filters_reset` method now accepts an optional `parameters` argument, required by
  17   some system reports
  18 * New external methods for retrieving custom report data:
  19   - `core_reportbuilder_list_reports`
  20   - `core_reportbuilder_retrieve_report`
  21   - `core_reportbuilder_view_report`
  22 * For consistency, the following entity classes have moved namespace (usage of previous namespace will generate debugging):
  23   - `core_admin\{ => reportbuilder}\local\entities\task_log`
  24   - `core_cohort\{ => reportbuilder}\local\entities\cohort`
  25   - `core_cohort\{ => reportbuilder}\local\entities\cohort_member`
  26   - `core_course\{ => reportbuilder}\local\entities\course_category`
  27   - `report_configlog\{ => reportbuilder}\local\entities\config_change`
  28 * 'set_default_per_page' and 'get_default_per_page' methods have been added to \local\report\base class
  29   to manage the default displayed rows per page.
  30 * Added two new methods in the datasource class:
  31   - add_all_from_entity() to add all columns/filters/conditions from the given entity to the report at once
  32   - add_all_from_entities() to add all columns/filters/conditions from all the entities added to the report at once
  33 * New database helper methods for generating multiple unique values: `generate_aliases` and `generate_param_names`
  34 * The base aggregation `format_value` method has a `$columntype` argument in order to preserve type during aggregation. When
  35   defining column callbacks, strict typing will now be preserved in your callback methods when the column is being aggregated
  36 * The method `get_joins()` in the base entity class is now public, allowing for easier joins within reports
  37 * New method `set_table_aliases` in base entity class, for overriding multiple table aliases in a single call
  38 * The following local helper methods have been deprecated, their implementation moved to exporters:
  39   - `audience::get_all_audiences_menu_types` -> `custom_report_audience_cards_exporter`
  40   - `report::get_available_columns` -> `custom_report_column_cards_exporter`
  41 * The `custom_report_exporter` class now defines its editor element properties as optional, rather than each of those exporters
  42   defining their own properties as optional. In turn, this means the structure of the following external methods will always be
  43   present and consistent:
  44   - `core_reportbuilder_columns_*`
  45   - `core_reportbuilder_conditions_*`
  46   - `core_reportbuilder_filters_*`
  47 * The `custom_report_*` exporters now accept only classes that extend datasource as part of their related data properties
  48 * The following permission methods now accept an optional `$context` parameter (default system context):
  49   - `[require_]can_view_reports_list`
  50   - `[require_]can_create_report`
  51 * New method `get_default_condition_values()` in base datasource class, to be overridden by sources that wish to
  52   define default values for conditions upon report creation.
  53 * New methods `get_identity_[column|filter]` in user entity, for retrieving user identity field report elements
  54 * New method `user_reports_list_access_sql` in audience helper for retrieving list of all reports for given user
  55 * New report filter types:
  56   - `category` for reports containing course categories
  57   - `tags` for reports containing entities with support for core_tag API
  58   - `autocomplete` for reports that contain pre-defined values for selection.
  59 * New method `get_sample_values()` added to base filter class, to be overridden in all filter types to support stress testing
  60 * New test helpers for automated stress testing of report sources:
  61   - `datasource_stress_test_columns`
  62   - `datasource_stress_test_columns_aggregation`
  63   - `datasource_stress_test_conditions`
  64 * The test helper method `get_custom_report_content()` now accepts a list of filter values and applies them to the report
  65 * New method `get_default_column_sorting` in base datasource class, to be overridden by sources that wish to
  66   define default columns sort order upon report creation.