tool_uploaduser\preview Class Reference

Display the preview of a CSV file. More...

Inheritance diagram for tool_uploaduser\preview:

Public Member Functions
	__construct (\csv_import_reader $cir, array $filecolumns, int $previewrows)
	preview constructor.
	get_no_error ()
	Getter for noerror.

Public Attributes
array	$align
	An array of column alignments.
array	$attributes = array()
	Attributes of HTML attributes for the.
string	$caption
	Caption for the table, typically a title.
bool	$captionhide = false
	Whether to hide the table's caption from sighted users.
int	$cellpadding = null
int	$cellspacing = null
	Spacing between cells, in pixels.
string	$class
	class name to add to this html table.
array	$colclasses
	An array of classes to add to every cell in a particular column, space-separated string.
array	$data = []
	Array of arrays or html_table_row objects containing the data.
array	$head
	An array of headings.
array	$headspan
	An array that can be used to make a heading span multiple columns.
string	$id = null
	Value to use for the id attribute of the table.
bool	$responsive = true
	Whether to make the table to be scrolled horizontally with ease.
array	$rowclasses
	Array of classes to add to particular rows, space-separated string.
array	$size
	The value is used as CSS 'size' property.
string	$summary
	Description of the contents for screen readers.
string	$tablealign = null
string	$width = null
array	$wrap
	An array of wrapping information.

Protected Member Functions
	read_data ()
	Read data.

Protected Attributes
csv_import_reader	$cir
array	$filecolumns
bool	$noerror = true
int	$previewrows

Detailed Description

Display the preview of a CSV file.

Copyright

2020 Marina Glancy

License

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

Constructor & Destructor Documentation

__construct()

tool_uploaduser\preview::__construct	(	\csv_import_reader	$cir,
		array	$filecolumns,
		int	$previewrows )

preview constructor.

Parameters

csv_import_reader	$cir
array	$filecolumns
int	$previewrows

Exceptions

coding_exception

Member Function Documentation

get_no_error()

tool_uploaduser\preview::get_no_error

(

)

Getter for noerror.

Return values

bool

read_data()

tool_uploaduser\preview::read_data ( )

protected

Read data.

Return values

array

Exceptions

coding_exception
dml_exception
moodle_exception

Member Data Documentation

$align

array html_table::$align

inherited

An array of column alignments.

The value is used as CSS 'text-align' property. Therefore, possible values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective of a left-to-right (LTR) language. For RTL, the values are flipped automatically.

Examples of usage: $t->align = array(null, 'right'); or $t->align[1] = 'right';

$attributes

array html_table::$attributes = array()

inherited

Attributes of HTML attributes for the.

$caption

string html_table::$caption

inherited

Caption for the table, typically a title.

Example of usage: $t->caption = "TV Guide";

$captionhide

bool html_table::$captionhide = false

inherited

Whether to hide the table's caption from sighted users.

Example of usage: $t->caption = "TV Guide"; $t->captionhide = true;

$cellpadding

int html_table::$cellpadding = null

inherited

Deprecated

since Moodle 2.0. Styling should be in the CSS. Padding on each cell, in pixels

$cellspacing

int html_table::$cellspacing = null

inherited

Spacing between cells, in pixels.

Deprecated

since Moodle 2.0. Styling should be in the CSS.

$colclasses

array html_table::$colclasses

inherited

An array of classes to add to every cell in a particular column, space-separated string.

Class 'cell' is added automatically by the renderer. Classes 'c0' or 'c1' are added automatically for every odd or even column, respectively. Class 'lastcol' is added automatically for all last cells in a row.

Example of usage: $t->colclasses = array(null, 'grade');

$data

array html_table::$data = []

inherited

Array of arrays or html_table_row objects containing the data.

Alternatively, if you have $head specified, the string 'hr' (for horizontal ruler) can be used instead of an array of cells data resulting in a divider rendered.

Example of usage with array of arrays: $row1 = array('Harry Potter', '76 '); $row2 = array('Hermione Granger', '100 '); $t->data = array($row1, $row2);

Example with array of html_table_row objects: (used for more fine-grained control) $cell1 = new html_table_cell(); $cell1->text = 'Harry Potter'; $cell1->colspan = 2; $row1 = new html_table_row(); $row1->cells[] = $cell1; $cell2 = new html_table_cell(); $cell2->text = 'Hermione Granger'; $cell3 = new html_table_cell(); $cell3->text = '100 '; $row2 = new html_table_row(); $row2->cells = array($cell2, $cell3); $t->data = array($row1, $row2);

$head

array html_table::$head

inherited

An array of headings.

The n-th array item is used as a heading of the n-th column. For more control over the rendering of the headers, an array of html_table_cell objects can be passed instead of an array of strings.

Example of usage: $t->head = array('Student', 'Grade');

$headspan

array html_table::$headspan

inherited

An array that can be used to make a heading span multiple columns.

In this example, html_table:$data is supposed to have three columns. For the first two columns, the same heading is used. Therefore, html_table::$head should consist of two items.

Example of usage: $t->headspan = array(2,1);

$responsive

bool html_table::$responsive = true

inherited

Whether to make the table to be scrolled horizontally with ease.

Make table responsive across all viewports.

$rowclasses

array html_table::$rowclasses

inherited

Array of classes to add to particular rows, space-separated string.

Class 'lastrow' is added automatically for the last row in the table.

Example of usage: $t->rowclasses[9] = 'tenth'

$size

array html_table::$size

inherited

The value is used as CSS 'size' property.

Examples of usage: $t->size = array('50', '50'); or $t->size[1] = '120px';

$summary

string html_table::$summary

inherited

Description of the contents for screen readers.

The "summary" attribute on the "table" element is not supported in HTML5. Consider describing the structure of the table in a "caption" element or in a "figure" element containing the table; or, simplify the structure of the table so that no description is needed.

Deprecated

since Moodle 3.9.

$tablealign

string html_table::$tablealign = null

inherited

Deprecated

since Moodle 2.0. Styling should be in the CSS. Alignment for the whole table. Can be 'right', 'left' or 'center' (default).

$width

string html_table::$width = null

inherited

Deprecated

since Moodle 2.0. Styling should be in the CSS. Width of the table, percentage of the page preferred.

$wrap

array html_table::$wrap

inherited

An array of wrapping information.

The only possible value is 'nowrap' that sets the CSS property 'white-space' to the value 'nowrap' in the given column.

Example of usage: $t->wrap = array(null, 'nowrap');

---

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

• admin/tool/uploaduser/classes/preview.php