PublishedPaperDAO Class Reference
[Paper]

Operations for retrieving and modifying PublishedPaper objects. More...

List of all members.

Public Member Functions

_returnPublishedPaperFromRow ($row)
 deletePublishedPaperById ($pubId)
 deletePublishedPaperByPaperId ($paperId)
 deletePublishedPapersBySchedConfId ($schedConfId)
 deletePublishedPapersByTrackId ($trackId)
 getInsertPublishedPaperId ()
 getPaperYearRange ($conferenceId=null)
 getPublishedPaperAuthors ($schedConfId)
getPublishedPaperByBestPaperId ($schedConfId, $paperId, $previewAbstracts=null)
getPublishedPaperById ($pubId)
getPublishedPaperByPaperId ($paperId, $schedConfId=null, $previewAbstracts=null)
getPublishedPaperByPublicPaperId ($schedConfId, $publicPaperId)
 getPublishedPaperCountBySchedConfId ($schedConfId)
getPublishedPaperIdsAlphabetizedBySchedConf ($conferenceId=null, $schedConfId=null, $rangeInfo=null)
getPublishedPaperIdsAlphabetizedByTitle ($conferenceId=null, $schedConfId=null, $rangeInfo=null)
getPublishedPapers ($schedConfId, $sortOrder=PAPER_SORT_ORDER_NATURAL)
getPublishedPapersBySchedConfId ($schedConfId, $rangeInfo=null)
getPublishedPapersByTrackId ($trackId, $schedConfId)
getPublishedPapersInTracks ($schedConfId, $trackId=null, $searchField=null, $searchMatch=null, $search=null, $previewAbstracts=false)
 incrementViewsByPaperId ($paperId)
 insertPublishedPaper (&$publishedPaper)
 publicPaperIdExists ($publicPaperId, $paperId, $schedConfId)
 PublishedPaperDAO ()
 resequencePublishedPapers ($trackId, $schedConfId)
 updatePublishedPaper ($publishedPaper)
 updatePublishedPaperField ($pubId, $field, $value)

Public Attributes

 $authorDao
 $galleyDao
 $paperDao
 $suppFileDao


Detailed Description

Operations for retrieving and modifying PublishedPaper objects.

See also:
PublishedPaper

Definition at line 23 of file PublishedPaperDAO.inc.php.


Member Function Documentation

& PublishedPaperDAO._returnPublishedPaperFromRow ( row  ) 

creates and returns a published paper object from a row

Parameters:
$row array
Returns:
PublishedPaper object

Definition at line 545 of file PublishedPaperDAO.inc.php.

Referenced by getPublishedPaperByPaperId(), getPublishedPaperByPublicPaperId(), getPublishedPapers(), getPublishedPapersBySchedConfId(), getPublishedPapersByTrackId(), and getPublishedPapersInTracks().

PublishedPaperDAO.deletePublishedPaperById ( pubId  ) 

removes an published Paper by id

Parameters:
pubId int

Definition at line 605 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.deletePublishedPaperByPaperId ( paperId  ) 

Delete published paper by paper ID NOTE: This does not delete the related Paper or any dependent entities

Parameters:
$paperId int

Definition at line 616 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.deletePublishedPapersBySchedConfId ( schedConfId  ) 

Delete published papers by scheduled conference ID

Parameters:
$schedConfId int

Definition at line 646 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.deletePublishedPapersByTrackId ( trackId  ) 

Delete published papers by track ID

Parameters:
$trackId int

Definition at line 626 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.getInsertPublishedPaperId (  ) 

Get the ID of the last inserted published paper.

Returns:
int

Definition at line 597 of file PublishedPaperDAO.inc.php.

Referenced by insertPublishedPaper().

PublishedPaperDAO.getPaperYearRange ( conferenceId = null  ) 

Return years of oldest/youngest published paper within the site or a specific scheduled conference

Parameters:
$conferenceId int
Returns:
array

Definition at line 784 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.getPublishedPaperAuthors ( schedConfId  ) 

Retrieve all authors from published papers

Parameters:
$schedConfId int
Returns:
$authors array Author Objects

Definition at line 719 of file PublishedPaperDAO.inc.php.

& PublishedPaperDAO.getPublishedPaperByBestPaperId ( schedConfId,
paperId,
previewAbstracts = null 
)

Retrieve published paper by public paper id or, failing that, internal paper ID; public paper ID takes precedence.

Parameters:
$schedConfId int
$paperId string
$previewAbstracts boolean Whether to include unpublished abstracts that have been reviewed
Returns:
PublishedPaper object

Definition at line 446 of file PublishedPaperDAO.inc.php.

References getPublishedPaperByPaperId(), and getPublishedPaperByPublicPaperId().

& PublishedPaperDAO.getPublishedPaperById ( pubId  ) 

Retrieve Published Paper by pub id

Parameters:
$pubId int
Returns:
PublishedPaper object

Definition at line 311 of file PublishedPaperDAO.inc.php.

& PublishedPaperDAO.getPublishedPaperByPaperId ( paperId,
schedConfId = null,
previewAbstracts = null 
)

Retrieve published paper by paper id

Parameters:
$paperId int
$schedConfId int optional
$previewAbstracts whether or not to allow access to unpublished papers
Returns:
PublishedPaper object

