APP\Services\QueryBuilders\SubmissionQueryBuilder Class Reference

Inheritance diagram for APP\Services\QueryBuilders\SubmissionQueryBuilder:

Public Member Functions
	appGet ($q)
	filterBySeries ($seriesIds)
	orderBy ($column, $direction='DESC')
	orderByFeatured ()
Public Member Functions inherited from PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder
	assignedTo ($assignedTo)
	filterByCategories ($categoryIds)
	filterByContext ($contextId)
	filterByDaysInactive ($daysInactive)
	filterByIncomplete ($isIncomplete)
	filterByOverdue ($isOverdue)
	filterByStageIds ($stageIds)
	filterByStatus ($statuses)
	getCount ()
	getIds ()
	getQuery ()
	limitTo ($count)
	offsetBy ($offset)
	searchPhrase ($phrase)

Protected Attributes
	$orderByFeaturedSeq = null
	$seriesIds = null
Protected Attributes inherited from PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder
	$assignedTo = []
	$categoryIds = null
	$columns = array()
	$contextId = null
	$daysInactive = null
	$isIncomplete = false
	$isOverdue = false
	$limit = null
	$offset = 0
	$orderColumn = 's.date_submitted'
	$orderDirection = 'DESC'
	$searchPhrase = null
	$stageIds = null
	$statuses = null

Detailed Description

Definition at line 20 of file SubmissionQueryBuilder.inc.php.

Member Function Documentation

appGet()

APP\Services\QueryBuilders\SubmissionQueryBuilder::appGet

(

$q

)

Execute additional actions for app-specific query objects

Parameters

object	Query object
SubmissionQueryBuilder	Query object

Returns

object Query object

Reimplemented from PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder.

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

References PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder\$categoryIds, and APP\Services\QueryBuilders\SubmissionQueryBuilder\$seriesIds.

filterBySeries()

APP\Services\QueryBuilders\SubmissionQueryBuilder::filterBySeries

(

$seriesIds

)

Set series filter

Parameters

int | array

$seriesIds

Returns

\App\Services\QueryBuilders\SubmissionQueryBuilder

Definition at line 41 of file SubmissionQueryBuilder.inc.php.

References APP\Services\QueryBuilders\SubmissionQueryBuilder\$seriesIds.

orderBy()

APP\Services\QueryBuilders\SubmissionQueryBuilder::orderBy	(		$column,
			$direction = 'DESC'
	)

Implement app-specific ordering options for catalog

Publication date, Title or Series position, with featured items first

Parameters

string	$column
string	$direction

Returns

\App\Services\QueryBuilders\SubmissionQueryBuilder

Reimplemented from PKP\Services\QueryBuilders\PKPSubmissionQueryBuilder.

Definition at line 59 of file SubmissionQueryBuilder.inc.php.

orderByFeatured()

APP\Services\QueryBuilders\SubmissionQueryBuilder::orderByFeatured

(

)

Order featured items first

Returns

\App\Services\QueryBuilders\SubmissionQueryBuilder

Definition at line 79 of file SubmissionQueryBuilder.inc.php.

Field Documentation

$orderByFeaturedSeq

bool SubmissionQueryBuilder::$orderByFeaturedSeq = null

protected

Order featured items first

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

$seriesIds

int array SubmissionQueryBuilder::$seriesIds = null

protected

Series ID(s)

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

Referenced by APP\Services\QueryBuilders\SubmissionQueryBuilder\appGet(), and APP\Services\QueryBuilders\SubmissionQueryBuilder\filterBySeries().

---

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

• SubmissionQueryBuilder.inc.php