Inheritance diagram for PKP\Services\PKPStatsEditorialService:

Public Member Functions
	calculateDaysToDecisionRate ($days, $percentage)

	countActiveByStages ($stages, $args=[])

	countByDecisions ($decisions, $args=[])

	countByDecisionsForSubmittedDate ($decisions, $args=[])

	countByStatus ($statuses, $args=[])

	countSubmissionsPublished ($args=[])

	countSubmissionsReceived ($args=[])

	getAverageDaysToDecisions ($decisions, $args=[])

	getAverages ($args=[])

	getDaysToDecisions ($decisions, $args=[])

	getOverview ($args=[])

Protected Member Functions
	getQueryBuilder ($args=[])

Detailed Description

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

Member Function Documentation

◆ calculateDaysToDecisionRate()

PKP\Services\PKPStatsEditorialService::calculateDaysToDecisionRate	(	$days,
		$percentage
	)

A helper function to calculate the number of days it took reach an editorial decision on a given portion of submission decisions

This can be used to answer questions like how many days it took for a decision to be reached in 80% of submissions.

For example, if passed an array of [5, 8, 10, 20] and a percentage of .75, it would return 10 since 75% of the array values are 10 or less.

Parameters

array	$days	An array of integers representing the dataset of days to reach a decision.
float	$percentage	The percentage of the dataset that must be included in the rate. 75% = 0.75

Returns: int The number of days X% of submissions received the decision

Definition at line 408 of file PKPStatsEditorialService.inc.php.

Referenced by PKP\Services\PKPStatsEditorialService\getOverview().

◆ countActiveByStages()

PKP\Services\PKPStatsEditorialService::countActiveByStages	(	$stages,
		$args = `[]`
	)

Get a count of the active submissions in one or more stages

Date restrictions will not be applied. It will return the count of all submissions with the passed statuses.

Parameters

int \| array	$stages	One or more WORKFLOW_STAGE_ID_*
array	$args	See self::getQueryBuilder()

Returns: int

Definition at line 357 of file PKPStatsEditorialService.inc.php.

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

◆ countByDecisions()

PKP\Services\PKPStatsEditorialService::countByDecisions	(	$decisions,
		$args = `[]`
	)

Get a count of the submissions receiving one or more editorial decisions

Any date restrictions will be applied to the decision, so it will only count decisions that occurred within the date range.

Parameters

int \| array	$decisions	One or more SUBMISSION_EDITOR_DECISION_*
array	$args	See self::getQueryBuilder()

Returns: int

Definition at line 314 of file PKPStatsEditorialService.inc.php.

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

Referenced by PKP\Services\PKPStatsEditorialService\getAverages(), and PKP\Services\PKPStatsEditorialService\getOverview().

◆ countByDecisionsForSubmittedDate()

PKP\Services\PKPStatsEditorialService::countByDecisionsForSubmittedDate	(	$decisions,
		$args = `[]`
	)

Get a count of the submissions receiving one or more editorial decisions

Any date restrictions will be applied to the submission date, so it will only count submissions made within the date range which eventually received one of the decisions.

Parameters

int \| array	$decisions	One or more SUBMISSION_EDITOR_DECISION_*
array	$args	See self::getQueryBuilder()

Returns: int

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

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

Referenced by PKP\Services\PKPStatsEditorialService\getOverview().

◆ countByStatus()

PKP\Services\PKPStatsEditorialService::countByStatus	(	$statuses,
		$args = `[]`
	)

Get a count of the submissions with one or more statuses

Date restrictions will not be applied. It will return the count of all submissions with the passed statuses.

Parameters

int \| array	$statuses	One or more STATUS_*
array	$args	See self::getQueryBuilder()

Returns: int

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

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

◆ countSubmissionsPublished()

PKP\Services\PKPStatsEditorialService::countSubmissionsPublished ( $args = [] )

Get a count of the number of submissions that have been published

Any date restrictions will be applied to the initial publication date, so it will only count submissions published within the date range.

Parameters

array $args See self::getQueryBuilder()

