block_lp\output\summary Class Reference

Summary renderable class. More...

Inheritance diagram for block_lp\output\summary:

Public Member Functions
	__construct ($user=null)
	Constructor. More...
	export_for_template (renderer_base $output)
	Function to export the renderer data in a format that is suitable for a mustache template. More...
	has_content ()
	Returns whether there is content in the summary. More...

Protected Attributes
array	$activeplans = array()
	Active plans.
array	$compstoreview = array()
	Competencies to review.
array	$plans = array()
	Plans.
array	$planstoreview = array()
	Plans to review.
stdClass	$user
	The user.

Detailed Description

Summary renderable class.

Copyright

2016 Frédéric Massart - FMCorz.net

License

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

Constructor & Destructor Documentation

__construct()

block_lp\output\summary::__construct

(

$user = null

)

Constructor.

Parameters

stdClass

$user

The user.

Member Function Documentation

export_for_template()

block_lp\output\summary::export_for_template

(

renderer_base

$output

)

Function to export the renderer data in a format that is suitable for a mustache template.

This means:

1. No complex types - only stdClass, array, int, string, float, bool
2. Any additional info that is required for the template is pre-calculated (e.g. capability checks).

Parameters

renderer_base

$output

Used to do a final render of any components that need to be rendered for export.

Return values

stdClass|array

Implements templatable.

has_content()

block_lp\output\summary::has_content

(

)

Returns whether there is content in the summary.

Return values

boolean

---

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

• blocks/lp/classes/output/summary.php