SuppFile Class Reference
[Article]

Supplementary file class. More...

Inheritance diagram for SuppFile:

List of all members.

Public Member Functions
	getArticleId ()
	getBestSuppFileId ($journal=null)
	getCreator ($locale)
	getDateCreated ()
	getDateSubmitted ()
	getDescription ($locale)
	getLanguage ()
	getPublicSuppFileId ()
	getPublisher ($locale)
	getSequence ()
	getShowReviewers ()
	getSource ($locale)
	getSponsor ($locale)
	getSubject ($locale)
	getSuppFileCreator ()
	getSuppFileDescription ()
	getSuppFileId ()
	getSuppFilePublisher ()
	getSuppFileSource ()
	getSuppFileSponsor ()
	getSuppFileSubject ()
	getSuppFileTitle ()
	getSuppFileTypeOther ()
	getTitle ()
	getType ()
	getTypeOther ($locale)
	setArticleId ($articleId)
	setCreator ($creator, $locale)
	setDateCreated ($dateCreated)
	setDateSubmitted ($dateSubmitted)
	setDescription ($description, $locale)
	setLanguage ($language)
	setPublicSuppFileId ($publicSuppFileId)
	setPublisher ($publisher, $locale)
	setSequence ($sequence)
	setShowReviewers ($showReviewers)
	setSource ($source, $locale)
	setSponsor ($sponsor, $locale)
	setSubject ($subject, $locale)
	setSuppFileId ($suppFileId)
	setTitle ($title, $locale)
	setType ($type)
	setTypeOther ($typeOther, $locale)
	SuppFile ()

---

Detailed Description

Supplementary file class.

See also:

SuppFileDAO

Definition at line 21 of file SuppFile.inc.php.

---

Member Function Documentation

SuppFile.getArticleId

(

)

Get ID of article.

Returns:

int

Reimplemented from ArticleFile.

Definition at line 73 of file SuppFile.inc.php.

References DataObject.getData().

Referenced by getBestSuppFileId().

SuppFile.getBestSuppFileId

(

$

journal = null

)

Return the "best" supp file ID -- If a public ID is set, use it; otherwise use the internal Id. (Checks the journal settings to ensure that the public ID feature is enabled.)

Parameters:

$journal

Object the journal this article is in

Returns:

string

Definition at line 396 of file SuppFile.inc.php.

References getArticleId(), DAORegistry.getDAO(), getPublicSuppFileId(), and getSuppFileId().

SuppFile.getCreator

(

$

locale

)

Get creator.

Parameters:

$locale

string

Returns:

string

Definition at line 124 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getDateCreated

(

)

Get date created.

Returns:

date

Definition at line 287 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getDateSubmitted

(

)

Get date file was submitted.

Returns:

datetime

Definition at line 361 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getDescription

(

$

locale

)

Get file description.

Parameters:

$locale

string

Returns:

string

Definition at line 218 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getLanguage

(

)

Get language.

Returns:

string

Definition at line 329 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getPublicSuppFileId

(

)

Get public ID of supplementary file.

Returns:

string

Definition at line 54 of file SuppFile.inc.php.

References DataObject.getData().

Referenced by getBestSuppFileId().

SuppFile.getPublisher

(

$

locale

)

Get publisher.

Parameters:

$locale

string

Returns:

string

Definition at line 244 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getSequence

(

)

Get sequence order of supplementary file.

Returns:

float

Definition at line 377 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getShowReviewers

(

)

Check if file is available to peer reviewers.

Returns:

boolean

Definition at line 345 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getSource

(

$

locale

)

Get source.

Parameters:

$locale

string

Returns:

string

Definition at line 312 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getSponsor

(

$

locale

)

Get sponsor.

Parameters:

$locale

string

Returns:

string

Definition at line 270 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getSubject

(

$

locale

)

Get subject.

Parameters:

$locale

string

Returns:

string

Definition at line 150 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getSuppFileCreator

(

)

Get localized creator

Returns:

string

Definition at line 115 of file SuppFile.inc.php.

SuppFile.getSuppFileDescription

(

)

Get localized description

Returns:

string

Definition at line 209 of file SuppFile.inc.php.

