Utilisation avancée

Avertissement

Toutes les interactions avec l'api se font en passant par les méthodes de la classe Bdu_Api.

Installation avec Composer

L'API peut être installée via Composer:

{
    "require": {
        "sde/bdu-api": "1.0.*@dev"
    },
    "repositories": [
        {
            "type": "vcs",
            "url": "http://git.notk.org/gitolite/stof/bdu-api.git"
        }
    ]
}

Utilisation d'un autre autoloader

L'API utilise un autoloader pour charger ses classes. Un autoloader est présent dans le code de l'API. Il est enregistré comme autoloader dans le fichier bdu-api/lib/autoload.php quand vous l'incluez dans votre page.

Les classes suivent la convention de nommage PEAR donc vous pouvez aussi utiliser votre propre autoloader au lieu de celui utilisé par défaut. Il vous suffit d'enregistrer le préfixe Bdu_ pour le dossier bdu-api/lib. Cela est par exemple utilisé lorsque vous utilisez le bundle d'intégration dans Symfony 2.

Utilisation d'un autre logueur

Vous pouvez définir votre propre logueur et l'utiliser avec l'api. Il vous suffit pour cela d'implémenter l'interface Bdu_Log_LoggerInterface dans votre classe.

Récupération groupée des données ldap

Quand vous récupérez les résultats d'une recherche d'étudiants, chaque objet ne contient que le login SdE de l'étudiant. Les autres propriétés ne seront récupérées dans le ldap que la première fois que vous les utilisez.

Si vous utilisez beaucoup d'objets Bdu_Entity_Student sur votre page en accédant à leurs propriétés, cela va générer beaucoup de requêtes ldap. Vous pouvez améliorer les performances en les récupérant en une seule requête.

<?php
$api = Bdu_Container::getApiInstance();

// $student est un tableau d'objets de type Bdu_Entity_Student
$students = $api->searchStudentsByName('Gorêt', 'Ignace');

$api->batchRetrieveStudents($students);
// Tous les objets du tableau possèdent maintenant toutes leurs propriétés ldap

Note

Cette fonctionnalité est utilisée par défaut quand vous récupérez les membres d'une association avec Bdu_Entity_Association::getAllStudents() ou Bdu_Entity_Association::getCurrentStudents()