moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 00:46:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-68454 table: Improve documentation for dynamic table

Browse source
This commit is contained in:
Andrew Nicols 2020-04-23 09:59:54 +08:00
parent 5615a772a6
commit 685fe08003
2 changed files with 12 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/table/classes/dynamic.php
View file

@ -19,7 +19,6 @@
* *
* @package core_table * @package core_table
* @copyright 2020 Simey Lameze <simey@moodle.com> * @copyright 2020 Simey Lameze <simey@moodle.com>
*
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/ */
@ -27,12 +26,19 @@ declare(strict_types=1);
namespace core_table; namespace core_table;
defined('MOODLE_INTERNAL') || die();
/** /**
* Interface dynamic. * Interface to identify this table as a table which can be dynamically updated via webservice calls.
*
* For a table to be defined as dynamic it must meet the following requirements:
*
* # it must be located with a namespaced class of \[component]\table\[tablename]
* # it must define a \core_table\local\filter\filterset implementation in \[component]\table\[tablename]_filterset
* # it must override the {{guess_base_url}} function and specify a base URL to be used when constructing URLs
* # it must override the {{get_context}} function to specify the correct context
* *
* @package core_table * @package core_table
* @copyright 2020 Simey Lameze <simey@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/ */
interface dynamic { interface dynamic {
} }

2
lib/upgrade.txt
View file

@ -47,6 +47,8 @@ information provided here is intended especially for developers.
db/services.php. Note - this also requires $CFG->enable_read_only_sessions to be set to true. db/services.php. Note - this also requires $CFG->enable_read_only_sessions to be set to true.
* database_manager::check_database_schema() now checks for missing and extra indexes. * database_manager::check_database_schema() now checks for missing and extra indexes.
* Implement a more direct xsendfile_file() method for an alternative_file_system_class * Implement a more direct xsendfile_file() method for an alternative_file_system_class
* A new `dynamic` table interface has been defined, which allows any `flexible_table` to be converted into a table which
is updatable via ajax calls. See MDL-68495 and `\core_table\dynamic` for further information.
=== 3.8 === === 3.8 ===
* Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop * Add CLI option to notify all cron tasks to stop: admin/cli/cron.php --stop