PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder Class Reference

Inheritance diagram for PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder:

Public Member Functions
	after ($dateStart)
	before ($dateEnd)
	countActiveByStages ($stages)
	countByDecisions ($decisions, $forSubmittedDate=false)
	countByStatus ($status)
	countPublished ()
	countSubmissionsReceived ()
	filterByContexts ($contextIds)
	filterBySections ($sectionIds)
	getAverageDaysToDecisions ($decisions)
	getDaysToDecisions ($decisions)
	getDecisionsDates ($decisions)
	getPublishedDates ()
	getSubmissionsReceivedDates ()

Data Fields
	$sectionIdsColumn

Protected Member Functions
	_getDaysToDecisionsObject ($decisions)
	_getObject ()

Protected Attributes
	$contextIds = []
	$dateEnd
	$dateStart
	$sectionIds = []

Detailed Description

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

Member Function Documentation

_getDaysToDecisionsObject()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::_getDaysToDecisionsObject (   $decisions )

protected

Generate a query object to get a submission's first decision of the requested decision types

Pass an empty $decisions array to return the number of days to any decision.

Parameters

array

$decisions

One or more SUBMISSION_EDITOR_DECISION_*

Returns

QueryObject

Definition at line 388 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

Referenced by PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\getAverageDaysToDecisions(), and PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\getDaysToDecisions().

_getObject()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::_getObject ( )

protected

Generate a query object based on the configured conditions.

The dateStart and dateEnd filters are not handled here because the dates must be applied differently for each set of data.

Returns

QueryObject

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

References HookRegistry\call().

Referenced by PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getDaysToDecisionsObject(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\countActiveByStages(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\countByDecisions(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\countByStatus(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\countPublished(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\countSubmissionsReceived(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\getDecisionsDates(), PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\getPublishedDates(), and PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\getSubmissionsReceivedDates().

after()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::after

(

$dateStart

)

Set the date to get activity after

Parameters

string

$dateStart

YYYY-MM-DD

Returns

\PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder

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

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\$dateStart.

before()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::before

(

$dateEnd

)

Set the date to get activity before

Parameters

string

$dateEnd

YYYY-MM-DD

Returns

\PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder

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

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\$dateEnd.

countActiveByStages()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::countActiveByStages

(

$stages

)

Get the count of active submissions by one or more stages

Parameters

array

$stages

One or more of WORKFLOW_STAGE_ID_*

Returns

int

Definition at line 191 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

countByDecisions()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::countByDecisions	(		$decisions,
			$forSubmittedDate = false
	)

Get the count of submissions that have received one or more editor decisions

Parameters

array	$decisions	One or more SUBMISSION_EDITOR_DECISION_*
boolean	$forSubmittedDate	How date restrictions should be applied. A false value will count the number of submissions with an editorial decision within the date range. A true value will count the number of submissions received within the date range which eventually received an editorial decision.

Returns

int

Definition at line 127 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

countByStatus()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::countByStatus

(

$status

)

Get the count of submissions by one or more status

Parameters

int | array

$status

One or more of STATUS_*

Returns

int

Definition at line 179 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

countPublished()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::countPublished

(

)

Get the count of published submissions

Returns

int

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

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

countSubmissionsReceived()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::countSubmissionsReceived

(

)

Get the count of submissions received

Returns

int

Definition at line 103 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

filterByContexts()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::filterByContexts

(

$contextIds

)

Set the contexts to return activity for

Parameters

array | int

$contextIds

Returns

\PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder

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

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\$contextIds.

filterBySections()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::filterBySections

(

$sectionIds

)

Set the section ids to include activity for. This is stored under the section_id db column but in OMP refers to seriesIds.

Parameters

array | int

$sectionIds

Returns

\PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder

Definition at line 71 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\$sectionIds.

getAverageDaysToDecisions()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::getAverageDaysToDecisions

(

$decisions

)

Get the average number of days to reach a particular editor decision

This average includes any completed submission which has received one of the editor decisions.

Parameters

array

$decisions

One or more SUBMISSION_EDITOR_DECISION_*

Returns

float Average days between submission and the first decision in the list of requested submissions

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

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getDaysToDecisionsObject().

getDaysToDecisions()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::getDaysToDecisions

(

$decisions

)

Get the number of days to reach a particular editor decision

This list includes any completed submission which has received one of the editor decisions.

Parameters

array

$decisions

One or more SUBMISSION_EDITOR_DECISION_*

Returns

array Days between submission and the first decision in the list of requested submissions

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

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getDaysToDecisionsObject().

getDecisionsDates()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::getDecisionsDates

(

$decisions

)

Get the first and last date that an editorial decision was made

Parameters

array

$decisions

One or more SUBMISSION_EDITOR_DECISION_*

Returns

array [min, max]

Definition at line 312 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

getPublishedDates()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::getPublishedDates

(

)

Get the first and last date of submissions published

Returns

array [min, max]

Definition at line 284 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

getSubmissionsReceivedDates()

PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder::getSubmissionsReceivedDates

(

)

Get the first and last date of submissions received

Returns

array [min, max]

Definition at line 274 of file PKPStatsEditorialQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\_getObject().

Field Documentation

$contextIds

array PKPStatsEditorialQueryBuilder::$contextIds = []

protected

Return stats for activity in these contexts

Definition at line 27 of file PKPStatsEditorialQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\filterByContexts().

$dateEnd

string PKPStatsEditorialQueryBuilder::$dateEnd

protected

Return stats for activity before this date

Definition at line 33 of file PKPStatsEditorialQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\before().

$dateStart

string PKPStatsEditorialQueryBuilder::$dateStart

protected

Return stats for activity after this date

Definition at line 39 of file PKPStatsEditorialQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\after().

$sectionIds

array PKPStatsEditorialQueryBuilder::$sectionIds = []

protected

Return stats for activity in these sections (series in OMP)

Definition at line 45 of file PKPStatsEditorialQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPStatsEditorialQueryBuilder\filterBySections().

$sectionIdsColumn

string PKPStatsEditorialQueryBuilder::$sectionIdsColumn

The table column name for section IDs (OJS) or series IDs (OMP)

Definition at line 51 of file PKPStatsEditorialQueryBuilder.inc.php.

---

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

• PKPStatsEditorialQueryBuilder.inc.php