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/UserAngelTypes_model.php | 39 +++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)

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

diff --git a/includes/model/UserAngelTypes_model.php b/includes/model/UserAngelTypes_model.php
index e931e04b..4987eddd 100644
--- a/includes/model/UserAngelTypes_model.php
+++ b/includes/model/UserAngelTypes_model.php
@@ -1,5 +1,10 @@
 <?php
 
+/**
+ * Delete all unconfirmed UserAngelTypes for given Angeltype.
+ * 
+ * @param int $angeltype_id
+ */
 function UserAngelTypes_delete_all($angeltype_id) {
   return sql_query("
       DELETE FROM `UserAngelTypes`
@@ -7,6 +12,12 @@ function UserAngelTypes_delete_all($angeltype_id) {
       AND `confirm_user_id` IS NULL");
 }
 
+/**
+ * Confirm all unconfirmed UserAngelTypes for given Angeltype.
+ *
+ * @param int $angeltype_id          
+ * @param User $confirm_user          
+ */
 function UserAngelTypes_confirm_all($angeltype_id, $confirm_user) {
   return sql_query("
       UPDATE `UserAngelTypes`
@@ -15,6 +26,12 @@ function UserAngelTypes_confirm_all($angeltype_id, $confirm_user) {
       AND `confirm_user_id` IS NULL");
 }
 
+/**
+ * Confirm an UserAngelType with confirming user.
+ *
+ * @param int $user_angeltype_id          
+ * @param User $confirm_user          
+ */
 function UserAngelType_confirm($user_angeltype_id, $confirm_user) {
   return sql_query("
       UPDATE `UserAngelTypes`
@@ -23,6 +40,11 @@ function UserAngelType_confirm($user_angeltype_id, $confirm_user) {
       LIMIT 1");
 }
 
+/**
+ * Delete an UserAngelType.
+ *
+ * @param UserAngelType $user_angeltype          
+ */
 function UserAngelType_delete($user_angeltype) {
   return sql_query("
       DELETE FROM `UserAngelTypes` 
@@ -30,6 +52,12 @@ function UserAngelType_delete($user_angeltype) {
       LIMIT 1");
 }
 
+/**
+ * Create an UserAngelType.
+ *
+ * @param User $user          
+ * @param Angeltype $angeltype          
+ */
 function UserAngelType_create($user, $angeltype) {
   $result = sql_query("
     INSERT INTO `UserAngelTypes` SET
@@ -40,6 +68,11 @@ function UserAngelType_create($user, $angeltype) {
   return sql_id();
 }
 
+/**
+ * Get an UserAngelType by its id.
+ *
+ * @param int $user_angeltype_id          
+ */
 function UserAngelType($user_angeltype_id) {
   $angeltype = sql_select("
       SELECT *
@@ -53,6 +86,12 @@ function UserAngelType($user_angeltype_id) {
   return $angeltype[0];
 }
 
+/**
+ * Get an UserAngelType by user and angeltype.
+ *
+ * @param User $user          
+ * @param Angeltype $angeltype          
+ */
 function UserAngelType_by_User_and_AngelType($user, $angeltype) {
   $angeltype = sql_select("
       SELECT * 
-- 
cgit v1.2.3-54-g00ecf