From 2040275191f2e808d1c721f98342506fc955ba43 Mon Sep 17 00:00:00 2001
From: Jannik Schönartz
Date: Tue, 21 Mar 2017 13:52:23 +0100
Subject: Locationinfo: Added Comments to the functions.

---
 modules-available/locationinfo/page.inc.php | 65 ++++++++++++++++++++++++++++-
 1 file changed, 64 insertions(+), 1 deletion(-)

(limited to 'modules-available/locationinfo/page.inc.php')

diff --git a/modules-available/locationinfo/page.inc.php b/modules-available/locationinfo/page.inc.php
index 9b6df0b6..6490e722 100644
--- a/modules-available/locationinfo/page.inc.php
+++ b/modules-available/locationinfo/page.inc.php
@@ -62,6 +62,9 @@ class Page_LocationInfo extends Page
 
 	}
 
+	/**
+	 * Updates the server in the db.
+	 */
 	private function updateServer() {
 		$id = Request::post('id', 0, 'int');
 		if ($id == 0) {
@@ -76,11 +79,17 @@ class Page_LocationInfo extends Page
 		$this->checkConnection();
 	}
 
+	/**
+	 * Deletes the server from the db.
+	 */
 	private function deleteServer() {
 		$id = Request::post('id', 0, 'int');
 		Database::exec("DELETE FROM `setting_location_info` WHERE serverid=:id", array('id' => $id));
 	}
 
+	/**
+	 * Updated the config in the db.
+	 */
 	private function updateConfig()
 	{
 		$result = array();
@@ -113,6 +122,9 @@ class Page_LocationInfo extends Page
 		 Util::redirect('?do=locationinfo');
 	}
 
+	/**
+	 * Updates the server settings in the db.
+	 */
 	private function updateServerSettings() {
 		$serverid = Request::post('id', -1, 'int');
 		$servername = Request::post('name', 'unnamed', 'string');
@@ -143,6 +155,9 @@ class Page_LocationInfo extends Page
 		}
 	}
 
+	/**
+	 * Updates the opening time in the db from the expert mode.
+	 */
 	private function updateOpeningTimeExpert()
 	{
 		$days = Request::post('days');
@@ -227,6 +242,9 @@ class Page_LocationInfo extends Page
 		Util::redirect('?do=locationinfo');
 	}
 
+	/**
+	 * Updates the opening time in the db from the easy mode.
+	 */
 	private function updateOpeningTimeEasy() {
 		$locationid = Request::post('id', 0, 'int');
 		$openingtime = Request::post('openingtime');
@@ -255,6 +273,11 @@ class Page_LocationInfo extends Page
 		Util::redirect('?do=locationinfo');
 	}
 
+	/**
+	 * Checks if the server connection to a backend is valid.
+	 *
+	 * @param int $id Server id which connection should be checked.
+	 */
 	private function checkConnection($id = 0) {
 		$serverid = Request::post('id', 0, 'int');
 		if ($id != 0) {
@@ -281,6 +304,12 @@ class Page_LocationInfo extends Page
 		}
 	}
 
+	/**
+	 * Sets the new hidden value and checks childs and parents.
+	 *
+	 * @param $id The location id which was toggled
+	 * @param $val The hidden value true / false
+	 */
 	protected function toggleHidden($id, $val) {
 		Database::exec("INSERT INTO `location_info` (locationid, hidden) VALUES (:id, :hidden) ON DUPLICATE KEY UPDATE hidden=:hidden", array('id' => $id, 'hidden' => $val));
 
@@ -289,6 +318,12 @@ class Page_LocationInfo extends Page
 
 	}
 
+	/**
+	 * Recursivly sets all hidden values to all childs.
+	 *
+	 * @param $id The location id which childs should be checked
+	 * @param $val The hidden value
+	 */
 	protected function checkChildRecursive($id, $val) {
 		$dbquery = Database::simpleQuery("SELECT locationid FROM `location` WHERE parentlocationid = :locationid", array('locationid' => $id));
 		$childs = array();
@@ -303,6 +338,11 @@ class Page_LocationInfo extends Page
 		}
 	}
 
+	/**
+	 * Recursively check all parent locations and updates the hidden values if necessary
+	 *
+	 * @param $id The id of the location which was toggled.
+	 */
 	protected function checkParentRecursive($id) {
 		$dbquery = Database::simpleQuery("SELECT parentlocationid FROM `location` WHERE locationid = :locationid", array('locationid' => $id));
 		$parent = 0;
@@ -335,7 +375,9 @@ class Page_LocationInfo extends Page
 		}
 	}
 
-// Loads the Infoscreen pange in the admin-panel and passes all needed information.
+	/**
+	 * Loads the Infoscreen page in the admin-panel and passes all needed information.
+	 */
 	protected function getInfoScreenTable() {
 
 		// Get a table with the needed location info. name, id, hidden, pcState (Count of pcs that are in use), total pcs
@@ -444,6 +486,11 @@ class Page_LocationInfo extends Page
 		}
 	}
 
+	/**
+	 * Ajax the server settings.
+	 *
+	 * @param $id Serverid
+	 */
 	private function ajaxServerSettings($id) {
 		$dbresult = Database::queryFirst('SELECT servername, serverurl, servertype, credentials FROM `setting_location_info` WHERE serverid = :id', array('id' => $id));
 
@@ -514,6 +561,11 @@ class Page_LocationInfo extends Page
 		echo Render::parse('server-settings', array('id' => $id, 'name' => $dbresult['servername'], 'url' => $dbresult['serverurl'], 'servertype' => $dbresult['servertype'], 'backendList' => array_values($serverBackends)));
 	}
 
+	/**
+	 * Ajax the time table
+	 *
+	 * @param $id id of the location
+	 */
 	private function ajaxTimeTable($id) {
 		$array = array();
 		$dbquery = Database::simpleQuery("SELECT openingtime FROM `location_info` WHERE locationid = :id", array('id' => $id));
@@ -555,6 +607,12 @@ class Page_LocationInfo extends Page
 		}
 	}
 
+	/**
+	 * Checks if easymode or expert mode is active.
+	 *
+	 * @param $array Array of the saved openingtimes.
+	 * @return bool True if easy mode, false if expert mode
+	 */
 	private function isEasyMode($array) {
 		if(count($array[0]) == 3) {
 			if ($array[0][0]['days'] == array ("Monday","Tuesday","Wednesday","Thursday","Friday")
@@ -570,6 +628,11 @@ class Page_LocationInfo extends Page
 		}
 	}
 
+	/**
+	 * Ajax the config of a location.
+	 *
+	 * @param $id Location ID
+	 */
 	private function ajaxConfig($id) {
 		$array = array();
 
-- 
cgit v1.2.3-55-g7522