Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/lib/table/classes/external/dynamic/ -> get.php (source)

[Source view]

Differences Between: [Versions 401 and 402] [Versions 401 and 403]

Table external API.

Copyright: 2020 Simey Lameze <simey@moodle.com>
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 284 lines (10 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

get:: (2 methods):
  execute_parameters()
  execute()

is:: (1 method):
  execute_returns()


Class: get  - X-Ref

Core table external functions.

execute_parameters()   X-Ref
Describes the parameters for fetching the table html.

return: external_function_parameters

execute(string $component,string $handler,string $uniqueid,array $sortdata,?array $filters = null,?string $jointype = null,?string $firstinitial = null,?string $lastinitial = null,?int $pagenumber = null,?int $pagesize = null,?array $hiddencolumns = null,?bool $resetpreferences = null)   X-Ref
External function to get the table view content.

param: string $component The component.
param: string $handler Dynamic table class name.
param: string $uniqueid Unique ID for the container.
param: array $sortdata The columns and order to sort by
param: array $filters The filters that will be applied in the request.
param: string $jointype The join type.
param: string $firstinitial The first name initial to filter on
param: string $lastinitial The last name initial to filter on
param: int $pagenumber The page number.
param: int $pagesize The number of records.
param: string $jointype The join type.
param: bool $resetpreferences Whether it is resetting table preferences or not.
return: array

Class: is  - X-Ref

execute_returns()   X-Ref
Describes the data returned from the external function.

return: external_single_structure