PKP\Services\QueryBuilders\PKPStatsQueryBuilder Class Reference

Public Member Functions
	after ($dateStart)
	before ($dateEnd)
	filterByAssocIds ($assocIds)
	filterByAssocTypes ($assocTypes)
	filterByContexts ($contextIds)
	filterByFileTypes ($fileTypes)
	filterBySections ($sectionIds)
	filterBySubmissions ($submissionIds)
	getRecords ()
	getSubmissionIds ()
	getSum ($groupBy=[])
	getTimeline ($date)

Protected Member Functions
	_getObject ()

Protected Attributes
	$assocIds = []
	$assocTypes = []
	$contextIds = []
	$dateEnd
	$dateStart
	$fileTypes
	$sectionIds = []
	$submissionIds = []

Detailed Description

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

Member Function Documentation

_getObject()

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

protected

Generate a query object based on the configured conditions.

Public methods should call this method to set up the query object and apply any additional selection, grouping and ordering conditions.

Returns

QueryObject

Definition at line 239 of file PKPStatsQueryBuilder.inc.php.

References HookRegistry\call().

Referenced by PKP\Services\QueryBuilders\PKPStatsQueryBuilder\getRecords(), PKP\Services\QueryBuilders\PKPStatsQueryBuilder\getSubmissionIds(), PKP\Services\QueryBuilders\PKPStatsQueryBuilder\getSum(), and PKP\Services\QueryBuilders\PKPStatsQueryBuilder\getTimeline().

after()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::after

(

$dateStart

)

Set the date after which to get records

Parameters

string

$dateStart

YYYY-MM-DD

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

Definition at line 162 of file PKPStatsQueryBuilder.inc.php.

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

before()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::before

(

$dateEnd

)

Set the date before which to get records

Parameters

string

$dateEnd

YYYY-MM-DD

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

Definition at line 151 of file PKPStatsQueryBuilder.inc.php.

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

filterByAssocIds()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::filterByAssocIds

(

$assocIds

)

Set the assoc type object ids to get records for

Parameters

array | int

$assocIds

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

Definition at line 117 of file PKPStatsQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsQueryBuilder\$assocIds.

filterByAssocTypes()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::filterByAssocTypes

(

$assocTypes

)

Set the assocTypes to get records for

Parameters

array | int

$assocTypes

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

Definition at line 106 of file PKPStatsQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsQueryBuilder\$assocTypes.

filterByContexts()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::filterByContexts

(

$contextIds

)

Set the contexts to get records for

Parameters

array | int

$contextIds

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

Definition at line 84 of file PKPStatsQueryBuilder.inc.php.

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

filterByFileTypes()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::filterByFileTypes

(

$fileTypes

)

Set the galley file type to get records for

Parameters

array | int

$fileTypes

STATISTICS_FILE_TYPE_*

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

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

References PKP\Services\QueryBuilders\PKPStatsQueryBuilder\$fileTypes.

filterBySections()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::filterBySections

(

$sectionIds

)

Set the to get records for. This is stored under the section_id db column but in OMP refers to seriesIds.

Parameters

array | int

$sectionIds

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

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

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

filterBySubmissions()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::filterBySubmissions

(

$submissionIds

)

Set the submissions to get records for

Parameters

array | int

$submissionIds

Returns

\PKP\Services\QueryBuilders\PKPStatsQueryBuilder

Definition at line 95 of file PKPStatsQueryBuilder.inc.php.

References PKP\Services\QueryBuilders\PKPStatsQueryBuilder\$submissionIds.

getRecords()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::getRecords

(

)

Get all matching records

Returns

QueryObject

Definition at line 172 of file PKPStatsQueryBuilder.inc.php.

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

getSubmissionIds()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::getSubmissionIds

(

)

Get a list of submission ids that have matching records for the query

Returns

QueryObject

Definition at line 224 of file PKPStatsQueryBuilder.inc.php.

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

getSum()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::getSum

(

$groupBy = []

)

Get the sum of all matching records

Use this method to get the total X views. Pass a $groupBy argument to get the total X views for each object, grouped by one or more columns.

Parameters

array

$groupBy

One or more columns to group by

Returns

QueryObject

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

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

getTimeline()

PKP\Services\QueryBuilders\PKPStatsQueryBuilder::getTimeline

(

$date

)

Get the sum of all matching records for one day or month

Parameters

string

$date

A month or day in the format YYYY-MM or YYYY-MM-DD

Returns

QueryObject

Definition at line 207 of file PKPStatsQueryBuilder.inc.php.

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

Field Documentation

$assocIds

array PKPStatsQueryBuilder::$assocIds = []

protected

Include records for these objects. Requires $assocType to be specified.

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

Referenced by PKP\Services\QueryBuilders\PKPStatsQueryBuilder\filterByAssocIds().

$assocTypes

array PKPStatsQueryBuilder::$assocTypes = []

protected

Include records for these object types.

One or more of ASSOC_TYPE_SUBMISSION, ASSOC_TYPE_CONTEXT, ASSOC_TYPE_ISSUE, ASSOC_TYPE_SUBMISSION_FILE, ASSOC_TYPE_REPRESENTATION

Definition at line 40 of file PKPStatsQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPStatsQueryBuilder\filterByAssocTypes().

$contextIds

array PKPStatsQueryBuilder::$contextIds = []

protected

Include records for these contexts

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

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

$dateEnd

string PKPStatsQueryBuilder::$dateEnd

protected

Include records from this date or before. Default: yesterday's date

Definition at line 52 of file PKPStatsQueryBuilder.inc.php.

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

$dateStart

string PKPStatsQueryBuilder::$dateStart

protected

Include records from this date or after. Default: STATISTICS_EARLIEST_DATE

Definition at line 58 of file PKPStatsQueryBuilder.inc.php.

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

$fileTypes

array PKPStatsQueryBuilder::$fileTypes

protected

Include records for these file types: STATISTICS_FILE_TYPE_*

Definition at line 64 of file PKPStatsQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPStatsQueryBuilder\filterByFileTypes().

$sectionIds

array PKPStatsQueryBuilder::$sectionIds = []

protected

Include records from for these sections (or series in OMP)

Definition at line 70 of file PKPStatsQueryBuilder.inc.php.

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

$submissionIds

array PKPStatsQueryBuilder::$submissionIds = []

protected

Include records for these submissions

Definition at line 76 of file PKPStatsQueryBuilder.inc.php.

Referenced by PKP\Services\QueryBuilders\PKPStatsQueryBuilder\filterBySubmissions().

---

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

• PKPStatsQueryBuilder.inc.php