PKP\Services\QueryBuilders\PKPUserQueryBuilder Class Reference

Inheritance diagram for PKP\Services\QueryBuilders\PKPUserQueryBuilder:

Public Member Functions
	assignedToCategory ($categoryId)
	assignedToSection ($sectionId)
	assignedToSubmission ($submissionId, $submissionStage)
	excludeUsers ($userIds)
	filterByAverageCompletion ($averageCompletion=null)
	filterByContext ($contextId)
	filterByDaysSinceLastAssignment ($daysSinceLastAssignment=null)
	filterByReviewerRating ($reviewerRating=null)
	filterByReviewsActive ($reviewsActive=null)
	filterByReviewsCompleted ($reviewsCompleted=null)
	filterByReviewStage ($reviewStageId=null)
	filterByRoleIds ($roleIds)
	filterByStatus ($status)
	getCount ()
	getIds ()
	getQuery ()
	getReviewerData ($enable=true)
	includeUsers ($userIds)
	limitTo ($count)
	offsetBy ($offset)
	orderBy ($column, $direction='DESC')
	registeredAfter ($date)
	registeredBefore ($date)
	searchPhrase ($phrase)

Protected Attributes
	$assignedToCategoryId = null
	$assignedToSectionId = null
	$assignedToSubmissionId = null
	$assignedToSubmissionStageId = null
	$averageCompletion = null
	$columns = array()
	$contextId = null
	$daysSinceLastAssignment = null
	$excludeUsers = null
	$getReviewerData = null
	$includeUsers = null
	$limit = null
	$offset = 0
	$orderColumn = 'u.user_id'
	$orderDirection = 'DESC'
	$registeredAfter = ''
	$registeredBefore = ''
	$reviewerRating = null
	$reviewsActive = null
	$reviewsCompleted = null
	$reviewStageId = null
	$roleIds = null
	$searchPhrase = null
	$status = null

Detailed Description

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

Member Function Documentation

assignedToCategory()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::assignedToCategory

(

$categoryId

)

Limit results to users assigned as editors to this category

Parameters

$categoryId

int

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 232 of file PKPUserQueryBuilder.inc.php.

assignedToSection()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::assignedToSection

(

$sectionId

)

Limit results to users assigned as editors to this section

Parameters

$sectionId

int

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

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

assignedToSubmission()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::assignedToSubmission	(		$submissionId,
			$submissionStage
	)

Limit results to users assigned to this submission

Parameters

$submissionId

int

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

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

excludeUsers()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::excludeUsers

(

$userIds

)

Exclude selected users

Parameters

$userIds

array

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 305 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

filterByAverageCompletion()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByAverageCompletion

(

$averageCompletion = null

)

Limit results to those who complete a review on average less than this many days after their assignment.

Parameters

$averageCompletion

int|array

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 418 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$averageCompletion.

filterByContext()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByContext

(

$contextId

)

Set context submissions filter

Parameters

int | string

$contextId

Returns

\APP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 173 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$contextId.

filterByDaysSinceLastAssignment()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByDaysSinceLastAssignment

(

$daysSinceLastAssignment = null

)

Limit results to those who's last review assignment was at least this many days ago.

Parameters

$daysSinceLastAssignment

int|array

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 402 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$daysSinceLastAssignment.

filterByReviewerRating()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByReviewerRating

(

$reviewerRating = null

)

Limit results to those who have a minimum reviewer rating

Parameters

$reviewerRating

int

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 356 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$reviewerRating.

filterByReviewsActive()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByReviewsActive

(

$reviewsActive = null

)

Limit results to those who have at least this many active review assignments

Parameters

$reviewsActive

int|array

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

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

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$reviewsActive.

filterByReviewsCompleted()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByReviewsCompleted

(

$reviewsCompleted = null

)

Limit results to those who have completed at least this many reviews

Parameters

$reviewsCompleted

int|array

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 371 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$reviewsCompleted.

filterByReviewStage()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByReviewStage

(

$reviewStageId = null

)

Limit results to reviewers for a particular stage

Parameters

$reviewStageId

int WORKFLOW_STAGE_ID_*_REVIEW

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

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

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$reviewStageId.

filterByRoleIds()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByRoleIds

(

$roleIds

)

Set roles filter

Parameters

$roleIds

int|array

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 217 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$roleIds.

filterByStatus()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::filterByStatus

(

$status

)

Set status filter

Parameters

$status

string

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 205 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$status.

getCount()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::getCount

(

)

Get a count of the number of rows that match the select conditions configured in this query builder.

Returns

int

Implements PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface.

Definition at line 453 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

getIds()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::getIds

(

)

Get a list of ids that match the select conditions configured in this query builder.

Returns

array

Implements PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface.

Definition at line 466 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

getQuery()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::getQuery

(

)

Execute query builder

Returns

object Query object

Implements PKP\Services\QueryBuilders\Interfaces\EntityQueryBuilderInterface.

