Class to display a tag cloud - set of tags where each has a weight. More...

Inheritance diagram for core_tag\output\tagcloud:

Public Member Functions
	__construct ($tagset, $totalcount=0, $fromctx=0, $ctx=0, $rec=1)
	Constructor. More...

	export_for_template (renderer_base $output)
	Export this data so it can be used as the context for a mustache template. More...

	get_count ()
	Returns number of tags in the cloud. More...

Detailed Description

Class to display a tag cloud - set of tags where each has a weight.

Constructor & Destructor Documentation

core_tag\output\tagcloud::__construct	(	$tagset,
		$totalcount = `0`,
		$fromctx = `0`,
		$ctx = `0`,
		$rec = `1`
	)

Constructor.

Parameters

array	$tagset	array of core_tag or stdClass elements, each of them must have attributes: name, rawname, tagcollid preferrably also have attributes: isstandard, count, flag
int	$totalcount	total count of tags (for example to indicate that there are more tags than the count of tagset) leave 0 if count of tagset is the actual count of tags
int	$fromctx	context id where this tag cloud is displayed
int	$ctx	context id for tag view link
int	$rec	recursive argument for tag view link

core_tag\output\tagcloud::export_for_template ( renderer_base $output )

Export this data so it can be used as the context for a mustache template.

Parameters

renderer_base $output

Return values

stdClass

Implements templatable.

core_tag\output\tagcloud::get_count ( )

Returns number of tags in the cloud.

Return values

int

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