P5

REST Webservices

Mitarbeiterverwaltung (Bertram Rützler)

• Endpoint: «rest/ma.server.php» 
   
• Rückgabe-Parameter: 
  • status: 
    • 0 … alles OK 
    • 1 … keine Aktion ausgewählt 
    • 2 … ungültiger xpath (bei browse-funktion) 
  • xml: 
    • Antwort im xml-Format 
       
• Beispiel-Aufruf: «rest/ma.test.phps» 
  • Parameter im Format RiddlParameterSimplex: 
    • action: UseCase (anlegen, bearbeiten, anzeigen, gehalt, archivieren) 
    • id: Mitarbeiter-ID 
    • area: wenn action=bearbeiten, dann zu bearbeitender Bereich (name,address,contact,employmentstatus) 
    • [firstname|givenname|surname]: neue Werte für area=name 
    • [street|postcode|city|province|country]: neue Werte für area=address 
    • [tel|email|bankaccount]: neue Werte für area=contact 
    • [type|salary|lastbonus]: neue Werte für area=employmentstatus 
       
• Beispiel-Antwort: «rest/ma.test.php» 
   
• Weiteres Service: XML-Browser für die Datei employees.xml 
  • «rest/ma.browser.php» 

Userbase (Konrad Grimm)

SOAP Webservices

Dienstplansystem (Manuel Bauer)

• Details: 
  siehe wsdl: 
  /svc/wpService.php 
   
• Aufrufanweisung 
  Das Webservice ist voll funktionstüchtig. 
  Um diese Funktion zu prüfen, oder einfach als Codeschnipsel, wenn man das SOAP-Service einbinden möchte habe ich einen Client gebaut. 
  Dieser ist zu finden unter:  
  /svc/wpServiceClient.php 
   
  • Wochenplan anzeigen 
    /svc/wpServiceClient.php?action=createweek 
    Zeigt den Wochenplan der CW 36 von 2009 an. 
  • Wochenplan erzeugen 
    /svc/wpServiceClient.php?action=createweek 
    Erzeugt einen völlig zufälligen Dienstplan zwischen 2008 und 2012. 
  • Tag anzeigen 
    /svc/wpServiceClient.php?action=getDay 
    Zeigt Dienstag in der CW36 2009 an. 
  • Schichten hinzufügen 
    /svc/wpServiceClient.php?action=createduty 
    legt an besagtem Dienstag folgende Schicht an: 
    <duty timefrom="16:00" timeuntil="16:05" employeeID="2" xsi:type="ns1:duty"/> 
  • Schichten entfernen 
    /svc/wpServiceClient.php?action=removeduty 
    löscht an besagtem Dienstag jedes Vorkommnis folgender Schicht : 
    <duty timefrom="16:00" timeuntil="16:05" employeeID="2" xsi:type="ns1:duty"/> 

Dokumentation

Beschreibung der Struktur

• Stammverzeichnis 
  hier landen die gestylten UI php files die die Präsentationsschicht darstellen. 
  keine Applikationslogik! 
   
  • data 
    hier liegt der Datenstamm (die XML-Files) des projekts 
     
    • wp 
      Verzeichnis der abgelegten Dienstpläne 
       
  • inc 
    in inc werden die Klassen und andere includes abgebildet 
    Bsp: Klassen; Funktionen die den Datenlayer abstrahieren sollen. 
     
  • op 
    für ausführbaren code der Klassen instanziert und Daten manipuliert, reine Skripte ohne Präsentationslogik. 
     
  • out 
    hier findet userinteraktion statt. Zunächst mit html bausteinen die aus root mit includes oder mit ajax nachgeladen wird. 
     
  • xml_proc 
    Der richtige Platz für alle XSDs und XSLs. Besagte liegen nicht in dem Datenlayer weil dort andere Berechtiungsbedingungen herrschen sollen. 
     
  • svc 
    Die Servicekomponenten landen hier drin. 
    Sie sind von der Klassenstruktur klar getrennt, benutzen aber im Gegensatz zum Präsentationslayer nicht den op layer zur ABstraktion sondern enthalten ihr eigenes logisches Abbild von der Programmlogik. 
     
  • style 
    für CSS 
     
  • img 
    für bilder