Represents a page for showing the given policy document version. More...

Inheritance diagram for tool_policy\output\page_viewdoc:

Public Member Functions
	__construct ($policyid, $versionid, $returnurl, $behalfid, $manage, $numpolicy=0, $totalpolicies=0)
	Prepare the page for rendering.

	export_for_template (renderer_base $output)
	Export the page data for the mustache template.

Protected Member Functions
	prepare_global_page_access ()
	Sets up the global $PAGE and performs the access checks.

	prepare_policy ($policyid, $versionid)
	Loads the policy version to display on the page.

Protected Attributes
int	$behalfid = null
	User id who wants to view this page.

bool	$manage
	View the policy as a part of the management UI.

int	$numpolicy = 0
	Position of the current policy with respect to the total of policy docs to display.

stdClass	$policy
	Exported tool_policy::policy_version_exporter to display on this page.

string	$returnurl = null
	Return URL.

int	$totalpolicies = 0
	Total number of policy documents which the user has to agree to.

Detailed Description

Represents a page for showing the given policy document version.

Constructor & Destructor Documentation

tool_policy\output\page_viewdoc::__construct	(	$policyid,
		$versionid,
		$returnurl,
		$behalfid,
		$manage,
		$numpolicy = 0,
		$totalpolicies = 0 )

Prepare the page for rendering.

Parameters

int	$policyid	The policy id for this page.
int	$versionid	The version id to show. Empty tries to load the current one.
string	$returnurl	URL of a page to continue after reading the policy text.
int	$behalfid	The userid to view this policy version as (such as child's id).
bool	$manage	View the policy as a part of the management UI.
int	$numpolicy	Position of the current policy with respect to the total of policy docs to display.
int	$totalpolicies	Total number of policy documents which the user has to agree to.

tool_policy\output\page_viewdoc::export_for_template ( renderer_base $output )

Export the page data for the mustache template.

Parameters

renderer_base $output renderer to be used to render the page elements.

Return values

stdClass

Implements templatable.

tool_policy\output\page_viewdoc::prepare_policy	(		$policyid,
			$versionid )

protected

Loads the policy version to display on the page.

Parameters

int	$policyid	The policy id for this page.
int	$versionid	The version id to show. Empty tries to load the current one.

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