Returns: int

Definition at line 300 of file PKPStatsEditorialService.inc.php.

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

Referenced by PKP\Services\PKPStatsEditorialService\getAverages(), and PKP\Services\PKPStatsEditorialService\getOverview().

◆ countSubmissionsReceived()

PKP\Services\PKPStatsEditorialService::countSubmissionsReceived ( $args = [] )

Get a count of the number of submissions that have been received

Any date restrictions will be applied to the submission date, so it will only count submissions completed within the date range.

Parameters

array $args See self::getQueryBuilder()

Returns: int

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

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

Referenced by PKP\Services\PKPStatsEditorialService\getAverages(), and PKP\Services\PKPStatsEditorialService\getOverview().

◆ getAverageDaysToDecisions()

PKP\Services\PKPStatsEditorialService::getAverageDaysToDecisions	(	$decisions,
		$args = `[]`
	)

Get the average number of days to reach one or more editorial decisions

Any date restrictions will be applied to the submission date, so it will only average the days to a decision for submissions that were made within the selected date range.

Parameters

int \| array	$decisions	One or more SUBMISSION_EDITOR_DECISION_*
array	$args	See self::getQueryBuilder()

Returns: int

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

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

◆ getAverages()

PKP\Services\PKPStatsEditorialService::getAverages ( $args = [] )

Get the yearly averages of key editorial stats

Averages are calculated over full years. If no dateStart and dateEnd are passed, it will determine the first and last full years during which the activity occurred. This means that if the first submission was received in October 2017 and the last submission was received in the current calendar year, only submissions from 2018 up until the end of the previous calendar year will be used to calculate the average.

This method does not yet support getting averages for date ranges.

See also: https://github.com/pkp/pkp-lib/issues/4844#issuecomment-554011922

Parameters

array $args See self::getQueryBuilder(). No date range supported

Returns: array

Definition at line 177 of file PKPStatsEditorialService.inc.php.

References HookRegistry\call(), PKP\Services\PKPStatsEditorialService\countByDecisions(), PKP\Services\PKPStatsEditorialService\countSubmissionsPublished(), PKP\Services\PKPStatsEditorialService\countSubmissionsReceived(), and PKP\Services\PKPStatsEditorialService\getQueryBuilder().

◆ getDaysToDecisions()

PKP\Services\PKPStatsEditorialService::getDaysToDecisions	(	$decisions,
		$args = `[]`
	)

Get the number of days it took for each submission to reach one or more editorial decisions

Any date restrictions will be applied to the submission date, so it will only return the days to a decision for submissions that were made within the selected date range.

Parameters

int \| array	$decisions	One or more SUBMISSION_EDITOR_DECISION_*
array	$args	See self::getQueryBuilder()

Returns: array

Definition at line 373 of file PKPStatsEditorialService.inc.php.

References PKP\Services\PKPStatsEditorialService\getQueryBuilder().

Referenced by PKP\Services\PKPStatsEditorialService\getOverview().

◆ getOverview()

PKP\Services\PKPStatsEditorialService::getOverview ( $args = [] )

Get overview of key editorial stats

Parameters

array $args See self::getQueryBuilder()

Returns: array

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

References PKP\Services\PKPStatsEditorialService\calculateDaysToDecisionRate(), HookRegistry\call(), PKP\Services\PKPStatsEditorialService\countByDecisions(), PKP\Services\PKPStatsEditorialService\countByDecisionsForSubmittedDate(), PKP\Services\PKPStatsEditorialService\countSubmissionsPublished(), PKP\Services\PKPStatsEditorialService\countSubmissionsReceived(), PKP\Services\PKPStatsEditorialService\getDaysToDecisions(), and AppLocale\requireComponents().

◆ getQueryBuilder()

PKP\Services\PKPStatsEditorialService::getQueryBuilder ( $args = [] )

protected

Get a QueryBuilder object with the passed args

Parameters

array $args [ @option string dateStart @option string dateEnd @option array|int contextIds @option array|int sectionIds (will match seriesId in OMP) ]