Definition at line 341 of file PublishedPaperDAO.inc.php.

References _returnPublishedPaperFromRow(), AppLocale.getLocale(), and AppLocale.getPrimaryLocale().

Referenced by getPublishedPaperByBestPaperId().

& PublishedPaperDAO.getPublishedPaperByPublicPaperId ( schedConfId,
publicPaperId 
)

Retrieve published paper by public paper id

Parameters:
$schedConfId int
$publicPaperId string
Returns:
PublishedPaper object

Definition at line 394 of file PublishedPaperDAO.inc.php.

References _returnPublishedPaperFromRow(), AppLocale.getLocale(), and AppLocale.getPrimaryLocale().

Referenced by getPublishedPaperByBestPaperId().

PublishedPaperDAO.getPublishedPaperCountBySchedConfId ( schedConfId  ) 

Retrieve a count of published papers in a scheduled conference.

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

& PublishedPaperDAO.getPublishedPaperIdsAlphabetizedBySchedConf ( conferenceId = null,
schedConfId = null,
rangeInfo = null 
)

Retrieve "paper_id"s for published papers for a scheduled conference, sorted by scheduled conference. Note that if schedConfId is null, alphabetized paper IDs for all scheduled conferences are returned.

Parameters:
$schedConfId int
Returns:
Array

Definition at line 508 of file PublishedPaperDAO.inc.php.

& PublishedPaperDAO.getPublishedPaperIdsAlphabetizedByTitle ( conferenceId = null,
schedConfId = null,
rangeInfo = null 
)

Retrieve "paper_id"s for published papers for a scheduled conference, sorted alphabetically. Note that if schedConfId is null, alphabetized paper IDs for all scheduled conferences are returned.

Parameters:
$schedConfId int
Returns:
Array

Definition at line 460 of file PublishedPaperDAO.inc.php.

References AppLocale.getLocale(), and AppLocale.getPrimaryLocale().

& PublishedPaperDAO.getPublishedPapers ( schedConfId,
sortOrder = PAPER_SORT_ORDER_NATURAL 
)

Retrieve Published Papers by scheduled conference id. Limit provides number of records to retrieve

Parameters:
$schedConfId int
$sortOrder int PAPER_SORT_ORDER_...
Returns:
object Iterator of PublishedPaper objects

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

References _returnPublishedPaperFromRow(), AppLocale.getLocale(), and AppLocale.getPrimaryLocale().

& PublishedPaperDAO.getPublishedPapersBySchedConfId ( schedConfId,
rangeInfo = null 
)

Retrieve all published papers in a scheduled conference.

Parameters:
$schedConfId int
$rangeInfo object

Definition at line 113 of file PublishedPaperDAO.inc.php.

References _returnPublishedPaperFromRow(), AppLocale.getLocale(), and AppLocale.getPrimaryLocale().

& PublishedPaperDAO.getPublishedPapersByTrackId ( trackId,
schedConfId 
)

Retrieve Published Papers by track id

Parameters:
$trackId int
Returns:
PublishedPaper objects array

Definition at line 256 of file PublishedPaperDAO.inc.php.

References _returnPublishedPaperFromRow(), AppLocale.getLocale(), and AppLocale.getPrimaryLocale().

& PublishedPaperDAO.getPublishedPapersInTracks ( schedConfId,
trackId = null,
searchField = null,
searchMatch = null,
search = null,
previewAbstracts = false 
)

Retrieve Published Papers by scheduled conference id

Parameters:
$schedConfId int
$trackId int ID of track to view, or null for all
$searchField int SUBMISSION_FIELD_...
$searchMatch string 'is' or 'contains'
$search string Search value
$previewAbstracts boolean Whether to include unpublished abstracts that have been reviewed
Returns:
PublishedPaper objects array

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

References _returnPublishedPaperFromRow(), AppLocale.getLocale(), and AppLocale.getPrimaryLocale().

PublishedPaperDAO.incrementViewsByPaperId ( paperId  ) 

Increment the views count for a galley.

Parameters:
$paperId int

Definition at line 752 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.insertPublishedPaper ( &$  publishedPaper  ) 

inserts a new published paper into published_papers table

Parameters:
PublishedPaper object
Returns:
pubId int

Definition at line 573 of file PublishedPaperDAO.inc.php.

References getInsertPublishedPaperId().

PublishedPaperDAO.publicPaperIdExists ( publicPaperId,
paperId,
schedConfId 
)

Checks if public identifier exists

Parameters:
$publicPaperId string
$paperId int
$schedConfId int
Returns:
boolean

Definition at line 766 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.PublishedPaperDAO (  ) 

Constructor.

Definition at line 32 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.resequencePublishedPapers ( trackId,
schedConfId 
)

Sequentially renumber published papers in their sequence order.

Definition at line 694 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.updatePublishedPaper ( publishedPaper  ) 

updates a published paper

Parameters:
PublishedPaper object

Definition at line 656 of file PublishedPaperDAO.inc.php.

PublishedPaperDAO.updatePublishedPaperField ( pubId,
field,
value 
)

updates a published paper field

Parameters:
$pubId int
$field string
$value mixed

Definition at line 685 of file PublishedPaperDAO.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