Systeem beschrijving

Inleiding

In dit document wordt de structuur van het systeem beschreven. Er wordt uitgelegd wat de globale directory structuur inhoudt en waar welke bestandenj te vinden zijn. Verder wordt de globale werking van alle bestanden kort uitgelegd.

Overzicht

Het systeem is in feite een extra laag bovenop het reeds bestaande schoolLAN systeem. Het deel van schoolLAN dat voor ons van toepassing is, is een verzameling scripts die instellingen manipuleren van een linux server. Het GiPLan systeem verzorgt een gebruiksvriendelijke interface waarmee deze scripts kunnen worden aangeroepen. Dit zorgt ervoor dat de gebruiker geen kennis nodig heeft van het onderliggende systeem.

Het GiPLan systeem biedt deze interface aan via een webbrowser. De gebruiker kan dus in zijn webbrowser de instellingen van het linux systeem manipuleren terwijl hij feitelijk geen kennis nodig heeft van de onderliggende techniek. In de figuur hier rechts is te zien hoe de communicatie tussen de verschillende onderdelen verloopt.

Bestandsindeling

Het GiPLan systeem bestaat uit een aantal verschillende bestandsformaten:

  • .gif - afbeeldingen die gebruikt worden voor de interface.
  • .php en .inc - hierin staat de PHP-code.
  • .tpl - de template bestanden, hierin staat HTML code, aangevuld met CSS en JavaScript.
  • .css - er is een algemeen style.css bestand waarin de opmaak voor de pagina's wordt beschreven.
  • .p - dit is de code voor de template engine. Dient onveranderd te blijven.

Verder is het systeem opgedeeld in een aantal directories.

  • afbeeldingen - in deze directory zijn de afbeeldingen te vinden die worden gebruikt voor de interface.
  • iconen - de iconen die worden gebruikt op de hoofdpagina zijn hier terug te vinden.
  • include - in deze directory zijn hulp-bestanden te vinden. Dit zijn .php of .inc bestanden die functionaliteiten aanbieden aan de daadwerkelijke PHP-pagina's.
  • gebruikers - in deze directory staan de PHP-bestanden die de pagina's genereren waar de gebruikers van het systeem kunnen worden beheerd.
  • systeem - hier staan de PHP-bestanden die de systeem-specifieke pagina's genereren.
  • template - in deze directory staan alle template bestanden.

Structuur

Afbeeldingen

In deze directory zijn alle afbeeldingen terug te vinden die binnen het systeem worden gebruikt voor de interface. Dit zijn zowel de afbeeldingen ter decoratie van de pagina, als ook de afbeeldingen die een fout aangeven.

Iconen

Hier zijn de icoontjes te vinden die worden gebruikt op het hoofdscherm.

Include

Hier zijn bestanden te vinden die essentieel zijn voor de werking van het systeem. In error.inc zijn de foutmeldingen die het systeem terug geeft te vinden. Verder zou het niet nodig moeten zijn deze bestanden aan te passen.

Gebruikers

In deze directory staan alle PHP-bestanden die te maken hebben met het gebruikers-beheer gedeelte van het systeem. Uit de namen van deze bestanden blijkt duidelijk de functie. Verder is de code van commentaar voorzien.

Systeem

Hier zijn de PHP-bestanden te vinden die te maken hebben met het beheren van het fysieke systeem. Voorlopig is hier alleen de index.php te vinden, waarin het overzichts scherm wordt getoont, en image_maken.php waarin het aanmaken van een image van de client wordt begeleidt. Hiervoor staat er ook een image_maken.bat, waarin de benodigde handelingen staan beschreven in DOS-batch formaat.

Voor de exacte werking van de code verwijzen we naar het commentaar in de code.

Template

In deze directory zijn alle .tpl bestanden terug te vinden. Kijk hier voor meer informatie over de werking van de templates.
De naamgeving van de templates is als volgt: de subdirectory naam, gevolgd door een _ en dan de pagina naam. gebruikers_aanmaken.tpl hoort dus normaal gesproken bij aanmaken.php in de gebruikers directory.
In index.tpl is de layout van de hoofdpagina terug te vinden.

Verder staan er in deze directory enkele algemene bestanden die het uiterlijk van de interface in grote lijnen bepalen. Dit zijn header.tpl, footer.tpl en style.css.

In header.tpl staat de HTML-code die bovenaan elke pagina wordt getoont en in footer.tpl de code die onderaan elke pagina komt te staan. In style.css staat de CSS code die op elke pagina van toepassing is (doordat deze wordt geinclude in header.tpl.