Bloc Use Stats (Mesure d'activité) :Services et fonctions MNET

Le bloc Use Stats fournit deux fonctions d'extraction de résultats liés à l'utilisateur. Le format de sorte dans les deux cas est un fichier XML. Ces fonctions permettent de collecter localement les statistiques de temps de score sur les cours suivis par l'utilisateur. Elles peuvent également être utilisées pour récupérer les scores déportés d'un utilisateur sur un autre Moodle connecté par le réseau MNET (collecte distribuée).

Services MNET

Service : Accès distant aux statiques d'usage.

Fonctions RPC

use_stats_rpc_get_stats

Récupère les temps de connexion agrégés dans les différents cours, modules d'activité ou le temps global.

Paramètres

callinguser : L'identité de l'utilisateur appelant

targetuser : L'identité de l'utilisateur objet de la demande

whereroot : L'hôte sur lequel les résultats sont demandés. Si vide, examine les résultats sur le Moodle courant.

statsscope : La portée des statistiques (le niveau d'agrégation)

timefrom : Date de début de la compilation

json_response : le format de la réponse

Sortie

Un fichier XML répondant à la structure :

<USE_STATS>
<USER>
<USERNAME></USERNAME>
<FIRSTNAME></FIRSTNAME>
<LASTNAME></LASTNAME>
<FROM></FROM>
<ELAPSED></ELAPSED>
</USER>
<COURSES>
<COURSE>
<NAME></NAME>
<SHORTNAME></SHORTNAME>
<IDNUMBER></IDNUMBER>
<ELAPSED></ELAPSED>
</COURSE>
</COURSES>
</USE_STATS>

ou

<USE_STATS>
<USER>
<USERNAME></USERNAME>
<FIRSTNAME></FIRSTNAME>
<LASTNAME></LASTNAME>
<FROM></FROM>
<ELAPSED></ELAPSED>
</USER>
<MODULES>
<MODULE>
<NAME></NAME>
<TYPE></TYPE>
<IDNUMBER></IDNUMBER>
<ELAPSED></ELAPSED>
</MODULE>
</MODULES>
</USE_STATS>

suivant la valeur du paramètre “statsscope”.

use_stats_rpc_get_scores

Cette fonction est un add-on pour récupérer les scores (notes) à partir du même service et sous un format et une méthode similaire à la collecte des statistiques.

{…a terminer…}

Web Services

A compter de la version 2017090600, les statistiques peuvent être récupérées par Web Services Moodle :

Fonction : block_use_stats_get_user_stats(uidsource, uid, cidsource, cid, from, to, score)

Synopsis : Récupère les données de statistiques de temps pour un utilisateur.

Paramètres

uidsource : La source de l'identifiant d'utilisateur (peut être 'id', 'idnumber', 'username' ou 'email')

uid : L'identifiant utilisateur correspondant.

cidsource : La source d'idrntifiant de cours (peut être 'id', 'idnumber' ou 'shortname')

cid : L'identifiant de cours correspondant. Si il n'est pas donné ou vaut 0 alors les statistiques sont calculées sur la totalité de l'usage de l'utilisateur dans tous les cours sur la période de référence.

from : Timestmap unix de début de période d'extraction. Si mis à 0, la totalité de la trace est calculée.

to : timestamp unix de fin de période d'extraction. Si non fourni, ou mis à 0, calclera jusqu'à la date actuelle.

score : Si mis à 1, les structures de réponse contiendront la note de cours pour chaque cours.

Sortie

Une structure composite de données contenant 4 éléments :

user : Les références de l'utilisateur

query : Un rappel des périodes d'extraction

sessions : Des statistiques sur les sessions

courses : Des statstiques cours par cours.

Exemple de structure de sortie

StdObject {
[user] => stdClass Object
(
[id] => 687
[idnumber] => ID93465
[username] => john.doe
)
[query] => stdClass Object
(
[from] => 0
[to] => 1497089144
)
[sessions] => stdClass Object
(
[sessions] => 232
[firstsession] => 1466104903
[lastsession] => 1497085452
[sessionmin] => 0
[sessionmax] => 22265
[meansession] => 2421
)
[courses] => Array
(
[0] => stdClass Object
(
[id] => 2
[idnumber] => TESTMODS
[shortname] => TEST_MODULES
[fullname] => Test modules
[activitytime] => 70240
[coursetime] => 92611
[coursetotal] => 164929
[othertime] => 0
[sitecoursetime] => 7855
)
)
}

Fonction : block_use_stats_get_users_stats(uidsource, uids, cidsource, cid, from, to, score)

Synopsis : similaire à la précédente, mais récupère une tableau de structures de réponse correspondant à une liste d'utilisateurs fournis en entrée.

Paramètres

uids : Remplace le paramètre uid de la fonction précédente, et doit contenir un tableau d'identifiants compatibles avec la valeur du paramètre uidsource.

Sortie

Un tableau de structures identiques à la sortie de la fonction précédente, pour la liste d'utilisateurs demandée.

Revenir à l'index du guide technique - Revenir à l'index des plugins - Revenir au catalogue