lib/tablelib.php - Revision history

Wuzi1999: /* Column styling and alignment */

2022-06-22T15:57:39Z

Column styling and alignment

← Older revision		Revision as of 15:57, 22 June 2022
Line 374:		Line 374:
	// Using css classes		// Using css classes
	$this->column_class('time', 'text-right');		$this->column_class('time', 'text-right');

			You also have the option of a quick align configuration as follows:
			$table->align = ['left', 'left', 'center', 'center', 'center', 'right', 'center', 'center'];

			You define the alignment for as many columns as you have in the table, or just the first ones up to your needed one, it can cope with either, as any undefined columns at the end just default to left.
			This should also be called during the table initialisation before the first call to "setup()".

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

Brendanheywood: /* Column styling and alignment */

2021-08-25T13:37:45Z

Column styling and alignment

← Older revision		Revision as of 13:37, 25 August 2021
Line 366:		Line 366:
	== Sorting on text columns ==		== Sorting on text columns ==
	There is a function "text_sorting($columnname)" for the class flexible_table which allows you to specify which columns are of type "text" so they can be sorted correctly in all databases (currently required for Oracle). This should be called during the table initialisation before the first call to "setup()".		There is a function "text_sorting($columnname)" for the class flexible_table which allows you to specify which columns are of type "text" so they can be sorted correctly in all databases (currently required for Oracle). This should be called during the table initialisation before the first call to "setup()".

	== Column styling and alignment ==		== Column styling and alignment ==
	Arbitrary styles can be added to each column:		Arbitrary styles can be added to each column:
			// Using direct styles
	$table->column_style('restore', 'text-align', 'center');		$table->column_style('restore', 'text-align', 'center');
	$table->column_style('date', 'text-align', 'right');		$table->column_style('date', 'text-align', 'right');

			// Using css classes
			$this->column_class('time', 'text-right');
	==See also==		==See also==
	* The phpdoc comments on the class flexible_table and table_sql in tablelib.php		* The phpdoc comments on the class flexible_table and table_sql in tablelib.php
	* [http://tracker.moodle.org/browse/MDL-14187 Discussion in tracker]		* [http://tracker.moodle.org/browse/MDL-14187 Discussion in tracker]

Brendanheywood: Column styling and alignment

2021-08-25T13:33:40Z

Column styling and alignment

Show changes

Mudrd8mz: /* Skeleton Usage */ PHP syntax highlight

2021-08-03T16:40:58Z

Skeleton Usage: PHP syntax highlight

← Older revision		Revision as of 16:40, 3 August 2021
Line 21:		Line 21:
	See below for examples of typical usage.		See below for examples of typical usage.

	<~~pre~~>		<syntaxhighlight lang="php">
	<?php ~~// $Id$~~		<?php
	/**		/**
	* Simple file test.php to drop into root of Moodle installation.		* Simple file test.php to drop into root of Moodle installation.
Line 58:		Line 58:
	echo $OUTPUT->footer();		echo $OUTPUT->footer();
	}		}
	</~~pre~~>		</syntaxhighlight>

	==The Next Step : Typical Usage==		==The Next Step : Typical Usage==

Mudrd8mz: Text replacement - "`" to ""`


2021-07-14T20:37:17Z
Text replacement - "<code php>" to "<syntaxhighlight lang="php">"

				
				
				
				
				
				← Older revision
				Revision as of 20:37, 14 July 2021
				
Line 124:
Line 124:
===Use your table class=== ===Use your table class===



<code php> <syntaxhighlight lang="php">
         // Start page          // Start page
         $download = optional_param('download', '', PARAM_ALPHA);          $download = optional_param('download', '', PARAM_ALPHA);

`Mudrd8mz: Text replacement - "`" to ""

2021-07-14T20:23:48Z

Text replacement - "</code>" to "</syntaxhighlight>"

← Older revision		Revision as of 20:23, 14 July 2021
Line 245:		Line 245:
	// Footer and other html stuff to display.		// Footer and other html stuff to display.
	}		}
	</~~code~~>		</syntaxhighlight>

	Note that define_help_for_headers is optional, but if any column needs help, you need to use NULL for the other columns		Note that define_help_for_headers is optional, but if any column needs help, you need to use NULL for the other columns

Brendanheywood at 00:55, 28 June 2021

2021-06-28T00:55:34Z

← Older revision		Revision as of 00:55, 28 June 2021
Line 1:		Line 1:
	==Status of this doc==		==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.		This doc is a description of the api for using tablelib.

	==What changes in the new api?==		==What changes in the new api?==
Line 7:		Line 7:
	* Currently the code for creating table often involves a lot of duplication of code. New api can improve things.		* Currently the code for creating table often involves a lot of duplication of code. New api can improve things.
	* New API handles downloads		* 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.		** download export formats are separated 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.		* 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.		* New mechanism in table_sql allows appropriate code to be automatically called to format data before putting it into the table.

Oa73neve: Where-clause in set_sql needs to be '1=1' in order to work for PostgreSQL. This version only works for MSSQL/MariaDB.

2019-11-06T13:40:28Z

Where-clause in set_sql needs to be '1=1' in order to work for PostgreSQL. This version only works for MSSQL/MariaDB.

← Older revision		Revision as of 13:40, 6 November 2019
Line 49:		Line 49:

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

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

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

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

Oa73neve: Add echo to footer output. Else the menu and the footer are not rendered and you cannot use AMD/Javascript...

2019-10-09T13:44:29Z

Add echo to footer output. Else the menu and the footer are not rendered and you cannot use AMD/Javascript...

← Older revision		Revision as of 13:44, 9 October 2019
Line 56:		Line 56:

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

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

Johnok: Document define_help_for_headers

2015-10-06T05:27:22Z

Document define_help_for_headers

← Older revision		Revision as of 05:27, 6 October 2015
Line 124:		Line 124:
	===Use your table class===		===Use your table class===

	<~~pre~~>		<code php>
	// Start page		// Start page
	$download = optional_param('download', '', PARAM_ALPHA);		$download = optional_param('download', '', PARAM_ALPHA);
Line 153:		Line 153:
	$columns = array();		$columns = array();
	$headers = array();		$headers = array();
			$help = array();


Line 158:		Line 159:
	$columns[]= 'checkbox';		$columns[]= 'checkbox';
	$headers[]= NULL;		$headers[]= NULL;
			$help[] = NULL;
	}		}

Line 163:		Line 165:
	$columns[]= 'picture';		$columns[]= 'picture';
	$headers[]= '';		$headers[]= '';
			$help[] = NULL;
	}		}
	if (!$table->is_downloading()){		if (!$table->is_downloading()){
	$columns[]= 'fullname';		$columns[]= 'fullname';
	$headers[]= get_string('name');		$headers[]= get_string('name');
			$help[] = NULL;
	} else {		} else {
	$columns[]= 'lastname';		$columns[]= 'lastname';
	$headers[]= get_string('lastname');		$headers[]= get_string('lastname');
			$help[] = NULL;
	$columns[]= 'firstname';		$columns[]= 'firstname';
	$headers[]= get_string('firstname');		$headers[]= get_string('firstname');
			$help[] = NULL;
	}		}

Line 177:		Line 183:
	$columns[]= 'idnumber';		$columns[]= 'idnumber';
	$headers[]= get_string('idnumber');		$headers[]= get_string('idnumber');
			$help[] = NULL;
	}		}

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

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

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

	if ($detailedmarks) {		if ($detailedmarks) {
Line 193:		Line 203:
	$columns[] = 'qsgrade'.$id;		$columns[] = 'qsgrade'.$id;
	$headers[] = '#'.$question->number;		$headers[] = '#'.$question->number;
			$help[] = NULL;
	}		}
	}		}
Line 199:		Line 210:
	$columns[] = 'sumgrades';		$columns[] = 'sumgrades';
	$headers[] = get_string('grade', 'quiz').'/'.$quiz->grade;		$headers[] = get_string('grade', 'quiz').'/'.$quiz->grade;
			$help[] = new help_icon('grade', 'quiz', 'moodle', '');
	}		}

Line 204:		Line 216:
	$columns[] = 'feedbacktext';		$columns[] = 'feedbacktext';
	$headers[] = get_string('feedback', 'quiz');		$headers[] = get_string('feedback', 'quiz');
			$help[] = new help_icon('feedback', 'quiz', 'moodle', '');
	}		}

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

Line 231:		Line 245:
	// Footer and other html stuff to display.		// Footer and other html stuff to display.
	}		}
	</~~pre~~>		</code>

			Note that define_help_for_headers is optional, but if any column needs help, you need to use NULL for the other columns

	==Complete sql table class example==		==Complete sql table class example==

← Older revision		Revision as of 20:37, 14 July 2021
Line 124:		Line 124:
	===Use your table class===		===Use your table class===

	<~~code~~ php>		<syntaxhighlight lang="php">
	// Start page		// Start page
	$download = optional_param('download', '', PARAM_ALPHA);		$download = optional_param('download', '', PARAM_ALPHA);

lib/tablelib.php - Revision history

Wuzi1999: /* Column styling and alignment */

Brendanheywood: /* Column styling and alignment */

Brendanheywood: Column styling and alignment

Mudrd8mz: /* Skeleton Usage */ PHP syntax highlight

Mudrd8mz: Text replacement - "" to ""

Mudrd8mz: Text replacement - "" to ""

Brendanheywood at 00:55, 28 June 2021

Oa73neve: Where-clause in set_sql needs to be '1=1' in order to work for PostgreSQL. This version only works for MSSQL/MariaDB.

Oa73neve: Add echo to footer output. Else the menu and the footer are not rendered and you cannot use AMD/Javascript...

Johnok: Document define_help_for_headers

Mudrd8mz: Text replacement - "`" to ""`

`Mudrd8mz: Text replacement - "`" to ""