Definition at line 481 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$assignedToCategoryId, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$assignedToSectionId, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$assignedToSubmissionId, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$assignedToSubmissionStageId, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$daysSinceLastAssignment, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$excludeUsers, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$includeUsers, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$reviewsActive, PKP\Services\QueryBuilders\PKPUserQueryBuilder\$reviewsCompleted, HookRegistry\call(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\excludeUsers(), PKPApplication\get(), DAORegistry\getDAO(), AppLocale\getLocale(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\getReviewerData(), Config\getVar(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\includeUsers(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\registeredAfter(), PKP\Services\QueryBuilders\PKPUserQueryBuilder\registeredBefore(), and PKP\Services\QueryBuilders\PKPUserQueryBuilder\searchPhrase().

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getCount(), and PKP\Services\QueryBuilders\PKPUserQueryBuilder\getIds().

getReviewerData()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::getReviewerData

(

$enable = true

)

Whether to return reviewer activity data

Parameters

$enable

bool

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

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

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

includeUsers()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::includeUsers

(

$userIds

)

Include selected users

Parameters

$userIds

array

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 293 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

limitTo()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::limitTo

(

$count

)

Set query limit

Parameters

int

$count

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 433 of file PKPUserQueryBuilder.inc.php.

offsetBy()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::offsetBy

(

$offset

)

Set how many results to skip

Parameters

int

$offset

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 445 of file PKPUserQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPUserQueryBuilder\$offset.

orderBy()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::orderBy	(		$column,
			$direction = 'DESC'
	)

Set result order column and direction

Parameters

$column	string
$direction	string

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 186 of file PKPUserQueryBuilder.inc.php.

registeredAfter()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::registeredAfter

(

$date

)

Limit results to users who registered after this date

Parameters

$date

string

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

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

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

registeredBefore()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::registeredBefore

(

$date

)

Limit results to users who registered before this date

Parameters

$date

string

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 281 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

searchPhrase()

PKP\Services\QueryBuilders\PKPUserQueryBuilder::searchPhrase

(

$phrase

)

Set query search phrase

Parameters

$phrase

string

Returns

\PKP\Services\QueryBuilders\PKPUserQueryBuilder

Definition at line 317 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

Field Documentation

$assignedToCategoryId

int PKPUserQueryBuilder::$assignedToCategoryId = null

protected

Assigned as editor to this category id

Definition at line 62 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$assignedToSectionId

int PKPUserQueryBuilder::$assignedToSectionId = null

protected

Assigned as editor to this section id

Definition at line 68 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$assignedToSubmissionId

int PKPUserQueryBuilder::$assignedToSubmissionId = null

protected

submission ID

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

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$assignedToSubmissionStageId

int PKPUserQueryBuilder::$assignedToSubmissionStageId = null

protected

submission stage ID

Definition at line 80 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$averageCompletion

int array PKPUserQueryBuilder::$averageCompletion = null

protected

filter by average days to complete a review

Definition at line 152 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByAverageCompletion().

$columns

array PKPUserQueryBuilder::$columns = array()

protected

list of columns for query

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

$contextId

int PKPUserQueryBuilder::$contextId = null

protected

Context ID

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

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByContext().

$daysSinceLastAssignment

int array PKPUserQueryBuilder::$daysSinceLastAssignment = null

protected

filter by days since last review assignment

Definition at line 146 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByDaysSinceLastAssignment(), and PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$excludeUsers

array PKPUserQueryBuilder::$excludeUsers = null

protected

user IDs

Definition at line 104 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$getReviewerData

bool PKPUserQueryBuilder::$getReviewerData = null

protected

whether to return reviewer activity data

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

$includeUsers

array PKPUserQueryBuilder::$includeUsers = null

protected

user IDs

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

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$limit

int null PKPUserQueryBuilder::$limit = null

protected

whether to limit the number of results returned

Definition at line 158 of file PKPUserQueryBuilder.inc.php.

$offset

int PKPUserQueryBuilder::$offset = 0

protected

whether to offset the number of results returned. Use to return a second page of results.

Definition at line 164 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\offsetBy().

$orderColumn

string PKPUserQueryBuilder::$orderColumn = 'u.user_id'

protected

order by column

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

$orderDirection

string PKPUserQueryBuilder::$orderDirection = 'DESC'

protected

order by direction

Definition at line 44 of file PKPUserQueryBuilder.inc.php.

$registeredAfter

string PKPUserQueryBuilder::$registeredAfter = ''

protected

get users registered after this date

Definition at line 86 of file PKPUserQueryBuilder.inc.php.

$registeredBefore

string PKPUserQueryBuilder::$registeredBefore = ''

protected

get users registered before this date

Definition at line 92 of file PKPUserQueryBuilder.inc.php.

$reviewerRating

int PKPUserQueryBuilder::$reviewerRating = null

protected

filter by minimum reviewer rating

Definition at line 128 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByReviewerRating().

$reviewsActive

int array PKPUserQueryBuilder::$reviewsActive = null

protected

filter by active review assignments for user

Definition at line 140 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByReviewsActive(), and PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$reviewsCompleted

int array PKPUserQueryBuilder::$reviewsCompleted = null

protected

filter by reviews completed by user

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

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByReviewsCompleted(), and PKP\Services\QueryBuilders\PKPUserQueryBuilder\getQuery().

$reviewStageId

int PKPUserQueryBuilder::$reviewStageId = null

protected

filter by review stage id

Definition at line 122 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByReviewStage().

$roleIds

array PKPUserQueryBuilder::$roleIds = null

protected

list of role ids

Definition at line 56 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByRoleIds().

$searchPhrase

string PKPUserQueryBuilder::$searchPhrase = null

protected

search phrase

Definition at line 110 of file PKPUserQueryBuilder.inc.php.

$status

string PKPUserQueryBuilder::$status = null

protected

enabled or disabled users

Definition at line 50 of file PKPUserQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPUserQueryBuilder\filterByStatus().

---

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

• PKPUserQueryBuilder.inc.php