PDF Class Reference

Inheritance diagram for PDF:

List of all members.

Public Member Functions
	PDF ($data)
	getId ()
	getReportId ()
	getPerson ()
	getGenerationPerson ()
	getSubmissionPerson ()
	getSubmissionUserId ()
	getYear ()
	getType ()
	getTimestamp ()
	isSubmitted ()
	getUrl ()
	getProjectId ()
	getProject ()
	getTitle ()
	getPDF ()
	canUserRead ()
	create ()
	update ()
	delete ()
	toArray ()
	exists ()
	getCacheId ()
Static Public Member Functions
static	newFromId ($id)
static	newFromToken ($tok)
static	getAllPDFs ()
Public Attributes
	$id
	$reportId
	$userId
	$generationUserId
	$submissionUserId
	$year
	$type
	$submitted
	$timestamp
	$encrypted
	$project = false
	$projectId = 0

---

Member Function Documentation

PDF::canUserRead

(

)

Returns whether the current user can read the PDF or not

Returns:

boolean Whether or not the current user can read this PDF

PDF::create

(

)

Creates a new record in the DB for this BackboneModel

Returns:

boolean Returns whether or not the creation was successful or not

Reimplemented from BackboneModel.

PDF::delete

(

)

Deletes the record in the DB for this BackboneModel

Returns:

boolean Returns whether or not the deletion was successful or not

Reimplemented from BackboneModel.

PDF::exists

(

)

Returns whether or not this BackboneModel exists or not

Returns:

boolean Returns whether or not this BackboneModel exists or not

Reimplemented from BackboneModel.

PDF::getCacheId

(

)

Returns the id of this BackboneModel's cache

Returns:

string Returns the id of this BackboneModel's cache

Reimplemented from BackboneModel.

PDF::getId

(

)

Returns:

int Returns the id of this BackboneModel

Reimplemented from BackboneModel.

PDF::getPDF

(

)

Returns the PDF data. If the user is not allowed to read this PDF, then null is returned

Returns:

string The PDF data, or null if the user is not allowed to read this PDF

static PDF::newFromId

(

$

id

)

[static]

Returns a new PDF using the given report_id

Parameters:

int

$id The report id of the pdf

Returns:

PDF The PDF that matches the report_id

static PDF::newFromToken

(

$

tok

)

[static]

Returns a new PDF using the given token

Parameters:

string

$tok The token of the pdf

Returns:

PDF The PDF that matches the token

PDF::toArray

(

)

Generates and returns an array version of this BackboneModel

Returns:

array Returns an array version of this BackboneModel

Reimplemented from BackboneModel.

PDF::update

(

)

Updates the record in the DB for this BackboneModel

Returns:

boolean Returns whether or not the update was successful or not

Reimplemented from BackboneModel.

---

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

• extensions/GrandObjects/PDF.php