From b35a32ef5287e5746ad724c649fc2cb43d581c17 Mon Sep 17 00:00:00 2001
From: Philip Häusler <msquare@notrademark.de>
Date: Tue, 7 Jan 2014 15:56:31 +0100
Subject: completed api comments

---
 includes/model/AngelType_model.php | 30 ++++++++++++++++++++++++------
 1 file changed, 24 insertions(+), 6 deletions(-)

(limited to 'includes/model/AngelType_model.php')

diff --git a/includes/model/AngelType_model.php b/includes/model/AngelType_model.php
index bc07ace7..180712b2 100644
--- a/includes/model/AngelType_model.php
+++ b/includes/model/AngelType_model.php
@@ -1,26 +1,44 @@
 <?php
 
+/**
+ * Delete an Angeltype.
+ * @param Angeltype $angeltype
+ */
 function AngelType_delete($angeltype) {
-  sql_query("DELETE FROM `NeededAngelTypes` WHERE `angel_type_id`=" . sql_escape($angeltype['id']) . " LIMIT 1");
-  sql_query("DELETE FROM `ShiftEntry` WHERE `TID`=" . sql_escape($angeltype['id']) . " LIMIT 1");
-  sql_query("DELETE FROM `UserAngelTypes` WHERE `angeltype_id`=" . sql_escape($angeltype['id']) . " LIMIT 1");
-  return sql_query("DELETE FROM `AngelTypes` WHERE `id`=" . sql_escape($angeltype['id']) . " LIMIT 1");
+  return sql_query("
+      DELETE FROM `AngelTypes` 
+      WHERE `id`=" . sql_escape($angeltype['id']) . " 
+      LIMIT 1");
 }
 
+/**
+ * Update Angeltype.
+ *
+ * @param int $angeltype_id          
+ * @param string $name          
+ * @param boolean $restricted          
+ */
 function AngelType_update($angeltype_id, $name, $restricted) {
   return sql_query("
       UPDATE `AngelTypes` SET 
       `name`='" . sql_escape($name) . "', 
-      `restricted`=" . sql_escape($restricted) . " 
+      `restricted`=" . sql_escape($restricted ? 1 : 0) . " 
       WHERE `id`=" . sql_escape($angeltype_id) . " 
       LIMIT 1");
 }
 
+/**
+ * Create an Angeltype.
+ *
+ * @param string $name          
+ * @param boolean $restricted          
+ * @return New Angeltype id
+ */
 function AngelType_create($name, $restricted) {
   $result = sql_query("
       INSERT INTO `AngelTypes` SET 
       `name`='" . sql_escape($name) . "', 
-      `restricted`=" . sql_escape($restricted));
+      `restricted`=" . sql_escape($restricted ? 1 : 0));
   if ($result === false)
     return false;
   return sql_id();
-- 
cgit v1.2.3-54-g00ecf