Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
core\external\paged_content_exporter Class Reference

Paged Content exporter. More...

Inheritance diagram for core\external\paged_content_exporter:

Public Member Functions

 __construct (int $pagesize, int $pagenumber, int $recordcount, callable $pageurlcallback, array $related=[])
 Constructor.
 

Protected Member Functions

 get_other_values (renderer_base $output)
 Get the additional values to inject while exporting.
 

Static Protected Member Functions

static define_other_properties ()
 Return the list of additional properties.
 

Detailed Description

Paged Content exporter.

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

Constructor & Destructor Documentation

◆ __construct()

core\external\paged_content_exporter::__construct ( int $pagesize,
int $pagenumber,
int $recordcount,
callable $pageurlcallback,
array $related = [] )

Constructor.

Parameters
int$pagesizeThe number of records to show on each page
int$pagenumberThe current page number
int$recordcountThe total number of records available
callable$pageurlcallbackThe callback to use to determine a page URL
array$relatedList of related elements

Member Function Documentation

◆ define_other_properties()

static core\external\paged_content_exporter::define_other_properties ( )
staticprotected

Return the list of additional properties.

Return values
array

◆ get_other_values()

core\external\paged_content_exporter::get_other_values ( renderer_base $output)
protected

Get the additional values to inject while exporting.

Parameters
renderer_base$outputThe renderer.
Return values
arrayKeys are the property names, values are their values.

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