MoodleDocs - User contributions [en]

Navigation API

2015-01-13T21:46:40Z

Charlesverge: /* Settings navigation */

==Overview==
The Navigation API allows for the manipulation of the navigation system used in Moodle.

==What the navigation is==
It's very important to understand what the navigation is exactly within Moodle. One of the goals for Moodle 2.0 was to standardise navigation throughout Moodle and try to bring order to the structure of a Moodle site. Navigation is available through the page object '''$PAGE''', against which you set the heading for the page, the title, any JavaScript requirements, etc. The navigation structure uses the information $PAGE contains to generate a navigation structure for the site. The navigation or settings [[blocks]] are interpretations of the navigation structure Moodle creates.

This navigation structure is available through three variables:

; $PAGE->navigation : This is the main navigation structure, it will contain items that will allow the user to browse to the other available pages.
; $PAGE->settingsnav : This is the settings navigation structure contains items that will allow the user to edit settings.
; $PAGE->navbar : The navbar is a special structure for page breadcrumbs.

==What the navigation is not==
The navigation is '''NOT''' the navigation block or the settings block! These two blocks were created to display the navigation structure. The navigation block looks at ''$PAGE->navigation'', and the settings block looks at ''$PAGE->settingsnav''. Both blocks interpret their data into an HTML structure and render it.

# The navigation is a back-end structure that is built behind the scenes and has no immediate method of display.
# The navigation and settings blocks display the back-end navigation structure but add nothing to it at all.
::In the [[model-view-controller pattern]], $PAGE->navigation, $PAGE->settingsnav, and $PAGE->navbar are the models, and the blocks are views.

The navbar is just the path to the active navigation or settings item. The navbar is not displayed by a block; instead it is added into the theme's layout files and displayed by the core renderer.

==How the navigation works==

The main navigation structure can be accessed through '''$PAGE->navigation'''. The navigation and settings are contextual in that they will relate to the page that the user is viewing. This is determined by other $PAGE object properties:
* '''$PAGE->context''' is a Moodle context that immediately outlines the nature of the page the user is viewing.
* '''$PAGE->course''' is the course the user is viewing. This is essential if the context is CONTEXT_COURSE or greater. However, it is also useful in other contexts such as CONTEXT_USER.
* '''$PAGE->cm''' is the course module instance. This is essential if the context is CONTEXT_MODULE or greater.
* '''$PAGE->url''' is used to match the active navigation item.

Nearly every page sets $PAGE->url through a call to '''$PAGE->set_url''' however not many explicitly set the context, course, or cm. When you call '''require_login''' with a course or cm it automatically calls the following:
<code php>
if ($cm) {
$PAGE->set_cm($cm, $course); // sets up global $COURSE
} else {
$PAGE->set_course($course);// sets up global $COURSE
</code>

A page will only be required to explicitly set a context, course, or cm under one of these conditions:
# '''require_login''' is NOT being called correctly
# The page is using CONTEXT_SYSTEM, CONTEXT_COURSECAT, or CONTEXT_USER (call '''$PAGE->set_context''' ).
# The page is using a course or cm but it is also using one of the above contexts (call '''$PAGE->set_course''' or '''$PAGE->set_cm''' ).

The navigation structure cannot be generated before the $PAGE object is configured. It is only generated when it is first used, either when something tries to access the structure or when code tries to add to it. The navigation is initialised in a specific order:
# Main navigation structure
# Settings navigation
# Navbar (does not need to be generated because of its simple contents and rendering)

==Extending the navigation==

===Code extension===
This method of extending is when the code arbitrarily extends the navigation during its execution. Extending the navigation through this means allows you to extend the navigation anywhere easily, however it will only be shown on pages where your extending code gets called (you should probably put it in a function within lib.php).

These examples are taken from the [http://moodle.org/mod/forum/discuss.php?d=152391 General Developer Forum: Moodle 2 - how to set up breadcrumbs for a module page]. It has further information that is well worth reading.
====Navigation====
This is extending the main navigation structure.
<code php>
$previewnode = $PAGE->navigation->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);
$thingnode = $previewnode->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
$thingnode->make_active();
</code>
The above lines of code adds a preview node to the bottom of the navigation and then adds a thingnode to the previewnode (adding a leaf to our tree).
The final line of code makes the thingnode active so that the navbar finds it however if the URL you give it is the same as the url you set for the page it will automatically be marked active and you won't need this call.

Next extending the navigation for the course.
For this you will need to know the course id and have called require_login($courseorid); so that the navigation is loaded for the course.
<code php>
$coursenode = $PAGE->navigation->find($courseid, navigation_node::TYPE_COURSE);
$thingnode = $coursenode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
$thingnode->make_active();
</code>
The new bit of code here really is the first line which simply finds the course node, to do this we give it the course id and the node type in this case TYPE_COURSE.
What we are doing here is relying on the navigation to generate the navigation up to the course and then just adding to the course.

Note that Moodle loads plugins in alphabetical order. Therefore plugin_b can find a node added by plugin_a but not the other way around.
====Settings navigation====
Adding to the settings navigation is very similar to navigation
<code php>
$settingnode = $PAGE->settingsnav->add(get_string('setting'), new moodle_url('/a/link/if/you/want/one.php'), navigation_node::TYPE_CONTAINER);
$thingnode = $settingnode->add(get_string('Name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
$thingnode->make_active();
</code>

====Add Settings folder to navigation====

An example of a settings folder in a module can be see by navigating to Site administration / Plugins / Activity modules / Assignment.

[[File:assignmentmenu.png]]

An example of adding a navigation folder to a settings.php for a block with a link to the settings page and a external page is bellow.

<code php>
<?php

defined('MOODLE_INTERNAL') || die;

// Create folder / submenu in block menu, modsettings for activity modules, localplugins for Local plugins.
// The default folders are defined in admin/settings/plugins.php.
$ADMIN->add('blocksettings', new admin_category('blocksamplefolder',
get_string('pluginname', 'mod_sample')));

// Create settings block.
$settings = new admin_settingpage($section, get_string('settings', 'block_sample'));
if ($ADMIN->fulltree) {
$settings->add(new admin_setting_configcheckbox('block_sample_checkbox', get_string('checkbox', 'block_sample'),
get_string('checkboxdescription', 'block_kronoshtml'), 0));
}

// This adds the settings link to the folder/submenu.
$ADMIN->add('blocksamplefolder', $settings);
// This adds a link to an external page.
$ADMIN->add('blocksamplefolder', new admin_externalpage('block_sample_page', get_string('externalpage', 'block_sample'),
$CFG->wwwroot.'/blocks/sample/sample.php'));
// Prevent Moodle from adding settings block in standard location.
$settings = null;
</code>

====Navbar====
This is extending the settings navigation.
<code php>
$PAGE->navbar->ignore_active();
$PAGE->navbar->add(get_string('preview'), new moodle_url('/a/link/if/you/want/one.php'));
$PAGE->navbar->add(get_string('name of thing'), new moodle_url('/a/link/if/you/want/one.php'));
</code>
The above code tells the navbar to ignore what ever the active page was and just use what you add, at which point we add two items as shown.
===Plugin Callbacks===
These are specific functions that the navigation looks for and calls if they exist for the plugin, presently only three plugin types can extend the navigation through these call-backs.

Ideally all entries in "Administration / Site administration" tree should be done via settings.php files but sometimes it may be easier to directly modify the navigation structure created from the admin settings tree (such as when adding links to external pages).

====Module====
Modules have two call-back methods, first to extend the navigation, and second to extend the settings. These call-backs get called when ever the user is viewing a page within the module and should only extend the navigation for the module.
<code php>
function {modulename}_extend_navigation(${modulename}node, $course, $module, $cm)
function {modulename}_extend_settings_navigation($settings, ${modulename}node)
</code>

====Course Formats====
Course formats are able to completely redefine the way in which navigation is generated for a course, as well as this they also have several methods to ensure the navigation is generated correctly.

====Course Reports====
By default reports don't add themselves or anything else to the navigation however there is a call-back that can be implemented to allow them to do so.

====Local Plugins====
Local plugins have two call-back methods, first to extend the navigation, and second to extend the settings.
<code php>
function local_{pluginname}_extends_navigation(global_navigation $nav)
function local_{pluginname}_extends_settings_navigation(settings_navigation $nav, context $context)
</code>

==FAQ's and troubleshooting==
'''Q.''' My page is on the navigation but it doesn't find it?

The first thing to do here is check the URL you are setting for the page. It should match the URL your page has within the navigation. If it doesn't you have two options, first change your '''$PAGE->set_url''' call, or second override the URL the navigation is using to find the active node as shown below:
<code php>
navigation_node::override_active_url(new moodle_url('/your/url/here.php', array('param'=>'value')));
</code>

==See also==

* [[Core APIs]]
* [https://moodle.org/mod/forum/discuss.php?d=170325&parent=753095 Forum discussion - adding navigation to local plugins]

[[Category:API]]

File:assignmentmenu.png

2015-01-13T21:46:03Z

Charlesverge: Screen shot of assignment activity settings navigation.

Screen shot of assignment activity settings navigation.

jQuery

2014-11-28T18:02:15Z

Charlesverge: /* Frequently asked questions */

{{Moodle 2.5}}

[[YUI]] is the recommended library for development of Moodle plugins or customisations. However due to significant demand it will be possible to use also jQuery in Moodle add-ons.

==Examples==

===Basic jQuery in add-on theme===

# create /theme/sometheme/lib.php file if it does not exist yet
# add new function theme_sometheme_page_init to the lib.php file (replace 'sometheme' with real name of your theme)
# use jQuery JavaScript in theme layout files

<code php>
<?php
// file: /theme/sometheme/lib.php
function theme_sometheme_page_init(moodle_page $page) {
$page->requires->jquery();
}
</code>

<code html4strict>
// near the end of file: /theme/sometheme/layout/general.php
<script>
$('.headermain').mouseover(function() {
alert('grrr');
});
</script>
</code>

===jQuery UI in add-on activity module===
# optionally add more jQuery plugins (not recommended because the same plugins in different add-ons may collide)
# add necessary $PAGE->requires
# use jQuery

<code php>

<?php
require('../../config.php');

// ... normal PAGE setup and access control

$PAGE->requires->jquery();
$PAGE->requires->jquery_plugin('ui');
$PAGE->requires->jquery_plugin('ui-css');

echo $OUTPUT->header();
?>
<button>A button element</button>

<div id="dialog" title="Basic dialog">
<p>This is the default dialog which is useful for displaying information. The dialog window can be moved, resized and closed with the 'x' icon.</p>
</div>
<script>
$(function() {
$( "#dialog" ).dialog();
});
</script>
<?php
echo $OUTPUT->footer();
</code>

===jQuery UI in add-on block===
# add necessary requires in get_required_javascript() method in your block, do not forget to call it in parent too
# use jQuery in blok html output

<code php>

class block_html extends block_base {

function get_required_javascript() {
parent::get_required_javascript();

$this->page->requires->jquery();
$this->page->requires->jquery_plugin('ui');
$this->page->requires->jquery_plugin('ui-css');
}

function get_content() {

// ....

$this->content->text .= '
<div id="progressbar"></div>
<script>
$(function() {
$( "#progressbar" ).progressbar({
value: 37
});
});
</script>';

// ....
}
</code>

=== Including your own plugins ===
'''Note:''' Your plugin your have a filename which includes its version number. This is the same as in the core jQuery project. This enables you to increment the version of your plugin when you make changes to it.

# Place your jQuery plugin into mod/yourplugin/jquery/jquerymodule/
# Add the plugin information to the plugins.php file
# Use the plugin in your code

==== Add the plugin information to the plugins.php file ====
<code php>
// file: mod/yourplugin/jquery/plugins.php
$plugins = array(
'yourplugin-jquerymodule' => array(
'files' => array(
'jquerymodule/jquery-somefilename-1.0.1.min.js',
),
),
);
</code>

==== Use the plugin in your code ====
<code php>
<?php
// file: /mod/yourplugin/lib.php
// ... rest of file ...
$PAGE->requires->jquery_plugin('yourplugin-jquerymodule', 'mod_yourplugin');
</code>

===Overriding base jQuery UI theme===
# download new jQuery UI theme and extract it into theme/sometheme/jquery/custom-1.0
# define new jQuery theme ui css plugin in theme/sometheme/jquery/plugins.php
# overrider core 'ui-css' with 'yourtheme-ui-css'

<code php>
<?php
// file: theme/sometheme/jquery/plugins.php
$plugins = array(
'sometheme-ui-css' => array('files' => array('custom-1.0/jquery-ui-1.10.2.custom.min.css')),
);
</code>

<code php>
<?php
// file: /theme/sometheme/lib.php
function theme_sometheme_page_init(moodle_page $page) {
// There is no need to $page->requires->jquery() if the theme does not use jQuery.
$page->requires->jquery_plugin('sometheme-ui-css', 'theme_sometheme');
$page->requires->jquery_override_plugin('ui-css', 'sometheme-ui-css');
}
</code>

===Backwards compatibility for scripts written for legacy jQuery versions===

See [https://github.com/jquery/jquery-migrate/ jQuery Migrate plugin]

<code php>
$PAGE->requires->jquery();
$PAGE->requires->jquery_plugin('migrate');

// Incompatible code designed for 1.8.x jQuery should work now...
</code>

===mymobile theme===

See mymobile theme for more examples including custom jQuery plugin and integration with jQuery Mobile.

==More information==

===Bundled plugins===

Official Moodle distribution contains jQuery, jQuery UI and jQuery Migrate plugins.

===jQuery plugin collisions===

The loading order of plugins is defined by order of $PAGE->requires. If there are plugins with the same name the first $PAGE->require wins.

It is recommended to use plugin overrides only in themes because multiple overrides of the same plugin result in undefined behaviour. In general themes should have more freedom to add extra jQuery plugins, other Moodle plugins should ideally use only basic jQuery or jQuery UI.

===jQuery plugin modifications===

Files in jQuery plugins MUST NOT be changed, always create a new file with different name and update CSS and plugins.php if necessary and delete the old file.

===jQuery versions===

Only minor jQuery version updates can be done in STABLE branches. Add-on developers must revalidate compatibility after every major upgrade. Use official 'migrate' plugin if necessary, see example above.

==Frequently asked questions==

; Can I serve jQuery from CDN? : No, because CDNs do not include all plugins and some do not support https. Use proxy caching such as Cloudflare instead.

; I edited some file but the change is ignored, why? : Moodle and your browser caches Javascript, to circumvent this rename your Javascript file as shown [https://docs.moodle.org/dev/jQuery#Including_your_own_plugins here]. Additionally you can use the developer console on [https://developer.chrome.com/devtools/docs/settings Chrome] or [https://developer.mozilla.org/en-US/docs/Tools/Tools_Toolbox Firefox] to disable caching for Javascript.

See above, files MUST NOT be updated in jQuery plugins, always create new files or directories. Moodle cache purging does not have any effect on jQuery plugins.

; Can we remove YUI now? : No! YUI is the only recommended JS library in Moodle add-ons and core.

; Can I use different jQuery version? : No. (Theoretically you might try jQuery plugin override to include some later minor revision.)

; Could we have jQuery plugin dependencies? : No, order your $PAGE->requires manually.

; Are there any performance costs when using jQuery? : Yes. Please consider using SimpleYUI for simple DOM manipulations or standard YUI widgets.

; Can I use YUI loader to include jQuery? : No. Moodle jQuery support is not compatible with sandboxing.

; Moodle complains when I disable slasharguments setting, why? : Please fix your server to be compatible with slasharguments, even IIS can support it now!

; Why is jQuery UI split into two plugins? : This allows Moodle themes to override the jQuery UI CSS and images.

==See also==
* [http://jquery.com jQuery]
* [http://jqueryui.com jQuery User Interface]

[[Category:Javascript]]

lib/tablelib.php

2014-11-18T00:45:48Z

Charlesverge: Added complete example extending the table_sql class.

==Status of this doc==

This doc is a description of proposed additions to the api for using tablelib. It has not yet been agreed on. Seemed a good idea to create it at this url rather than some development notes page for instance so that the history of this page will include the changes made to the original proposal.

==What changes in the new api?==

* Currently the code for creating table often involves a lot of duplication of code. New api can improve things.
* New API handles downloads
** download export formats are seperated into classes and it is simple to add more formats. Added two more formats. Unpaged XHTML format and comma seperated values format.
* No longer have to make sure that column data is added to the table in the same order as columns are declared. Can have the logic for choosing what columns to include in the table in one place.
* New mechanism in table_sql allows appropriate code to be automatically called to format data before putting it into the table.

==Skeleton Usage==

In order to check your sql query is working as expected when developing a page it can be useful just to output all the data from the query in the table before going on to work out how you want to format data. The code below will output all the data from your query in a collapsible, sortable table. It automatically displays all columns returned from the db.

You should go on to :
*specify what columns to include in the table and what names to display for the columns using define_columms and define_headers
*use your own child class of easy_table and define methods col_{columnname} to add hyperlinks etc to the table. You can also use method other_cols.

See below for examples of typical usage.

<pre>
<?php // $Id$
/**
* Simple file test.php to drop into root of Moodle installation.
* This is the skeleton code to print a downloadable, paged, sorted table of
* data from a sql query.
*/
require "config.php";
require "$CFG->libdir/tablelib.php";
$context = context_system::instance();
$PAGE->set_context($context);
$PAGE->set_url('/test.php');

$download = optional_param('download', '', PARAM_ALPHA);

$table = new table_sql('uniqueid');
$table->is_downloading($download, 'test', 'testing123');

if (!$table->is_downloading()) {
// Only print headers if not asked to download data
// Print the page header
$PAGE->set_title('Testing');
$PAGE->set_heading('Testing table class');
$PAGE->navbar->add('Testing table class', new moodle_url('/test.php'));
echo $OUTPUT->header();
}

// Work out the sql for the table.
$table->set_sql('*', "{user}", '1');

$table->define_baseurl("$CFG->wwwroot/test.php");

$table->out(40, true);

if (!$table->is_downloading()) {
$OUTPUT->footer();
}
</pre>

==The Next Step : Typical Usage==

===Define table===

Define table class in file somethingsomthing_table.php

In the file define a child class of 'table_sql'. Mostly this child class will just contain methods to format data for display.

====Format data for display====

Define methods col_{colmname} to process data from db and to add it to table. Eg. Here is an example from table class quiz_report_overview_table

<pre>
function col_timefinish($attempt){
if ($attempt->attempt) {
if ($attempt->timefinish) {
$timefinish = userdate($attempt->timefinish, $this->strtimeformat);
if (!$this->is_downloading()) {
return '<a href="review.php?q='.$this->quiz->id.'&attempt='.$attempt->attempt.'">'.$timefinish.'</a>';
} else {
return $timefinish;
}
} else {
return '-';
}
} else {
return '-';
}
}

</pre>

Where you do not know the names of the columns at the time of writing the class definition then you can use other_cols method. Eg.
<pre>
function other_cols($colname, $attempt){
if (preg_match('/^qsgrade([0-9]+)$/', $colname, $matches)){
$questionid = $matches[1];
$question = $this->questions[$questionid];
$state = new object();
$state->event = $attempt->{'qsevent'.$questionid};
if (question_state_is_graded($state)) {
$grade = quiz_rescale_grade($attempt->{'qsgrade'.$questionid}, $this->quiz);
} else {
$grade = '--';
}
if (!$this->is_downloading()) {
$grade = $grade.'/'.quiz_rescale_grade($question->grade, $this->quiz);
return link_to_popup_window('/mod/quiz/reviewquestion.php?state='.
$attempt->{'qsid'.$questionid}.'&number='.$question->number,
'reviewquestion', $grade, 450, 650, get_string('reviewresponse', 'quiz'),
'none', true);
} else {
return $grade;
}
} else {
return NULL;
}
}
</pre>

If there is no method col_{column name} and other_cols returns NULL then the column data is put straight in the table unprocessed.

===Use your table class===

<pre>
// Start page
$download = optional_param('download', '', PARAM_ALPHA);

$table = new name_of_your_table('uniqueid');
$table->is_downloading($download, $filenamefordownload, $sheettitle);
if (!$table->is_downloading()) {
// Only print headers if not asked to download data
$this->print_header_and_tabs($cm, $course, $quiz, "overview");
}
// Various page set up stuff
if (!$table->is_downloading()) { //do not print notices when downloading
// Wrap output of html in these if conditions
}

// Work out the sql for the table.

// Use this method only if you want to specify some sql with less joins for
// counting the total records.
$table->set_count_sql("SELECT COUNT(1) FROM $from WHERE $where");

if ($something) {
// Add some more joins
}

$table->set_sql($fields, $from, $where);
// Define table columns.
$columns = array();
$headers = array();

if (!$table->is_downloading() && $candelete) {
$columns[]= 'checkbox';
$headers[]= NULL;
}

if (!$table->is_downloading() && $CFG->grade_report_showuserimage) {
$columns[]= 'picture';
$headers[]= '';
}
if (!$table->is_downloading()){
$columns[]= 'fullname';
$headers[]= get_string('name');
} else {
$columns[]= 'lastname';
$headers[]= get_string('lastname');
$columns[]= 'firstname';
$headers[]= get_string('firstname');
}

if ($CFG->grade_report_showuseridnumber) {
$columns[]= 'idnumber';
$headers[]= get_string('idnumber');
}

$columns[]= 'timestart';
$headers[]= get_string('startedon', 'quiz');

$columns[]= 'timefinish';
$headers[]= get_string('timecompleted','quiz');

$columns[]= 'duration';
$headers[]= get_string('attemptduration', 'quiz');

if ($detailedmarks) {
foreach ($questions as $id => $question) {
// Ignore questions of zero length
$columns[] = 'qsgrade'.$id;
$headers[] = '#'.$question->number;
}
}

if ($showgrades) {
$columns[] = 'sumgrades';
$headers[] = get_string('grade', 'quiz').'/'.$quiz->grade;
}

if ($hasfeedback) {
$columns[] = 'feedbacktext';
$headers[] = get_string('feedback', 'quiz');
}

$table->define_columns($columns);
$table->define_headers($headers);
$table->sortable(true, 'uniqueid');

// Set up the table some of these settings will be ignored for downloads
$table->define_baseurl($reporturl->out(false, $displayoptions));

$table->column_suppress('picture');
$table->column_suppress('fullname');
$table->column_suppress('idnumber');

$table->no_sorting('feedbacktext');

$table->column_class('picture', 'picture');
$table->column_class('fullname', 'bold');
$table->column_class('sumgrades', 'bold');

$table->set_attribute('id', 'attempts');

$table->out($pagesize, $useinitialsbar);

if (!$table->is_downloading()) {
// Footer and other html stuff to display.
}
</pre>

==Complete sql table class example==

The following two scripts demonstrate how you can customize which table columns to show, table columns names and process values for table rows.

Put the following script into test_table.php

<pre>
<?php
/**
* Test table class to be put in test_table.php of root of Moodle installation.
* for defining some custom column names and proccessing
* Username and Password feilds using custom and other column methods.
*/
class test_table extends table_sql {

/**
* Constructor
* @param int $uniqueid all tables have to have a unique id, this is used
* as a key when storing table properties like sort order in the session.
*/
function __construct($uniqueid) {
parent::__construct($uniqueid);
// Define the list of columns to show.
$columns = array('username', 'password', 'firstname', 'lastname');
$this->define_columns($columns);

// Define the titles of columns to show in header.
$headers = array('Username', 'Password', 'First name', 'Last name');
$this->define_headers($headers);
}

/**
* This function is called for each data row to allow processing of the
* username value.
*
* @param object $values Contains object with all the values of record.
* @return $string Return username with link to profile or username only
* when downloading.
*/
function col_username($values) {
// If the data is being downloaded than we don't want to show HTML.
if ($this->is_downloading()) {
return $values->username;
} else {
return '<a href="/user/profile.php?id='.$values->id.'">'.$values->username.'</a>';
}
}

/**
* This function is called for each data row to allow processing of
* columns which do not have a *_cols function.
* @return string return processed value. Return NULL if no change has
* been made.
*/
function other_cols($colname, $value) {
// For security reasons we don't want to show the password hash.
if ($colname == 'password') {
return "****";
}
}
}
</pre>

Put the following script into test_custom.php, the difference between test.php is the inclusion of test_custom.php and changing table_sql to new test_table.
<pre>
<?php
/**
* Simple file test_custom.php to drop into root of Moodle installation.
* This is an example of using a sql_table class to format data.
*/
require "config.php";
require "$CFG->libdir/tablelib.php";
require "test_table.php";
$context = context_system::instance();
$PAGE->set_context($context);
$PAGE->set_url('/test_custom.php');

$download = optional_param('download', '', PARAM_ALPHA);

$table = new test_table('uniqueid');
$table->is_downloading($download, 'test', 'testing123');

if (!$table->is_downloading()) {
// Only print headers if not asked to download data.
// Print the page header.
$PAGE->set_title('Testing');
$PAGE->set_heading('Testing table class');
$PAGE->navbar->add('Testing table class', new moodle_url('/test_custom.php'));
echo $OUTPUT->header();
}

// Work out the sql for the table.
$table->set_sql('*', "{user}", '1');

$table->define_baseurl("$CFG->wwwroot/test_custom.php");

$table->out(10, true);

if (!$table->is_downloading()) {
$OUTPUT->footer();
}
</pre>

==Adding download capability to existing tables==

To add download to existing tables. You must :

Add :

<pre>
$download = optional_param('download', '', PARAM_ALPHA);
</pre>

To top of page.

Probably more table instantiation to top of page.

Add just after table object instantiation :

<pre>
$table->is_downloading($download, 'test',
'testing123');
</pre>

Wrap all html output with condition :
<pre>
if (!$table->is_downloading()) {
</pre>

Make sure you have this method call somewhere :

<pre>
$table->define_baseurl($reporturl->out(false, $displayoptions));
</pre>

Replace :

<pre>
$table->print_html();
</pre>

With :

<pre>
$table->finish_output();
</pre>

Download buttons will automagically appear.

==See also==

* The phpdoc comments on the class flexible_table and table_sql in tablelib.php
* [http://tracker.moodle.org/browse/MDL-14187 Discussion in tracker]

lib/tablelib.php

2014-11-17T22:46:55Z

Charlesverge: /* Skeleton Usage */ Removed code comment.

==Status of this doc==

This doc is a description of proposed additions to the api for using tablelib. It has not yet been agreed on. Seemed a good idea to create it at this url rather than some development notes page for instance so that the history of this page will include the changes made to the original proposal.

==What changes in the new api?==

* Currently the code for creating table often involves a lot of duplication of code. New api can improve things.
* New API handles downloads
** download export formats are seperated into classes and it is simple to add more formats. Added two more formats. Unpaged XHTML format and comma seperated values format.
* No longer have to make sure that column data is added to the table in the same order as columns are declared. Can have the logic for choosing what columns to include in the table in one place.
* New mechanism in table_sql allows appropriate code to be automatically called to format data before putting it into the table.

==Skeleton Usage==

In order to check your sql query is working as expected when developing a page it can be useful just to output all the data from the query in the table before going on to work out how you want to format data. The code below will output all the data from your query in a collapsible, sortable table. It automatically displays all columns returned from the db.

You should go on to :
*specify what columns to include in the table and what names to display for the columns using define_columms and define_headers
*use your own child class of easy_table and define methods col_{columnname} to add hyperlinks etc to the table. You can also use method other_cols.

See below for examples of typical usage.

<pre>
<?php // $Id$
/**
* Simple file test.php to drop into root of Moodle installation.
* This is the skeleton code to print a downloadable, paged, sorted table of
* data from a sql query.
*/
require "config.php";
require "$CFG->libdir/tablelib.php";
$context = context_system::instance();
$PAGE->set_context($context);
$PAGE->set_url('/test.php');

$download = optional_param('download', '', PARAM_ALPHA);

$table = new table_sql('uniqueid');
$table->is_downloading($download, 'test', 'testing123');

if (!$table->is_downloading()) {
// Only print headers if not asked to download data
// Print the page header
$PAGE->set_title('Testing');
$PAGE->set_heading('Testing table class');
$PAGE->navbar->add('Testing table class', new moodle_url('/test.php'));
echo $OUTPUT->header();
}

// Work out the sql for the table.
$table->set_sql('*', "{$CFG->prefix}user", '1');

$table->define_baseurl("$CFG->wwwroot/test.php");

$table->out(40, true);

if (!$table->is_downloading()) {
$OUTPUT->footer();
}
</pre>

==The Next Step : Typical Usage==

===Define table===

Define table class in file somethingsomthing_table.php

In the file define a child class of 'table_sql'. Mostly this child class will just contain methods to format data for display.

====Format data for display====

Define methods col_{colmname} to process data from db and to add it to table. Eg. Here is an example from table class quiz_report_overview_table

<pre>
function col_timefinish($attempt){
if ($attempt->attempt) {
if ($attempt->timefinish) {
$timefinish = userdate($attempt->timefinish, $this->strtimeformat);
if (!$this->is_downloading()) {
return '<a href="review.php?q='.$this->quiz->id.'&attempt='.$attempt->attempt.'">'.$timefinish.'</a>';
} else {
return $timefinish;
}
} else {
return '-';
}
} else {
return '-';
}
}

</pre>

Where you do not know the names of the columns at the time of writing the class definition then you can use other_cols method. Eg.
<pre>
function other_cols($colname, $attempt){
if (preg_match('/^qsgrade([0-9]+)$/', $colname, $matches)){
$questionid = $matches[1];
$question = $this->questions[$questionid];
$state = new object();
$state->event = $attempt->{'qsevent'.$questionid};
if (question_state_is_graded($state)) {
$grade = quiz_rescale_grade($attempt->{'qsgrade'.$questionid}, $this->quiz);
} else {
$grade = '--';
}
if (!$this->is_downloading()) {
$grade = $grade.'/'.quiz_rescale_grade($question->grade, $this->quiz);
return link_to_popup_window('/mod/quiz/reviewquestion.php?state='.
$attempt->{'qsid'.$questionid}.'&number='.$question->number,
'reviewquestion', $grade, 450, 650, get_string('reviewresponse', 'quiz'),
'none', true);
} else {
return $grade;
}
} else {
return NULL;
}
}
</pre>

If there is no method col_{column name} and other_cols returns NULL then the column data is put straight in the table unprocessed.

===Use your table class===

<pre>
//start page
$download = optional_param('download', '', PARAM_ALPHA);

$table = new name_of_your_table('uniqueid');
$table->is_downloading($download, $filenamefordownload, $sheettitle);
if (!$table->is_downloading()) {
// Only print headers if not asked to download data
$this->print_header_and_tabs($cm, $course, $quiz, "overview");
}
//various page set up stuff
if (!$table->is_downloading()) { //do not print notices when downloading
//wrap output of html in these if conditions
}

//work out the sql for the table.

//use this method only if you want to specify some sql with less joins for
//counting the total records
$table->set_count_sql("SELECT COUNT(1) FROM $from WHERE $where");

if ($something) {
// Add some more joins
}

$table->set_sql($fields, $from, $where);
// Define table columns
$columns = array();
$headers = array();

if (!$table->is_downloading() && $candelete) {
$columns[]= 'checkbox';
$headers[]= NULL;
}

if (!$table->is_downloading() && $CFG->grade_report_showuserimage) {
$columns[]= 'picture';
$headers[]= '';
}
if (!$table->is_downloading()){
$columns[]= 'fullname';
$headers[]= get_string('name');
} else {
$columns[]= 'lastname';
$headers[]= get_string('lastname');
$columns[]= 'firstname';
$headers[]= get_string('firstname');
}

if ($CFG->grade_report_showuseridnumber) {
$columns[]= 'idnumber';
$headers[]= get_string('idnumber');
}

$columns[]= 'timestart';
$headers[]= get_string('startedon', 'quiz');

$columns[]= 'timefinish';
$headers[]= get_string('timecompleted','quiz');

$columns[]= 'duration';
$headers[]= get_string('attemptduration', 'quiz');

if ($detailedmarks) {
foreach ($questions as $id => $question) {
// Ignore questions of zero length
$columns[] = 'qsgrade'.$id;
$headers[] = '#'.$question->number;
}
}

if ($showgrades) {
$columns[] = 'sumgrades';
$headers[] = get_string('grade', 'quiz').'/'.$quiz->grade;
}

if ($hasfeedback) {
$columns[] = 'feedbacktext';
$headers[] = get_string('feedback', 'quiz');
}

$table->define_columns($columns);
$table->define_headers($headers);
$table->sortable(true, 'uniqueid');

// Set up the table some of these settings will be ignored for downloads
$table->define_baseurl($reporturl->out(false, $displayoptions));

$table->column_suppress('picture');
$table->column_suppress('fullname');
$table->column_suppress('idnumber');

$table->no_sorting('feedbacktext');

$table->column_class('picture', 'picture');
$table->column_class('fullname', 'bold');
$table->column_class('sumgrades', 'bold');

$table->set_attribute('id', 'attempts');

$table->out($pagesize, $useinitialsbar);

if (!$table->is_downloading()) {
//footer and other html stuff to display
}
</pre>

==Adding download capability to existing tables==

To add download to existing tables. You must :

Add :

<pre>
$download = optional_param('download', '', PARAM_ALPHA);
</pre>

To top of page.

Probably more table instantiation to top of page.

Add just after table object instantiation :

<pre>
$table->is_downloading($download, 'test',
'testing123');
</pre>

Wrap all html output with condition :
<pre>
if (!$table->is_downloading()) {
</pre>

Make sure you have this method call somewhere :

<pre>
$table->define_baseurl($reporturl->out(false, $displayoptions));
</pre>

Replace :

<pre>
$table->print_html();
</pre>

With :

<pre>
$table->finish_output();
</pre>

Download buttons will automagically appear.

==See also==

* The phpdoc comments on the class flexible_table and table_sql in tablelib.php
* [http://tracker.moodle.org/browse/MDL-14187 Discussion in tracker]

lib/tablelib.php

2014-11-17T22:43:40Z

Charlesverge: /* The Next Step : Typical Usage */ class name correction

==Status of this doc==

This doc is a description of proposed additions to the api for using tablelib. It has not yet been agreed on. Seemed a good idea to create it at this url rather than some development notes page for instance so that the history of this page will include the changes made to the original proposal.

==What changes in the new api?==

* Currently the code for creating table often involves a lot of duplication of code. New api can improve things.
* New API handles downloads
** download export formats are seperated into classes and it is simple to add more formats. Added two more formats. Unpaged XHTML format and comma seperated values format.
* No longer have to make sure that column data is added to the table in the same order as columns are declared. Can have the logic for choosing what columns to include in the table in one place.
* New mechanism in table_sql allows appropriate code to be automatically called to format data before putting it into the table.

==Skeleton Usage==

In order to check your sql query is working as expected when developing a page it can be useful just to output all the data from the query in the table before going on to work out how you want to format data. The code below will output all the data from your query in a collapsible, sortable table. It automatically displays all columns returned from the db.

You should go on to :
*specify what columns to include in the table and what names to display for the columns using define_columms and define_headers
*use your own child class of easy_table and define methods col_{columnname} to add hyperlinks etc to the table. You can also use method other_cols.

See below for examples of typical usage.

<pre>
<?php // $Id$
/**
* Simple file test.php to drop into root of Moodle installation.
* This is the skeleton code to print a downloadable, paged, sorted table of
* data from a sql query.
*/
require "config.php";
require "$CFG->libdir/tablelib.php";
$context = context_system::instance();
$PAGE->set_context($context);
$PAGE->set_url('/test.php');

$download = optional_param('download', '', PARAM_ALPHA);

$table = new table_sql('uniqueid');
$table->is_downloading($download, 'test', 'testing123');

if (!$table->is_downloading()) {
// Only print headers if not asked to download data
/// Print the page header
$PAGE->set_title('Testing');
$PAGE->set_heading('Testing table class');
$PAGE->navbar->add('Testing table class', new moodle_url('/test.php'));
echo $OUTPUT->header();
//print_header_simple('Testing ', 'Testing table class', $navigation);
}

//work out the sql for the table.
$table->set_sql('*', "{$CFG->prefix}user", '1');

$table->define_baseurl("$CFG->wwwroot/test.php");

$table->out(40, true);

if (!$table->is_downloading()) {
$OUTPUT->footer();
}
</pre>

==The Next Step : Typical Usage==

===Define table===

Define table class in file somethingsomthing_table.php

In the file define a child class of 'table_sql'. Mostly this child class will just contain methods to format data for display.

====Format data for display====

Define methods col_{colmname} to process data from db and to add it to table. Eg. Here is an example from table class quiz_report_overview_table

<pre>
function col_timefinish($attempt){
if ($attempt->attempt) {
if ($attempt->timefinish) {
$timefinish = userdate($attempt->timefinish, $this->strtimeformat);
if (!$this->is_downloading()) {
return '<a href="review.php?q='.$this->quiz->id.'&attempt='.$attempt->attempt.'">'.$timefinish.'</a>';
} else {
return $timefinish;
}
} else {
return '-';
}
} else {
return '-';
}
}

</pre>

Where you do not know the names of the columns at the time of writing the class definition then you can use other_cols method. Eg.
<pre>
function other_cols($colname, $attempt){
if (preg_match('/^qsgrade([0-9]+)$/', $colname, $matches)){
$questionid = $matches[1];
$question = $this->questions[$questionid];
$state = new object();
$state->event = $attempt->{'qsevent'.$questionid};
if (question_state_is_graded($state)) {
$grade = quiz_rescale_grade($attempt->{'qsgrade'.$questionid}, $this->quiz);
} else {
$grade = '--';
}
if (!$this->is_downloading()) {
$grade = $grade.'/'.quiz_rescale_grade($question->grade, $this->quiz);
return link_to_popup_window('/mod/quiz/reviewquestion.php?state='.
$attempt->{'qsid'.$questionid}.'&number='.$question->number,
'reviewquestion', $grade, 450, 650, get_string('reviewresponse', 'quiz'),
'none', true);
} else {
return $grade;
}
} else {
return NULL;
}
}
</pre>

If there is no method col_{column name} and other_cols returns NULL then the column data is put straight in the table unprocessed.

===Use your table class===

<pre>
//start page
$download = optional_param('download', '', PARAM_ALPHA);

$table = new name_of_your_table('uniqueid');
$table->is_downloading($download, $filenamefordownload, $sheettitle);
if (!$table->is_downloading()) {
// Only print headers if not asked to download data
$this->print_header_and_tabs($cm, $course, $quiz, "overview");
}
//various page set up stuff
if (!$table->is_downloading()) { //do not print notices when downloading
//wrap output of html in these if conditions
}

//work out the sql for the table.

//use this method only if you want to specify some sql with less joins for
//counting the total records
$table->set_count_sql("SELECT COUNT(1) FROM $from WHERE $where");

if ($something) {
// Add some more joins
}

$table->set_sql($fields, $from, $where);
// Define table columns
$columns = array();
$headers = array();

if (!$table->is_downloading() && $candelete) {
$columns[]= 'checkbox';
$headers[]= NULL;
}

if (!$table->is_downloading() && $CFG->grade_report_showuserimage) {
$columns[]= 'picture';
$headers[]= '';
}
if (!$table->is_downloading()){
$columns[]= 'fullname';
$headers[]= get_string('name');
} else {
$columns[]= 'lastname';
$headers[]= get_string('lastname');
$columns[]= 'firstname';
$headers[]= get_string('firstname');
}

if ($CFG->grade_report_showuseridnumber) {
$columns[]= 'idnumber';
$headers[]= get_string('idnumber');
}

$columns[]= 'timestart';
$headers[]= get_string('startedon', 'quiz');

$columns[]= 'timefinish';
$headers[]= get_string('timecompleted','quiz');

$columns[]= 'duration';
$headers[]= get_string('attemptduration', 'quiz');

if ($detailedmarks) {
foreach ($questions as $id => $question) {
// Ignore questions of zero length
$columns[] = 'qsgrade'.$id;
$headers[] = '#'.$question->number;
}
}

if ($showgrades) {
$columns[] = 'sumgrades';
$headers[] = get_string('grade', 'quiz').'/'.$quiz->grade;
}

if ($hasfeedback) {
$columns[] = 'feedbacktext';
$headers[] = get_string('feedback', 'quiz');
}

$table->define_columns($columns);
$table->define_headers($headers);
$table->sortable(true, 'uniqueid');

// Set up the table some of these settings will be ignored for downloads
$table->define_baseurl($reporturl->out(false, $displayoptions));

$table->column_suppress('picture');
$table->column_suppress('fullname');
$table->column_suppress('idnumber');

$table->no_sorting('feedbacktext');

$table->column_class('picture', 'picture');
$table->column_class('fullname', 'bold');
$table->column_class('sumgrades', 'bold');

$table->set_attribute('id', 'attempts');

$table->out($pagesize, $useinitialsbar);

if (!$table->is_downloading()) {
//footer and other html stuff to display
}
</pre>

==Adding download capability to existing tables==

To add download to existing tables. You must :

Add :

<pre>
$download = optional_param('download', '', PARAM_ALPHA);
</pre>

To top of page.

Probably more table instantiation to top of page.

Add just after table object instantiation :

<pre>
$table->is_downloading($download, 'test',
'testing123');
</pre>

Wrap all html output with condition :
<pre>
if (!$table->is_downloading()) {
</pre>

Make sure you have this method call somewhere :

<pre>
$table->define_baseurl($reporturl->out(false, $displayoptions));
</pre>

Replace :

<pre>
$table->print_html();
</pre>

With :

<pre>
$table->finish_output();
</pre>

Download buttons will automagically appear.

==See also==

* The phpdoc comments on the class flexible_table and table_sql in tablelib.php
* [http://tracker.moodle.org/browse/MDL-14187 Discussion in tracker]

lib/tablelib.php

2014-11-17T22:06:30Z

Charlesverge: /* Skeleton Usage */ Updated code sample to be compatible with $PAGE->navbar

==Status of this doc==

This doc is a description of proposed additions to the api for using tablelib. It has not yet been agreed on. Seemed a good idea to create it at this url rather than some development notes page for instance so that the history of this page will include the changes made to the original proposal.

==What changes in the new api?==

* Currently the code for creating table often involves a lot of duplication of code. New api can improve things.
* New API handles downloads
** download export formats are seperated into classes and it is simple to add more formats. Added two more formats. Unpaged XHTML format and comma seperated values format.
* No longer have to make sure that column data is added to the table in the same order as columns are declared. Can have the logic for choosing what columns to include in the table in one place.
* New mechanism in table_sql allows appropriate code to be automatically called to format data before putting it into the table.

==Skeleton Usage==

In order to check your sql query is working as expected when developing a page it can be useful just to output all the data from the query in the table before going on to work out how you want to format data. The code below will output all the data from your query in a collapsible, sortable table. It automatically displays all columns returned from the db.

You should go on to :
*specify what columns to include in the table and what names to display for the columns using define_columms and define_headers
*use your own child class of easy_table and define methods col_{columnname} to add hyperlinks etc to the table. You can also use method other_cols.

See below for examples of typical usage.

<pre>
<?php // $Id$
/**
* Simple file test.php to drop into root of Moodle installation.
* This is the skeleton code to print a downloadable, paged, sorted table of
* data from a sql query.
*/
require "config.php";
require "$CFG->libdir/tablelib.php";
$context = context_system::instance();
$PAGE->set_context($context);
$PAGE->set_url('/test.php');

$download = optional_param('download', '', PARAM_ALPHA);

$table = new table_sql('uniqueid');
$table->is_downloading($download, 'test', 'testing123');

if (!$table->is_downloading()) {
// Only print headers if not asked to download data
/// Print the page header
$PAGE->set_title('Testing');
$PAGE->set_heading('Testing table class');
$PAGE->navbar->add('Testing table class', new moodle_url('/test.php'));
echo $OUTPUT->header();
//print_header_simple('Testing ', 'Testing table class', $navigation);
}

//work out the sql for the table.
$table->set_sql('*', "{$CFG->prefix}user", '1');

$table->define_baseurl("$CFG->wwwroot/test.php");

$table->out(40, true);

if (!$table->is_downloading()) {
$OUTPUT->footer();
}
</pre>

==The Next Step : Typical Usage==

===Define table===

Define table class in file somethingsomthing_table.php

In the file define a child class of 'sql_table'. Mostly this child class will just contain methods to format data for display.

====Format data for display====

Define methods col_{colmname} to process data from db and to add it to table. Eg. Here is an example from table class quiz_report_overview_table

<pre>
function col_timefinish($attempt){
if ($attempt->attempt) {
if ($attempt->timefinish) {
$timefinish = userdate($attempt->timefinish, $this->strtimeformat);
if (!$this->is_downloading()) {
return '<a href="review.php?q='.$this->quiz->id.'&attempt='.$attempt->attempt.'">'.$timefinish.'</a>';
} else {
return $timefinish;
}
} else {
return '-';
}
} else {
return '-';
}
}

</pre>

Where you do not know the names of the columns at the time of writing the class definition then you can use other_cols method. Eg.
<pre>
function other_cols($colname, $attempt){
if (preg_match('/^qsgrade([0-9]+)$/', $colname, $matches)){
$questionid = $matches[1];
$question = $this->questions[$questionid];
$state = new object();
$state->event = $attempt->{'qsevent'.$questionid};
if (question_state_is_graded($state)) {
$grade = quiz_rescale_grade($attempt->{'qsgrade'.$questionid}, $this->quiz);
} else {
$grade = '--';
}
if (!$this->is_downloading()) {
$grade = $grade.'/'.quiz_rescale_grade($question->grade, $this->quiz);
return link_to_popup_window('/mod/quiz/reviewquestion.php?state='.
$attempt->{'qsid'.$questionid}.'&number='.$question->number,
'reviewquestion', $grade, 450, 650, get_string('reviewresponse', 'quiz'),
'none', true);
} else {
return $grade;
}
} else {
return NULL;
}
}
</pre>

If there is no method col_{column name} and other_cols returns NULL then the column data is put straight in the table unprocessed.

===Use your table class===

<pre>
//start page
$download = optional_param('download', '', PARAM_ALPHA);

$table = new name_of_your_table('uniqueid');
$table->is_downloading($download, $filenamefordownload, $sheettitle);
if (!$table->is_downloading()) {
// Only print headers if not asked to download data
$this->print_header_and_tabs($cm, $course, $quiz, "overview");
}
//various page set up stuff
if (!$table->is_downloading()) { //do not print notices when downloading
//wrap output of html in these if conditions
}

//work out the sql for the table.

//use this method only if you want to specify some sql with less joins for
//counting the total records
$table->set_count_sql("SELECT COUNT(1) FROM $from WHERE $where");

if ($something) {
// Add some more joins
}

$table->set_sql($fields, $from, $where);
// Define table columns
$columns = array();
$headers = array();

if (!$table->is_downloading() && $candelete) {
$columns[]= 'checkbox';
$headers[]= NULL;
}

if (!$table->is_downloading() && $CFG->grade_report_showuserimage) {
$columns[]= 'picture';
$headers[]= '';
}
if (!$table->is_downloading()){
$columns[]= 'fullname';
$headers[]= get_string('name');
} else {
$columns[]= 'lastname';
$headers[]= get_string('lastname');
$columns[]= 'firstname';
$headers[]= get_string('firstname');
}

if ($CFG->grade_report_showuseridnumber) {
$columns[]= 'idnumber';
$headers[]= get_string('idnumber');
}

$columns[]= 'timestart';
$headers[]= get_string('startedon', 'quiz');

$columns[]= 'timefinish';
$headers[]= get_string('timecompleted','quiz');

$columns[]= 'duration';
$headers[]= get_string('attemptduration', 'quiz');

if ($detailedmarks) {
foreach ($questions as $id => $question) {
// Ignore questions of zero length
$columns[] = 'qsgrade'.$id;
$headers[] = '#'.$question->number;
}
}

if ($showgrades) {
$columns[] = 'sumgrades';
$headers[] = get_string('grade', 'quiz').'/'.$quiz->grade;
}

if ($hasfeedback) {
$columns[] = 'feedbacktext';
$headers[] = get_string('feedback', 'quiz');
}

$table->define_columns($columns);
$table->define_headers($headers);
$table->sortable(true, 'uniqueid');

// Set up the table some of these settings will be ignored for downloads
$table->define_baseurl($reporturl->out(false, $displayoptions));

$table->column_suppress('picture');
$table->column_suppress('fullname');
$table->column_suppress('idnumber');

$table->no_sorting('feedbacktext');

$table->column_class('picture', 'picture');
$table->column_class('fullname', 'bold');
$table->column_class('sumgrades', 'bold');

$table->set_attribute('id', 'attempts');

$table->out($pagesize, $useinitialsbar);

if (!$table->is_downloading()) {
//footer and other html stuff to display
}
</pre>

==Adding download capability to existing tables==

To add download to existing tables. You must :

Add :

<pre>
$download = optional_param('download', '', PARAM_ALPHA);
</pre>

To top of page.

Probably more table instantiation to top of page.

Add just after table object instantiation :

<pre>
$table->is_downloading($download, 'test',
'testing123');
</pre>

Wrap all html output with condition :
<pre>
if (!$table->is_downloading()) {
</pre>

Make sure you have this method call somewhere :

<pre>
$table->define_baseurl($reporturl->out(false, $displayoptions));
</pre>

Replace :

<pre>
$table->print_html();
</pre>

With :

<pre>
$table->finish_output();
</pre>

Download buttons will automagically appear.

==See also==

* The phpdoc comments on the class flexible_table and table_sql in tablelib.php
* [http://tracker.moodle.org/browse/MDL-14187 Discussion in tracker]