SuppFile.getSuppFileId

(

)

Get ID of supplementary file.

Returns:

int

Definition at line 38 of file SuppFile.inc.php.

References DataObject.getData().

Referenced by getBestSuppFileId().

SuppFile.getSuppFilePublisher

(

)

Get localized publisher

Returns:

string

Definition at line 235 of file SuppFile.inc.php.

SuppFile.getSuppFileSource

(

)

Get localized source

Returns:

string

Definition at line 303 of file SuppFile.inc.php.

SuppFile.getSuppFileSponsor

(

)

Get localized sponsor

Returns:

string

Definition at line 261 of file SuppFile.inc.php.

SuppFile.getSuppFileSubject

(

)

Get localized subject

Returns:

string

Definition at line 141 of file SuppFile.inc.php.

SuppFile.getSuppFileTitle

(

)

Get localized title

Returns:

string

Definition at line 89 of file SuppFile.inc.php.

SuppFile.getSuppFileTypeOther

(

)

Get localized subject

Returns:

string

Definition at line 183 of file SuppFile.inc.php.

SuppFile.getTitle

(

)

Get title.

Parameters:

$locale

string

Returns:

string

Definition at line 98 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getType

(

)

Get type (method/approach).

Returns:

string

Reimplemented from ArticleFile.

Definition at line 167 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.getTypeOther

(

$

locale

)

Get custom type.

Parameters:

$locale

string

Returns:

string

Definition at line 192 of file SuppFile.inc.php.

References DataObject.getData().

SuppFile.setArticleId

(

$

articleId

)

Set ID of article.

Parameters:

$articleId

int

Reimplemented from ArticleFile.

Definition at line 81 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setCreator	(	$	creator,
		$	locale
	)

Set creator.

Parameters:

	$creator	string
	$locale	string

Definition at line 133 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setDateCreated

(

$

dateCreated

)

Set date created.

Parameters:

$dateCreated

date

Definition at line 295 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setDateSubmitted

(

$

dateSubmitted

)

Set date file was submitted.

Parameters:

$dateSubmitted

datetime

Definition at line 369 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setDescription	(	$	description,
		$	locale
	)

Set file description.

Parameters:

	$description	string
	$locale	string

Definition at line 227 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setLanguage

(

$

language

)

Set language.

Parameters:

$language

string

Definition at line 337 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setPublicSuppFileId

(

$

publicSuppFileId

)

Set public ID of supplementary file.

Parameters:

$suppFileId

string

Definition at line 65 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setPublisher	(	$	publisher,
		$	locale
	)

Set publisher.

Parameters:

	$publisher	string
	$locale	string

Definition at line 253 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setSequence

(

$

sequence

)

Set sequence order of supplementary file.

Parameters:

$sequence

float

Definition at line 385 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setShowReviewers

(

$

showReviewers

)

Set if file is available to peer reviewers or not.

Parameters:

boolean

Definition at line 353 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setSource	(	$	source,
		$	locale
	)

Set source.

Parameters:

	$source	string
	$locale	string

Definition at line 321 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setSponsor	(	$	sponsor,
		$	locale
	)

Set sponsor.

Parameters:

	$sponsor	string
	$locale	string

Definition at line 279 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setSubject	(	$	subject,
		$	locale
	)

Set subject.

Parameters:

	$subject	string
	$locale	string

Definition at line 159 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setSuppFileId

(

$

suppFileId

)

Set ID of supplementary file.

Parameters:

$suppFileId

int

Definition at line 46 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setTitle	(	$	title,
		$	locale
	)

Set title.

Parameters:

	$title	string
	$locale	string

Definition at line 107 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setType

(

$

type

)

Set type (method/approach).

Parameters:

$type

string

Reimplemented from ArticleFile.

Definition at line 175 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.setTypeOther	(	$	typeOther,
		$	locale
	)

Set custom type.

Parameters:

	$typeOther	string
	$locale	string

Definition at line 201 of file SuppFile.inc.php.

References DataObject.setData().

SuppFile.SuppFile

(

)

Constructor.

Definition at line 26 of file SuppFile.inc.php.

---

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

• classes/article/SuppFile.inc.php