Static Public Member Functions
static	alist (array $items, array $attributes=null, $tag='ul')
	Shortcut for quick making of lists. More...

static	attribute ($name, $value)
	Outputs a HTML attribute and value. More...

static	attributes (array $attributes=null)
	Outputs a list of HTML attributes and values. More...

static	checkbox ($name, $value, $checked=true, $label='', array $attributes=null, array $labelattributes=null)
	Generates a simple checkbox with optional label. More...

static	div ($content, $class='', array $attributes=null)
	Creates a. More...

static	empty_tag ($tagname, array $attributes=null)
	Outputs an empty tag with attributes. More...

static	end_div ()
	Ends a. More...

static	end_span ()
	Ends a tag. More...

static	end_tag ($tagname)
	Outputs a closing tag. More...

static	img ($src, $alt, array $attributes=null)
	Generates a simple image tag with attributes. More...

static	input_hidden_params (moodle_url $url, array $exclude=null)
	Returns hidden input fields created from url parameters. More...

static	label ($text, $for, $colonize=true, array $attributes=array())
	Renders form element label. More...

static	link ($url, $text, array $attributes=null)
	Generates a simple html link. More...

static	nonempty_tag ($tagname, $contents, array $attributes=null)
	Outputs a tag, but only if the contents are not empty. More...

static	random_id ($base='random')
	Generates random html element id. More...

static	script ($jscode, $url=null)
	Generate a script tag containing the the specified code. More...

static	select (array $options, $name, $selected='', $nothing=array(''=> 'choosedots'), array $attributes=null)
	Generates a simple select form field. More...

static	select_time ($type, $name, $currenttime=0, $step=5, array $attributes=null)
	This is a shortcut for making an hour selector menu. More...

static	select_yes_no ($name, $selected=true, array $attributes=null)
	Generates a simple select yes/no form field. More...

static	span ($content, $class='', array $attributes=null)
	Creates a tag. More...

static	start_div ($class='', array $attributes=null)
	Starts a. More...

static	start_span ($class='', array $attributes=null)
	Starts a tag. More...

static	start_tag ($tagname, array $attributes=null)
	Outputs an opening tag with attributes. More...

static	table (html_table $table)
	Renders HTML table. More...

static	tag ($tagname, $contents, array $attributes=null)
	Outputs a tag with attributes and contents. More...

Member Function Documentation

◆ alist()

static html_writer::alist	(	array	$items,
		array	$attributes = `null`,
			$tag = `'ul'`
	)

static

Shortcut for quick making of lists.

Note: 'list' is a reserved keyword ;-)

Parameters

array	$items
array	$attributes
string	$tag	ul or ol

Return values

string

◆ attribute()

static html_writer::attribute	(	$name,
		$value
	)

static

Outputs a HTML attribute and value.

Parameters

string	$name	The name of the attribute ('src', 'href', 'class' etc.)
string	$value	The value of the attribute. The value will be escaped with s()

Return values

string HTML fragment

◆ attributes()

static html_writer::attributes ( array $attributes = null )

static

Outputs a list of HTML attributes and values.

Parameters

array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.) The values will be escaped with s()

Return values

string HTML fragment

◆ checkbox()

static html_writer::checkbox	(		$name,
			$value,
			$checked = `true`,
			$label = `''`,
		array	$attributes = `null`,
		array	$labelattributes = `null`
	)

static

Generates a simple checkbox with optional label.

Parameters

string	$name	The name of the checkbox
string	$value	The value of the checkbox
bool	$checked	Whether the checkbox is checked
string	$label	The label for the checkbox
array	$attributes	Any attributes to apply to the checkbox
array	$labelattributes	Any attributes to apply to the label, if present

Return values

string html fragment

◆ div()

static html_writer::div	(		$content,
			$class = `''`,
		array	$attributes = `null`
	)

static

Creates a.

tag. (Shortcut function.)

Parameters

string	$content	HTML content of tag
string	$class	Optional CSS class (or classes as space-separated list)
array	$attributes	Optional other attributes as array

