Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core_table\external\dynamic\get Class Reference
Inheritance diagram for core_table\external\dynamic\get:

Static Public Member Functions

static 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)
 External function to get the table view content.
 
static execute_parameters ()
 Describes the parameters for fetching the table html.
 
static execute_returns ()
 Describes the data returned from the external function.
 

Detailed Description

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ execute()

static core_table\external\dynamic\get::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 )
static

External function to get the table view content.

Parameters
string$componentThe component.
string$handlerDynamic table class name.
string$uniqueidUnique ID for the container.
array$sortdataThe columns and order to sort by
array$filtersThe filters that will be applied in the request.
string$jointypeThe join type.
string$firstinitialThe first name initial to filter on
string$lastinitialThe last name initial to filter on
int$pagenumberThe page number.
int$pagesizeThe number of records.
string$jointypeThe join type.
bool$resetpreferencesWhether it is resetting table preferences or not.
Return values
array

◆ execute_parameters()

static core_table\external\dynamic\get::execute_parameters ( )
static

Describes the parameters for fetching the table html.

Return values
external_function_parameters
Since
Moodle 3.9

◆ execute_returns()

static core_table\external\dynamic\get::execute_returns ( )
static

Describes the data returned from the external function.

Return values
external_single_structure
Since
Moodle 3.9

The documentation for this class was generated from the following file: