Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
LayoutEditorSubmissionDAO Class Reference
Inheritance diagram for LayoutEditorSubmissionDAO:
DAO

Public Member Functions

 _generateUserNameSearchSQL ($search, $searchMatch, $prefix, &$params)
 
_returnSubmissionFromRow (&$row)
 
 getSortMapping ($heading)
 
getSubmission ($articleId, $journalId=null)
 
getSubmissions ($editorId, $journalId=null, $searchField=null, $searchMatch=null, $search=null, $dateField=null, $dateFrom=null, $dateTo=null, $active=true, $rangeInfo=null, $sortBy=null, $sortDirection=SORT_DIRECTION_ASC)
 
 getSubmissionsCount ($editorId, $journalId)
 
 LayoutEditorSubmissionDAO ()
 
- Public Member Functions inherited from DAO
 concat ()
 
 convertFromDB ($value, $type)
 
 convertToDB ($value, &$type)
 
 DAO ($dataSource=null, $callHooks=true)
 
 dateFromDB ($d)
 
 datetimeFromDB ($dt)
 
 datetimeToDB ($dt)
 
 dateToDB ($d)
 
 flushCache ()
 
 formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true)
 
 getAffectedRows ()
 
 getDataChangedEvent ($elementId=null, $parentElementId=null)
 
getDataSource ()
 
 getDirectionMapping ($direction)
 
 getDriver ()
 
 getInsertId ($table= '', $id= '', $callHooks=true)
 
 getType ($value)
 
 replace ($table, $arrFields, $keyCols)
 
retrieve ($sql, $params=false, $callHooks=true)
 
retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true)
 
retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true)
 
retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true)
 
 setCacheDir ()
 
 setDataSource (&$dataSource)
 
 update ($sql, $params=false, $callHooks=true, $dieOnError=true)
 
 updateDataObjectSettings ($tableName, &$dataObject, $idArray)
 

Public Attributes

 $articleDao
 
- Public Attributes inherited from DAO
 $_dataSource
 

Detailed Description

Operations for retrieving and modifying LayoutEditorSubmission objects.

See Also
LayoutEditorSubmission

Definition at line 19 of file LayoutEditorSubmissionDAO.inc.php.

Member Function Documentation

LayoutEditorSubmissionDAO::_generateUserNameSearchSQL (   $search,
  $searchMatch,
  $prefix,
$params 
)

FIXME Move this into somewhere common (SubmissionDAO?) as this is used in several classes.

Definition at line 263 of file LayoutEditorSubmissionDAO.inc.php.

References DAO\concat().

Referenced by getSubmissions().

& LayoutEditorSubmissionDAO::_returnSubmissionFromRow ( $row)

Internal function to return a LayoutEditorSubmission object from a row.

Parameters
$rowarray
Returns
LayoutEditorSubmission

Definition at line 93 of file LayoutEditorSubmissionDAO.inc.php.

References HookRegistry\call().

Referenced by getSubmission().

LayoutEditorSubmissionDAO::getSortMapping (   $heading)

Map a column heading value to a database value for sorting

Parameters
string
Returns
string

Definition at line 343 of file LayoutEditorSubmissionDAO.inc.php.

Referenced by getSubmissions().

& LayoutEditorSubmissionDAO::getSubmission (   $articleId,
  $journalId = null 
)

Retrieve a layout editor submission by article ID.

Parameters
$articleIdint
Returns
LayoutEditorSubmission

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

References _returnSubmissionFromRow(), AppLocale\getLocale(), AppLocale\getPrimaryLocale(), and DAO\retrieve().

& LayoutEditorSubmissionDAO::getSubmissions (   $editorId,
  $journalId = null,
  $searchField = null,
  $searchMatch = null,
  $search = null,
  $dateField = null,
  $dateFrom = null,
  $dateTo = null,
  $active = true,
  $rangeInfo = null,
  $sortBy = null,
  $sortDirection = SORT_DIRECTION_ASC 
)

Get set of layout editing assignments assigned to the specified layout editor.

Parameters
$editorIdint
$journalIdint
$searchFieldint SUBMISSION_FIELD_... constant
$searchMatchString 'is' or 'contains' or 'startsWith'
$searchString Search string
$dateFieldint SUBMISSION_FIELD_DATE_... constant
$dateFromint Search from timestamp
$dateToint Search to timestamp
$activeboolean true to select active assignments, false to select completed assignments
Returns
array LayoutEditorSubmission

Definition at line 126 of file LayoutEditorSubmissionDAO.inc.php.

References _generateUserNameSearchSQL(), DAO\datetimeToDB(), DAO\getDirectionMapping(), AppLocale\getLocale(), AppLocale\getPrimaryLocale(), getSortMapping(), and DAO\retrieveRange().

LayoutEditorSubmissionDAO::getSubmissionsCount (   $editorId,
  $journalId 
)

Get count of active and complete assignments

Parameters
editorIdint
journalIdint

Definition at line 286 of file LayoutEditorSubmissionDAO.inc.php.

References DAO\retrieve().

LayoutEditorSubmissionDAO::LayoutEditorSubmissionDAO ( )

Constructor.

Definition at line 31 of file LayoutEditorSubmissionDAO.inc.php.

References DAORegistry\getDAO().

Member Data Documentation

LayoutEditorSubmissionDAO::$articleDao

Helper DAOs

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


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