Przewodnik kodowania Moodle

Zasady ogólne

1. Wszystkie pliki powinny posiadać rozszerzenie .php.
2. Wszystkie informacje na temat praw autorskich powinny zostać zachowane. Możesz dodać własne, jeśli zajdzie taka potrzeba.
3. Każdy plik powinien zawierać główny plik config.php.
4. Każdy plik powinien sprawdzać, czy użytkownik jest zalogowany prawidłowo, korzystając z funkcji require_login() i isadmin(), isteacher(), iscreator() lub isstudent().
5. Wszystkie dostępy do bazy danych powinny opierać się na funkcjach zawartych w lib/datalib.php, jeśli to tylko możliwe. Umożliwia to szeroką kompatybilność platformy z wieloma typami baz danych. Wszystkie inne odwołania SQL powinny być : przenośne między platformami; ograniczone do określonych funkcji w twoim kodzie (zazwyczaj plik lib.php); oraz wyraźnie zaznaczone.
6. Powinna istnieć możliwość przetłumaczenia wszystkich łańcuchów znaków - utwórz nowy tekst w pliku znajdującym się w katalogu "lang/en" i odwołuj się do niego za pomocą funkcji get_string() lub print_string().
7. Powinna istnieć możliwość przetłumaczenia wszystkich plików pomocy - utwórz nowe teksty w plikach w katalogu "en/help" i odwołuj się do nich za pomocą funkcji helpbutton().

Styl kodowania

1. Nie korzystaj z tabulatorów. Wykorzystuj wcięcia składające się z czterech znaków odstępu.
2. Nawiasy muszą otaczać każdy blok kodu, nawet jeśli składa się on tylko z jednej linii. Moodle wykorzystuje następujący styl :

   if ($quiz->attempts) {
       if ($numattempts > $quiz->attempts) {
           error($strtoomanyattempts, "view.php?id=$cm->id");
       }
   }

3. Więcej treści pojawi się tu w przyszłości ... ten dokument nie jest nawet bliski ukończenia!

Dokumentacja Moodle

Version: $Id: faq.html,v 1.6 2003/03/30 13:54:28 moodler Exp $