Fonctions essentielles

Attention : vous consultez actuellement la documentation dédiée aux versions 1.x de Moodle. La documentation pour les versions 2.x de Moodle est consultable ici : Fonctions essentielles et celle pour Moodle 3.x est consultable là : Fonctions essentielles.

Voici une liste de fonctions importantes du code du logiciel Moodle.

La quasi totalité de ces fonctions se trouvent dans le répertoire lib.

Fonctions relatives à la localisation

  • get_string() - va chercher la chaîne de caractères dans le paquetage de langue sélectionné par l'utilisateur
  • print_string() - imprime la chaîne de caractères dans le paquetage de langue sélectionné par l'utilisateur
  • print_error() - imprime un message d'erreur, en étant allé le chercher dans le paquetage de langue

Fonctions interrogeant le statut de l'utilisateur

  • isadmin() - vérifie si l'utilisateur est un administrateur du site

On remplace de plus en plus cette dernière par le test de la capacité "moodle/site:doanything" :

   $context = get_context_instance(CONTEXT_SYSTEM);
   has_capability('moodle/site:doanything', $context);
  • isloggedin() - vérifie si l'utilisateur est loggué
  • isguest() - vérifie si l'utilisateur n'est pas en statut "d'invité"

Fonctions d'impression et de génération de HTML

  • print_header() - ajoute l'en-tête de la page
  • print_footer() - ajoute le bas de page
  • print_table() - imprime une table formattée sur la base d'une structure la décrivant.
  • print_tabs() - imprime une ou plusieurs rangées d'onglets avec un système pour les utiliser comme barre de navigation

Fonctions d'accès au modèle de données

  • get_records() - récupère une hash d'enregistrements choisis
  • get_record() - récupère un enregistrement particulier
  • get_records_select()
  • get_record_select()

mêmes fonctions que précédemment, mais permet d'écrire la clause SELECT à la main.

  • get_records_sql()
  • get_record_sql()

mêmes fonctions que précédemment, mais permet d'écrire la totalité de la requête SQL.

  • get_records_menu() - permet d'obtenir directement le tableau d'options d'une liste déroulante à partir d'un lot d'enregistrements choisis.
  • get_records_list() - permet d'obtenir les enregistrements à partir d'une liste d'id (typiquement id IN (liste)).
  • insert_record() - permet d'ajouter un nouvel enregistrement. Retourne le dernier "id" créé en base de données.
  • update_record() - permet de mettre à jour un enregistrement. L'objet passé DOIT avoir un membre "id".
  • delete_records() - permet de détruire des enregistrements

ATTENTION : Certaines de ces fonctions ont changé avec le remodelage de la librairie d'accès à la base de données. Si vous développez en vue d'une intégration pour du Moodle 2.0, vous devrez tenir compte de ces nouvelles formes

Les pages de fonctions

weblib - toutes les fonctions qui produisent une sortie en code HTML

Voir aussi