AbstractReport Class Reference

List of all members.

Public Member Functions
	AbstractReport ($xmlFileName, $personId=-1, $projectName=false, $topProjectOnly=false, $year=REPORTING_YEAR, $quick=false)
	execute ()
	notifySupervisors ($tok)
	getLatestPDF ()
	getPDF ($submittedByOwner=false)
	setName ($name)
	setHeaderName ($name)
	setExtends ($extends)
	setDisabled ($disabled)
	setReportType ($type)
	setPDFType ($type)
	setPDFFiles ($files)
	setPDFAllProjects ($allProjects)
	setHeader ($header)
	setEncrypt ($encrypt)
	addSection ($section, $position=null)
	deleteSection ($section)
	getSectionById ($sectionId)
	hasSubReport ()
	addPermission ($type, $permission, $start=null, $end=null)
	addSectionPermission ($sectionId, $role, $permissions)
	getPercentChars ()
	getPDFRenderableSections ()
	hasStarted ($deep=false)
	isComplete ()
	checkPermissions ()
	getSectionPermissions ($section)
	generatePDF ($person=null, $submit=false)
	submitReport ($person=null)
	isSubmitted ()
	render ()
	renderTabs ()
	renderOptions ()
	renderBackup ()
	renderForPDF ()
	getVariable ($key)
	setVariable ($key, $value, $depth=0)
	varSubstitute ($value)
Static Public Member Functions
static	newFromToken ($tok, $type="")
static	checkImpersonationPermissions ($person, $realPerson, $ns, $title, $pageAllowed)
static	impersonationMessage ($person, $realPerson, $ns, $title, $message)
static	canUserReadPDF ($me, $pdf, $result)
static	downloadBlob ($action)
static	blobConstant ($constant)
static	tinyMCEUpload ($action)
Public Attributes
	$name
	$year
	$startDate
	$endDate
	$xmlName
	$extends
	$reportType
	$ajax
	$header
	$headerName
	$sections
	$currentSection
	$permissions
	$sectionPermissions
	$person
	$project
	$readOnly = false
	$topProjectOnly
	$generatePDF
	$orientation
	$pdfType
	$pdfFiles
	$pdfAllProjects
	$prepend = false
	$showInstructions = true
	$allowIdProjects = false
	$encrypt = false
	$variables = array()

---

Member Function Documentation

AbstractReport::getVariable

(

$

key

)

Returns the value of the variable with the given key

Parameters:

string

$key The key of the variable

Returns:

string The value of the variable if found

AbstractReport::hasStarted

(

$

deep = false

)

Returns whether or not the Person has started the report yet

Returns:

boolean Whether or not the Person has started the report yet

AbstractReport::isComplete

(

)

Returns whether or not the Report is complete or not

Returns:

boolean Whether or not the Report is complete or not

static AbstractReport::newFromToken	(	$	tok,
		$	type = ""
	)			[static]

Parameters:

string

$tok

Returns:

DummyReport Returns the DummyReport associated with the given $tok

AbstractReport::setVariable	(	$	key,
		$	value,
		$	depth = 0
	)

Sets the value of the variable with the given key to the given value

Parameters:

	string	$key The key of the variable
	string	$value The value of the variable
	integer	$depth The depth of the function call (should not need to ever pass this)

Returns:

boolean Whether or not the variable was found

---

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

• extensions/Reporting/Report/AbstractReport.php