SuppFile Class Reference
[Paper]

Supplementary file class. More...

Inheritance diagram for SuppFile:

PaperFile List of all members.

Public Member Functions

 getBestSuppFileId ($schedConf=null)
 getCreator ($locale)
 getDateCreated ()
 getDateSubmitted ()
 getDescription ($locale)
 getLanguage ()
 getPaperId ()
 getPublicSuppFileId ()
 getPublisher ($locale)
 getSequence ()
 getShowReviewers ()
 getSource ($locale)
 getSponsor ($locale)
 getSubject ($locale)
 getSuppFileCreator ()
 getSuppFileDescription ()
 getSuppFileId ()
 getSuppFilePublisher ()
 getSuppFileSource ()
 getSuppFileSponsor ()
 getSuppFileSubject ()
 getSuppFileTitle ()
 getSuppFileTypeOther ()
 getTitle ()
 getType ()
 getTypeOther ($locale)
 setCreator ($creator, $locale)
 setDateCreated ($dateCreated)
 setDateSubmitted ($dateSubmitted)
 setDescription ($description, $locale)
 setLanguage ($language)
 setPaperId ($paperId)
 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 20 of file SuppFile.inc.php.


Member Function Documentation

SuppFile.getBestSuppFileId ( schedConf = null  ) 

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

Parameters:
$schedConf Object the sched conf this paper is in
Returns:
string

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

References getPaperId(), and getPublicSuppFileId().

SuppFile.getCreator ( locale  ) 

Get creator.

Parameters:
$locale string
Returns:
string

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

SuppFile.getDateCreated (  ) 

Get date created.

Returns:
date

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

SuppFile.getDateSubmitted (  ) 

Get date file was submitted.

Returns:
datetime

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

SuppFile.getDescription ( locale  ) 

Get file description.

Parameters:
$locale string
Returns:
string

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

SuppFile.getLanguage (  ) 

Get language.

Returns:
string

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

SuppFile.getPaperId (  ) 

Get ID of paper.

Returns:
int

Reimplemented from PaperFile.

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

Referenced by getBestSuppFileId().

SuppFile.getPublicSuppFileId (  ) 

Get public ID of supplementary file.

Returns:
string

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

Referenced by getBestSuppFileId().

SuppFile.getPublisher ( locale  ) 

Get publisher.

Parameters:
$locale string
Returns:
string

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

SuppFile.getSequence (  ) 

Get sequence order of supplementary file.

Returns:
float

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

SuppFile.getShowReviewers (  ) 

Check if file is available to peer reviewers.

Returns:
boolean

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

SuppFile.getSource ( locale  ) 

Get source.

Parameters:
$locale string
Returns:
string

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

SuppFile.getSponsor ( locale  ) 

Get sponsor.

Parameters:
$locale string
Returns:
string

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

SuppFile.getSubject ( locale  ) 

Get subject.

Parameters:
$locale string
Returns:
string

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

SuppFile.getSuppFileCreator (  ) 

Get localized creator

Returns:
string

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

SuppFile.getSuppFileDescription (  ) 

Get localized description

Returns:
string

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

SuppFile.getSuppFileId (  ) 

Get ID of supplementary file.

Returns:
int

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

SuppFile.getSuppFilePublisher (  ) 

Get localized publisher

Returns:
string

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

SuppFile.getSuppFileSource (  ) 

Get localized source

Returns:
string

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

SuppFile.getSuppFileSponsor (  ) 

Get localized sponsor

Returns:
string

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

SuppFile.getSuppFileSubject (  ) 

Get localized subject

Returns:
string

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

SuppFile.getSuppFileTitle (  ) 

Get localized title

Returns:
string

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

SuppFile.getSuppFileTypeOther (  ) 

Get localized subject

Returns:
string

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

SuppFile.getTitle (  ) 

Get title.

Parameters:
$locale string
Returns:
string

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

SuppFile.getType (  ) 

Get type (method/approach).

Returns:
string

Reimplemented from PaperFile.

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

SuppFile.getTypeOther ( locale  ) 

Get custom type.

Parameters:
$locale string
Returns:
string

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

SuppFile.setCreator ( creator,
locale 
)

Set creator.

Parameters:
$creator string
$locale string

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

SuppFile.setDateCreated ( dateCreated  ) 

Set date created.

Parameters:
$dateCreated date

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

SuppFile.setDateSubmitted ( dateSubmitted  ) 

Set date file was submitted.

Parameters:
$dateSubmitted datetime

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

SuppFile.setDescription ( description,
locale 
)

Set file description.

Parameters:
$description string
$locale string

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

SuppFile.setLanguage ( language  ) 

Set language.

Parameters:
$language string

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

SuppFile.setPaperId ( paperId  ) 

Set ID of paper.

Parameters:
$paperId int

Reimplemented from PaperFile.

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

SuppFile.setPublicSuppFileId ( publicSuppFileId  ) 

Set public ID of supplementary file.

Parameters:
$suppFileId string

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

SuppFile.setPublisher ( publisher,
locale 
)

Set publisher.

Parameters:
$publisher string
$locale string

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

SuppFile.setSequence ( sequence  ) 

Set sequence order of supplementary file.

Parameters:
$sequence float

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

SuppFile.setShowReviewers ( showReviewers  ) 

Set if file is available to peer reviewers or not.

Parameters:
boolean 

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

SuppFile.setSource ( source,
locale 
)

Set source.

Parameters:
$source string
$locale string

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

SuppFile.setSponsor ( sponsor,
locale 
)

Set sponsor.

Parameters:
$sponsor string
$locale string

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

SuppFile.setSubject ( subject,
locale 
)

Set subject.

Parameters:
$subject string
$locale string

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

SuppFile.setSuppFileId ( suppFileId  ) 

Set ID of supplementary file.

Parameters:
$suppFileId int

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

SuppFile.setTitle ( title,
locale 
)

Set title.

Parameters:
$title string
$locale string

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

SuppFile.setType ( type  ) 

Set type (method/approach).

Parameters:
$type string

Reimplemented from PaperFile.

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

SuppFile.setTypeOther ( typeOther,
locale 
)

Set custom type.

Parameters:
$typeOther string
$locale string

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

SuppFile.SuppFile (  ) 

Constructor.

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


The documentation for this class was generated from the following file:
Generated on 25 Jul 2013 for Open Conference Systems by  doxygen 1.4.7