Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3namespace GrowthExperiments\MentorDashboard\MenteeOverview;
4
5use MediaWiki\User\UserIdentity;
6
7/**
8 * Data provider for the mentor dashboard
9 *
10 * Implementations of this interface are to be used
11 * by the mentee overview module directly.
12 */
13interface MenteeOverviewDataProvider {
14    /**
15     * Generate data for the mentor, to show in mentee overview module
16     *
17     * Formatted as an array of associative arrays representing the mentees.
18     * The associative arrays have the following attributes for each mentee:
19     *    * username – username of the mentee
20     *    * user_id – user ID of the mentee
21     *    * editcount – total number of edits
22     *    * reverted – number of reverted edits
23     *    * blocks – number of blocks placed against the
24     *    * questions – number of questions they asked via Growth features
25     *    * registration – registration timestamp as stored in user_registration in user table;
26     *      may be missing or null for very old users.
27     *
28     * @param UserIdentity $mentor
29     * @return array[]
30     */
31    public function getFormattedDataForMentor( UserIdentity $mentor ): array;
32}