Return values

string HTML code for div

◆ empty_tag()

static html_writer::empty_tag	(		$tagname,
		array	$attributes = `null`
	)

static

Outputs an empty tag with attributes.

Parameters

string	$tagname	The name of tag ('input', 'img', 'br' etc.)
array	$attributes	The tag attributes (array('src' => $url, 'class' => 'class1') etc.)

Return values

string HTML fragment

◆ end_div()

static html_writer::end_div ( )

static

Ends a.

tag. (Shortcut function.)

Return values

string HTML code for close div tag

◆ end_span()

static html_writer::end_span ( )

static

Ends a tag.

(Shortcut function.)

Return values

string HTML code for close span tag

◆ end_tag()

static html_writer::end_tag ( $tagname )

static

Outputs a closing tag.

Parameters

string $tagname The name of tag ('a', 'img', 'span' etc.)

Return values

string HTML fragment

◆ img()

static html_writer::img	(		$src,
			$alt,
		array	$attributes = `null`
	)

static

Generates a simple image tag with attributes.

Parameters

string	$src	The source of image
string	$alt	The alternate text for image
array	$attributes	The tag attributes (array('height' => $max_height, 'class' => 'class1') etc.)

Return values

string HTML fragment

◆ input_hidden_params()

static html_writer::input_hidden_params	(	moodle_url	$url,
		array	$exclude = `null`
	)

static

Returns hidden input fields created from url parameters.

Parameters

moodle_url	$url
array	$exclude	list of excluded parameters

Return values

string HTML fragment

◆ label()

static html_writer::label	(		$text,
			$for,
			$colonize = `true`,
		array	$attributes = `array()`
	)

static

Renders form element label.

By default, the label is suffixed with a label separator defined in the current language pack (colon by default in the English lang pack). Adding the colon can be explicitly disabled if needed. Label separators are put outside the label tag itself so they are not read by screenreaders (accessibility).

Parameter $for explicitly associates the label with a form control. When set, the value of this attribute must be the same as the value of the id attribute of the form control in the same document. When null, the label being defined is associated with the control inside the label element.

Parameters

string	$text	content of the label tag
string \| null	$for	id of the element this label is associated with, null for no association
bool	$colonize	add label separator (colon) to the label text, if it is not there yet
array	$attributes	to be inserted in the tab, for example array('accesskey' => 'a')

Return values

string HTML of the label element

◆ link()

static html_writer::link	(		$url,
			$text,
		array	$attributes = `null`
	)

static

Generates a simple html link.

Parameters

string \| moodle_url	$url	The URL
string	$text	The text
array	$attributes	HTML attributes

Return values

string HTML fragment

◆ nonempty_tag()

static html_writer::nonempty_tag	(		$tagname,
			$contents,
		array	$attributes = `null`
	)

static

Outputs a tag, but only if the contents are not empty.

Parameters

string	$tagname	The name of tag ('a', 'img', 'span' etc.)
string	$contents	What goes between the opening and closing tags
array	$attributes	The tag attributes (array('src' => $url, 'class' => 'class1') etc.)

Return values

string HTML fragment

◆ random_id()

static html_writer::random_id ( $base = 'random' )

static

Generates random html element id.

@staticvar int $counter @staticvar type $uniq

Parameters

string $base A string fragment that will be included in the random ID.

Return values

string A unique ID

◆ script()

static html_writer::script	(	$jscode,
		$url = `null`
	)

static

Generate a script tag containing the the specified code.

Parameters

string	$jscode	the JavaScript code
moodle_url \| string	$url	optional url of the external script, $code ignored if specified

Return values

string HTML, the code wrapped in <script> tags.

◆ select()

static html_writer::select	(	array	$options,
			$name,
			$selected = `''`,
			$nothing = `array('' => 'choosedots')`,
		array	$attributes = `null`
	)

static

Generates a simple select form field.

Note this function does HTML escaping on the optgroup labels, but not on the choice labels.

Parameters

