From 09d24a3f321476ecdbbf10156fe724343a7d4084 Mon Sep 17 00:00:00 2001
From: oweissbarth
Date: Fri, 14 Mar 2014 20:31:13 +0100
Subject: Removed more warnings. Added and reorganized inline docs. Every file
 should have a small header explaining what the file does and what the
 paramerters are.

---
 www/login.php | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

(limited to 'www/login.php')

diff --git a/www/login.php b/www/login.php
index c2847b3..3207703 100755
--- a/www/login.php
+++ b/www/login.php
@@ -1,13 +1,19 @@
 <?php
-/*
-	$_GET Paramter für Oli von Max:
-
-	--LOGIN--
-
-	$_GET["username"]: 	derjenige, der sich ein-/ausloggt (wird immer mitgegeben)
-	$_GET["reason"]:	failure 	wenn das Passwort aus der Datenbank nicht übereinstimmt mit dem eingegeben
-				database	wenn aus irgendwelchen Gründen nicht in die Datenbank geschrieben werden kann aka. transaction failed
-				logout		nachdem logout erfolgreich war (man wird auf /login wieder zurück geleitet)
+	/*
+	Displays the login page and possible errors. Users can enter their username and password to login. TODO recover Password
+	It has already been checked that the user isn't already logged in.
+	
+	$_GET["reason"] can have the following values:
+	
+		failure: Specifies that the username and password didn't match. The user is not logged in.
+		
+		database: Specifies that the request could not be fullfilled due to a database error. The user is not logged in.
+		
+		succuss: Specifies that the request was successfull. TODO should probably redirect to user root.
+		
+	$_GET["username"] contains the username if a prior attempt to login wasn't successfull.
+	
+	==================================================================================================================================================
 
 */
 ?>
-- 
cgit v1.2.3