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/register.php | 34 ++++++++++++++++++++++++++--------
 1 file changed, 26 insertions(+), 8 deletions(-)

(limited to 'www/register.php')

diff --git a/www/register.php b/www/register.php
index 07f1535..71bd87b 100755
--- a/www/register.php
+++ b/www/register.php
@@ -1,14 +1,32 @@
 <?php
 /*
-	$_GET Paramter für Oli von Max:
+	Displays the register page and possible errors. Users specify their username and password and email address to register. As this page is invite-only users must enter their invite-key aswell.
 	
-	--REGISTER--
-
-	$_GET["username"]:      derjenige, der sich registriert (wird immer mitgegeben)
-	$_GET["reason"]:	password:	leeres Passwort, oder die beiden einzugebenen stimmen nicht überein
-				encoding:	es wurden unzulässige Zeichen eingegeben 	#TODO volle Unicode Unterstützung
-				prohibited:	a) invite key stimmt nicht, b) status bit in der Datenbank ist falsch gesetzt (gesperrt), c) die versuchte E-Mail stimmt nicht mit der überein, die vom Inviter angegeben wurd 	# c) sollten wir noch ändern, nich?
-				database:	Fehler mit der Datenbank
+	TODO the email cannot differ from the address the mail was sent to.
+	
+	It has already been checked that the user isn't already logged in.
+	
+	$_GET["reason"] can have the following values:
+	
+		password: Specifies that the password wasn't the same in both fields. The user is not registered.
+		
+		database: Specifies that the request could not be fullfilled due to a database error. The user is not registered.
+		
+		encoding: Specifies that the request could not be fullfilled due to invalid symbols in the password. TODO we should support the whole UTF-8
+		
+		prohibited: Specifies that the request could not be fullfilled because the account has been marked "blocked"
+		
+		TODO success?
+		
+		TODO provide the entered data if an error occurred.
+		
+			TODO username?
+		
+			TODO email?
+		
+			TODO invite-key?
+	
+	==================================================================================================================================================
 
 */
 ?>
-- 
cgit v1.2.3