SnapContentMediaFile Class Reference
[Content Modules]

Content Module for any Media File. More...

Inheritance diagram for SnapContentMediaFile:

[legend]

List of all members.

Public Member Functions
	checkMedia ()
	INSERT BRIEF DESCRIPTION HERE.
	getFileSuffix ()
	INSERT BRIEF DESCRIPTION HERE.
	getPath ()
	INSERT BRIEF DESCRIPTION HERE.
	getSize ()
	INSERT BRIEF DESCRIPTION HERE.
	getURL ()
	INSERT BRIEF DESCRIPTION HERE.
	updateFileList ()
	INSERT BRIEF DESCRIPTION HERE.
	uploadFile ($tmpFile, $fileName)
	Uploads a file to this content module.
Protected Member Functions
	doCopy ()
	INSERT BRIEF DESCRIPTION HERE.
	doDelete ()
	INSERT BRIEF DESCRIPTION HERE.
	doGetHTML ($params)
	INSERT BRIEF DESCRIPTION HERE.
	getSuffix ()
	INSERT BRIEF DESCRIPTION HERE.
	validate ()
	INSERT BRIEF DESCRIPTION HERE.

---

Detailed Description

Content Module for any Media File.

This class allows you to upload any media file, though if the file can be supported by a different media module it is probably a better idea to use that one.

Definition at line 13 of file SnapContentMediaFile.php5.

---

Member Function Documentation

SnapContentMediaFile::checkMedia

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 187 of file SnapContentMediaFile.php5.

References validate().

SnapContentMediaFile::doCopy

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 52 of file SnapContentMediaFile.php5.

References SnapContent::copy().

SnapContentMediaFile::doDelete

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 35 of file SnapContentMediaFile.php5.

References validate().

SnapContentMediaFile::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 82 of file SnapContentMediaFile.php5.

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

SnapContentMediaFile::getFileSuffix

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 156 of file SnapContentMediaFile.php5.

References validate().

SnapContentMediaFile::getPath

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 142 of file SnapContentMediaFile.php5.

References validate().

Referenced by getSize().

SnapContentMediaFile::getSize

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 169 of file SnapContentMediaFile.php5.

References getPath(), and validate().

SnapContentMediaFile::getSuffix

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 21 of file SnapContentMediaFile.php5.

References validate().

SnapContentMediaFile::getURL

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 128 of file SnapContentMediaFile.php5.

References validate().

SnapContentMediaFile::updateFileList

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 207 of file SnapContentMediaFile.php5.

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

SnapContentMediaFile::uploadFile	(	$	tmpFile,
		$	fileName
	)

Uploads a file 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 101 of file SnapContentMediaFile.php5.

References SObject::setError().

SnapContentMediaFile::validate

(

)

[protected]

INSERT BRIEF DESCRIPTION HERE.

For internal use only.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SnapContent.

Definition at line 66 of file SnapContentMediaFile.php5.

References SnapContent::getAll().

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

---

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

• snap2/content/SnapContentMediaFile.php5