SnapContentMediaDocument Class Reference
[Content Modules]

Content Module for Documents. More...

Inheritance diagram for SnapContentMediaDocument:

[legend]

List of all members.

Public Member Functions
	checkMedia ()
	Revalidates the document The document should have validated on upload anyway, but this function will validate everything again.
	getDocumentSuffix ()
	INSERT BRIEF DESCRIPTION HERE.
	getDocumentType ()
	INSERT BRIEF DESCRIPTION HERE.
	getPath ()
	INSERT BRIEF DESCRIPTION HERE.
	getSize ()
	INSERT BRIEF DESCRIPTION HERE.
	getURL ()
	INSERT BRIEF DESCRIPTION HERE.
	updateFileList ()
	INSERT BRIEF DESCRIPTION HERE.
	uploadDocument ($tmpFile, $fileName)
	Uploads a document to this content module.
Protected Member Functions
	doCopy ()
	INSERT BRIEF DESCRIPTION HERE.
	doDelete ()
	INSERT BRIEF DESCRIPTION HERE.
	doGetHTML ($params)
	INSERT BRIEF DESCRIPTION HERE.
	getSuffix ()
	returns the file extension
	validate ()
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

Content Module for Documents.

Supported Doctupes include: Microsoft Word 97/2000/XP/2003 Document Micrsoft Word 2007/2008 Document Adobe PDF Document Text File

Definition at line 15 of file SnapContentMediaDocument.php5.

---

Member Function Documentation

SnapContentMediaDocument::checkMedia

(

)

Revalidates the document The document should have validated on upload anyway, but this function will validate everything again.

Returns:

[boolean]: success or failure.

Reimplemented from SnapContent.

Definition at line 215 of file SnapContentMediaDocument.php5.

References validate().

SnapContentMediaDocument::doCopy

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 58 of file SnapContentMediaDocument.php5.

References SObject::getLastError(), and SObject::setError().

SnapContentMediaDocument::doDelete

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 41 of file SnapContentMediaDocument.php5.

References validate().

SnapContentMediaDocument::doGetHTML

(

$

params

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Parameters:

$params

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 94 of file SnapContentMediaDocument.php5.

References SnapContent::getLinkURL(), and validate().

SnapContentMediaDocument::getDocumentSuffix

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 175 of file SnapContentMediaDocument.php5.

References validate().

SnapContentMediaDocument::getDocumentType

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 188 of file SnapContentMediaDocument.php5.

References getSuffix().

SnapContentMediaDocument::getPath

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 161 of file SnapContentMediaDocument.php5.

References validate().

Referenced by getSize().

SnapContentMediaDocument::getSize

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 203 of file SnapContentMediaDocument.php5.

References getPath(), and validate().

SnapContentMediaDocument::getSuffix

(

)

[protected]

returns the file extension

For internal use only.

Returns:

[string]: the file extension, false on failure

Reimplemented from SnapContent.

Definition at line 27 of file SnapContentMediaDocument.php5.

References validate().

Referenced by getDocumentType().

SnapContentMediaDocument::getURL

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 147 of file SnapContentMediaDocument.php5.

References validate().

SnapContentMediaDocument::updateFileList

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 235 of file SnapContentMediaDocument.php5.

References SnapDBI::cancelTransaction(), SnapDBI::commitTransaction(), SnapDBI::startTransaction(), and validate().

SnapContentMediaDocument::uploadDocument	(	$	tmpFile,
		$	fileName
	)

Uploads a document to this content module.

Parameters:

	$tmpFile	[string]: The path to the file as it is currently stored
	$fileName	[string]: The name of the new file (path not included)

Returns:

[boolean]: success or failure.

Definition at line 119 of file SnapContentMediaDocument.php5.

References SObject::setError().

SnapContentMediaDocument::validate

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 78 of file SnapContentMediaDocument.php5.

References SnapContent::getAll().

Referenced by checkMedia(), doDelete(), doGetHTML(), getDocumentSuffix(), getPath(), getSize(), getSuffix(), getURL(), and updateFileList().

---

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

• snap2/content/SnapContentMediaDocument.php5