array	$options	associative array value=>label ex.: array(1=>'One, 2=>Two) it is also possible to specify optgroup as complex label array ex.: array(array('Odd'=>array(1=>'One', 3=>'Three)), array('Even'=>array(2=>'Two'))) array(1=>'One', '–1uniquekey'=>array('More'=>array(2=>'Two', 3=>'Three')))
string	$name	name of select element
string \| array	$selected	value or array of values depending on multiple attribute
array \| bool	$nothing	add nothing selected option, or false of not added
array	$attributes	html select element attributes

Return values

string HTML fragment

◆ select_time()

static html_writer::select_time	(		$type,
			$name,
			$currenttime = `0`,
			$step = `5`,
		array	$attributes = `null`
	)

static

This is a shortcut for making an hour selector menu.

Parameters

string	$type	The type of selector (years, months, days, hours, minutes)
string	$name	fieldname
int	$currenttime	A default timestamp in GMT
int	$step	minute spacing
array	$attributes	- html select element attributes

Return values

HTML fragment

◆ select_yes_no()

static html_writer::select_yes_no	(		$name,
			$selected = `true`,
		array	$attributes = `null`
	)

static

Generates a simple select yes/no form field.

Parameters

string	$name	name of select element
bool	$selected
array	$attributes	- html select element attributes

Return values

string HTML fragment

◆ span()

static html_writer::span	(		$content,
			$class = `''`,
		array	$attributes = `null`
	)

static

Creates a tag.

(Shortcut function.)

Parameters

string	$content	HTML content of tag
string	$class	Optional CSS class (or classes as space-separated list)
array	$attributes	Optional other attributes as array

Return values

string HTML code for span

◆ start_div()

static html_writer::start_div	(		$class = `''`,
		array	$attributes = `null`
	)

static

Starts a.

tag. (Shortcut function.)

Parameters

string	$class	Optional CSS class (or classes as space-separated list)
array	$attributes	Optional other attributes as array

Return values

string HTML code for open div tag

◆ start_span()

static html_writer::start_span	(		$class = `''`,
		array	$attributes = `null`
	)

static

Starts a tag.

(Shortcut function.)

Parameters

string	$class	Optional CSS class (or classes as space-separated list)
array	$attributes	Optional other attributes as array

Return values

string HTML code for open span tag

◆ start_tag()

static html_writer::start_tag	(		$tagname,
		array	$attributes = `null`
	)

static

Outputs an opening tag with attributes.

Parameters

string	$tagname	The name of tag ('a', 'img', 'span' etc.)
array	$attributes	The tag attributes (array('src' => $url, 'class' => 'class1') etc.)

Return values

string HTML fragment

◆ table()

static html_writer::table ( html_table $table )

static

Renders HTML table.

This method may modify the passed instance by adding some default properties if they are not set yet. If this is not what you want, you should make a full clone of your data before passing them to this method. In most cases this is not an issue at all so we do not clone by default for performance and memory consumption reasons.

Parameters

html_table $table data to be rendered

Return values

string HTML code

◆ tag()

static html_writer::tag	(		$tagname,
			$contents,
		array	$attributes = `null`
	)

static

Outputs a tag with attributes and contents.

Parameters

string	$tagname	The name of tag ('a', 'img', 'span' etc.)
string	$contents	What goes between the opening and closing tags
array	$attributes	The tag attributes (array('src' => $url, 'class' => 'class1') etc.)

Return values

string HTML fragment

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

lib/outputcomponents.php

Static Public Member Functions

Member Function Documentation

◆ alist()

◆ attribute()

◆ attributes()

◆ checkbox()

◆ div()

◆ empty_tag()

◆ end_div()

◆ end_span()

◆ end_tag()

◆ img()

◆ input_hidden_params()

◆ label()

◆ link()

◆ nonempty_tag()

◆ random_id()

◆ script()

◆ select()

◆ select_time()

◆ select_yes_no()

◆ span()

◆ start_div()

◆ start_span()

◆ start_tag()

◆ table()

◆ tag()