Download the PHP package nathnat/pronote-php without Composer
On this page you can find all versions of the php package nathnat/pronote-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nathnat/pronote-php
More information about nathnat/pronote-php
Files in nathnat/pronote-php
Package pronote-php
Short Description A PHP API wrapper for the PRONOTE student administration service.
License MIT
Homepage https://github.com/nathnat/pronote-php
Informations about the package pronote-php
Pronote PHP
Introduction
Une librairie PHP pour accéder aux données de PRONOTE depuis un compte élève. La librairie exploite l'API interne de Pronote avec PHP.
Données récupérables
- Infos Pronote, établissement et utilisateur
- Emploi du temps
- Devoirs
- Notes
- Absences/punitions/retards
Installation
Cette librairie peut être installé avec Composer et est disponible sur Packagist nathnat/pronote-php :
Utilisation
Commencez par inclure au début de votre code la librairie via Composer :
L'utilisation de la librairie est très simple et intuitif, pour se connecter, récupèrer les notes, les emplois du temps, etc.
Exemple
Si vous souhaiter vous lancer directement voici un exemple simple d'utilisation :
Je vous propose ci-dessous une documentation qui présente la plupart des fonctions principales.
Initialiser le client
Le client correspond à une instance de la classe Pronote. Un client ne peut se connecter qu'à une seule session Pronote à la fois.
Comptes région supportés
Uniquement dans le cas où vous ne pouvez PAS vous connecter directement par Pronote, mais devez passer par une interface régionale spéciale.
Si vous pouvez vous connecter directement sur l'interface de Pronote, l'API devrait fonctionner PEU IMPORTE VOTRE ACADÉMIE.
Pour l'instant peu de comptes régions sont supportés.
Voici la listes des académies supportées pour l'instant :
Cas liste
| Académie | Syntaxe du cas dans l'API | | ---------------------------------- | ----------------------------------- | | Mayotte | PronoteCas::MAYOTTE | | Guadeloupe | PronoteCas::NEOCONNECT_GUADELOUPE | | Essone | PronoteCas::ESSONNE | | Lycée Connecte Nouvelle-Aquitaine | PronoteCas::LYCEECONNECTE_AQUITAINE | | Seine-et-Marne | PronoteCas::SEINE_ET_MARNE | | Île de France | PronoteCas::ILE_DE_FRANCE | | Paris Classe Numérique | PronoteCas::PARIS_CLASSE_NUMERIQUE |Le cas doit être donné à lors de l'initialisation du client. Tous les cas sont accessibles depuis la classe PronoteCas
:
Récupèrer l'emploi du temps
La fonction timetable()
renvoie les cours de l'élève entre 2 dates, classés par ordre chronologique. Si la deuxième date n'est pas fournit, seulement les cours de la première date sont renvoyés.
Attention : Les dates doivent absolument être des instances de la classe native de PHP DateTime
La fonction renvoit un tableau de cette forme :
Récupèrer les devoirs
Similaire a la fonction ->timetable()
, la fonction qui permet de récupèrer les devoirs ->homework()
renvoit les devoirs entre 2 dates.
La fonction renvoit un tableau de cette forme :
Les périodes
Les périodes sont les périodes de l'année (Trimestre 1, Semestre 2, Brevet Blanc, etc.) fournit par l'établissement. Les périodes sont stockées dans le tableau $client->periods
. Chaque période permet d'accéder aux données qui lui sont rattachées comme les notes, les absences et les retards.
Récupèrer les notes de l'élève
Les notes sont récupèrables via la période.
Il existe trois fonctions :
-
$period->grades()
permet de récupérer un tableau de note sous cette forme : -
$period->gradesBySubject()
permet récupèrer les notes classées par matière : - Enfin,
$period->overallAverage()
permet de récupèrer la moyenne générale de l'élève :
Récupèrer les absences/retards/punitions de l'élève
-
Les notes sont récupèrables via la période :
-
Les retards sont récupèrables via la période :
- Les punitions sont récupèrables via la période :