reportbuilder/upgrade.txt

   1 This file describes API changes in /reportbuilder/*
   2 Information provided here is intended especially for developers.
   3
   4 === 4.4 ===
   5
   6 * New methods `get_identity_[columns|filters]` in user entity, for retrieving all user identity field report elements
   7 * Entity table aliases are now auto-generated, hence usage of the `get_default_table_aliases` method is now deprecated. Instead,
   8   entities should implement the `get_default_tables` method to define the tables they use
   9 * New method `get_table_aliases` in base entity class, for retrieving all table aliases in a single call
  10 * The database helper `generate_alias[es]` and `generate_param_name[s]` methods now accept an optional `$suffix` argument for
  11   appending additional string to the generated value
  12 * The `get_name` method has been moved to the base report class and can now be implemented for both custom and system reports, it
  13   will be used as the caption when rendering tables (which can also be targeted in Behat scenarios)
  14 * The default value for the filename when calling `set_downloadable` is now taken from calling `get_name` on the current report
  15 * The base datasource `add_all_from_entity` method accepts additional parameters to limit which columns, filters and conditions
  16   are added. The `add_[columns|filters|conditions]_from_entity` class methods also now support wildcard matching in both `$include`
  17   and `$exclude` parameters
  18 * New report filter types:
  19   - `cohort` for reports containing cohort data
  20   - `courserole` for reports showing course enrolments
  21   - `filesize` for reports containing filesize data
  22
  23 === 4.3 ===
  24
  25 * New external methods for retrieving system report data:
  26   - `core_reportbuilder_can_view_system_report`
  27   - `core_reportbuilder_retrieve_system_report`
  28 * New `get_tag_joins_for_entity` helper in base entity class, for returning SQL joins necessary for retrieving tags
  29 * New methods `[set|has]_table_join_alias` in the base entity class, to allow entities to reduce joins on the same table
  30 * New `set_is_deprecated` method in base `local\report\[column|filter]` classes to deprecate report entity columns and filters
  31 * The following report entity columns have been deprecated, with replacements as follows:
  32   - `comment:context` => `context:name`
  33   - `comment:contexturl` => `context:link`
  34   - `enrolment:method` => `enrol:name` (plus enrolment formatter `enrolment_name` method)
  35   - 'enrolment:role` => `role:name`
  36   - `file:context` => `context:name`
  37   - `file:contexturl` => `context:link`
  38   - `instance:context` (tag) => `context:name`
  39   - `instance:contexturl` (tag) => `context:link`
  40 * The following report entity filters/conditions have been deprecated, with replacements as follows:
  41   - `enrolment:method` => `enrol:plugin`
  42 * The `local/audience/form` template outer region has renamed some of it's `data-` attributes (relevant for any themes that
  43   have overridden this template):
  44   - `data-instanceid` => `data-audience-id`
  45   - `data-title` => `data-audience-title`
  46 * The `add_base_condition_sql` method of the base report class will now ignore empty where clauses
  47 * If a non-default column is specified in a datasource `get_default_column_sorting` method, a coding exception will be thrown
  48 * Trying to add/annotate duplicate entity names to a report will now throw a coding exception
  49 * The `get_default_entity_name` method of the base entity class is now private, and shouldn't be overridden in extending classes
  50 * The report helper methods `add_report_[condition|filter]` now throw an exception when trying to add duplicate conditions or
  51   filters to a report
  52 * Two new methods:
  53   - `get_default_no_results_notice` and
  54   - `set_default_no_results_notice`
  55   have been added to core_reportbuilder\local\report\base, allowing report implementations to control what lang string is used in
  56   the notice when the report has no results. Reports can either set a preferred lang string, or pass null if the notice isn't
  57   required in that particular report.
  58
  59 === 4.2 ===
  60
  61 * New method `set_checkbox_toggleall` in system report class to allow reports to easily create checkbox toggle columns
  62 * Column callbacks are now passed a fourth argument to indicate the aggregation type currently being applied, which allows
  63   for columns to define how the aggregated data is displayed
  64 * New methods `[add|get]_attributes` added to report base class, for including custom attributes in report container HTML
  65 * New database helper method `sql_replace_parameter_names` to help ensure uniqueness of parameters within an expression (where
  66   that expression can be used multiple times as part of a larger query)
  67 * The local report filter class has a new `get_field_sql_and_params` method which should be used by filter types that re-use
  68   the filter field SQL within their generated expression, to ensure SQL containing parameters works correctly
  69 * The following attributes can be added to custom reports in order to control card view display (via the `add_attributes` method):
  70   - `data-force-card` to force cards view
  71   - `data-force-table` to force table view
  72 * New optional parameter `pagesize` in external method `core_reportbuilder_reports_get` to set the displayed rows per page.
  73 * Javascript reports repository module method `getReport` updated to accept new pagesize parameter.
  74 * The schedule helper `create_schedule` method accepts a `$timenow` parameter to use for comparisons against current date
  75   during tests
  76 * The `datasource_stress_test_columns` test helper now enables sorting on those columns that support it
  77 * The `create_[column|filter|condition]` test generator methods now allow for setting all persistent properties
  78 * The `get_category` method of the base audience class has been deprecated, callers should instead use `get_component_displayname`
  79
  80 === 4.1 ===
  81
  82 * New method `add_action_divider()` in base system report class, to allow adding a divider to the action menu.
  83 * New external method `core_reportbuilder_set_filters` for setting report filter values (plus `setFilters` AJAX repository
  84   export for calling from Javascript modules)
  85 * New method `set_filter_form_default` in base system report class, to override whether the default filters form
  86   should be shown for a report
  87 * The external `core_reportbuilder_filters_reset` method now accepts an optional `parameters` argument, required by
  88   some system reports
  89 * New external methods for retrieving custom report data:
  90   - `core_reportbuilder_list_reports`
  91   - `core_reportbuilder_retrieve_report`
  92   - `core_reportbuilder_view_report`
  93 * For consistency, the following entity classes have moved namespace (usage of previous namespace will generate debugging):
  94   - `core_admin\{ => reportbuilder}\local\entities\task_log`
  95   - `core_cohort\{ => reportbuilder}\local\entities\cohort`
  96   - `core_cohort\{ => reportbuilder}\local\entities\cohort_member`
  97   - `core_course\{ => reportbuilder}\local\entities\course_category`
  98   - `report_configlog\{ => reportbuilder}\local\entities\config_change`
  99 * 'set_default_per_page' and 'get_default_per_page' methods have been added to \local\report\base class
 100   to manage the default displayed rows per page.
 101 * Added two new methods in the datasource class:
 102   - add_all_from_entity() to add all columns/filters/conditions from the given entity to the report at once
 103   - add_all_from_entities() to add all columns/filters/conditions from all the entities added to the report at once
 104 * New database helper methods for generating multiple unique values: `generate_aliases` and `generate_param_names`
 105 * The base aggregation `format_value` method has a `$columntype` argument in order to preserve type during aggregation. When
 106   defining column callbacks, strict typing will now be preserved in your callback methods when the column is being aggregated
 107 * The method `get_joins()` in the base entity class is now public, allowing for easier joins within reports
 108 * New method `set_table_aliases` in base entity class, for overriding multiple table aliases in a single call
 109 * The following local helper methods have been deprecated, their implementation moved to exporters:
 110   - `audience::get_all_audiences_menu_types` -> `custom_report_audience_cards_exporter`
 111   - `report::get_available_columns` -> `custom_report_column_cards_exporter`
 112 * The `custom_report_exporter` class now defines its editor element properties as optional, rather than each of those exporters
 113   defining their own properties as optional. In turn, this means the structure of the following external methods will always be
 114   present and consistent:
 115   - `core_reportbuilder_columns_*`
 116   - `core_reportbuilder_conditions_*`
 117   - `core_reportbuilder_filters_*`
 118 * The `custom_report_*` exporters now accept only classes that extend datasource as part of their related data properties
 119 * The following permission methods now accept an optional `$context` parameter (default system context):
 120   - `[require_]can_view_reports_list`
 121   - `[require_]can_create_report`
 122 * New method `get_default_condition_values()` in base datasource class, to be overridden by sources that wish to
 123   define default values for conditions upon report creation.
 124 * New methods `get_identity_[column|filter]` in user entity, for retrieving user identity field report elements
 125 * New method `user_reports_list_access_sql` in audience helper for retrieving list of all reports for given user
 126 * New report filter types:
 127   - `category` for reports containing course categories
 128   - `tags` for reports containing entities with support for core_tag API
 129   - `autocomplete` for reports that contain pre-defined values for selection.
 130 * New method `get_sample_values()` added to base filter class, to be overridden in all filter types to support stress testing
 131 * New test helpers for automated stress testing of report sources:
 132   - `datasource_stress_test_columns`
 133   - `datasource_stress_test_columns_aggregation`
 134   - `datasource_stress_test_conditions`
 135 * The test helper method `get_custom_report_content()` now accepts a list of filter values and applies them to the report
 136 * New method `get_default_column_sorting` in base datasource class, to be overridden by sources that wish to
 137   define default columns sort order upon report creation.