bug 1138: Documentation and minor fixes
authorMichael Tänzer <neo@nhng.de>
Mon, 31 Mar 2014 15:13:49 +0000 (17:13 +0200)
committerMichael Tänzer <neo@nhng.de>
Mon, 31 Mar 2014 15:13:49 +0000 (17:13 +0200)
Signed-off-by: Michael Tänzer <neo@nhng.de>
includes/notary.inc.php
pages/account/59.php

index 7841484..ceb1530 100644 (file)
        }
 
        /**
-        * get_given_assurances()
-        *  returns the list of assurances given by the user
-        * @param mixed $userid - user id for the account for report
-        * @param integer $log - for log output = 1
-        * @return
+        * Get the list of assurances given by the user
+        * @param int $userid - id of the assurer
+        * @param int $log - if set to 1 also includes deleted assurances
+        * @return resource - a MySQL result set
         */
-       function get_given_assurances ($userid, $log=0)
+       function get_given_assurances($userid, $log=0)
        {
                $deleted='';
                if ($log == 0) {
                        $deleted = ' and `deleted` = 0 ';
                }
-               $res = query_init ("select * from `notary` where `from`='".intval($userid)."' and `from` != `to` $deleted order by `id` asc");
+               $res = query_init("select * from `notary` where `from`='".intval($userid)."' and `from` != `to` $deleted order by `id` asc");
                return $res;
        }
 
        /**
-        * get_received_assurances()
-        *  returns the list of assurances received by the user
-        * @param mixed $userid - user id for the account for report
-        * @param integer $log - for log output = 1
-        * @return
+        * Get the list of assurances received by the user
+        * @param int $userid - id of the assuree
+        * @param integer $log - if set to 1 also includes deleted assurances
+        * @return resource - a MySQL result set
         */
-       function get_received_assurances ($userid, $log=0)
+       function get_received_assurances($userid, $log=0)
        {
                $deleted='';
                if ($log == 0) {
                        $deleted = ' and `deleted` = 0 ';
                }
-               $res = query_init ("select * from `notary` where `to`='".intval($userid)."' and `from` != `to` $deleted order by `id` asc  ");
+               $res = query_init("select * from `notary` where `to`='".intval($userid)."' and `from` != `to` $deleted order by `id` asc  ");
                return $res;
        }
 
 <?
        }
 
+       /**
+        * Render an assurance for a view
+        * @param int     $assuranceid - id of the assurance
+        * @param string  $date - When the assurance took place in user provided format
+        * @param string  $when - When the assurance was entered (ISO format), only visible for support
+        * @param string  $email - Email address of the other party, only visible for support
+        * @param string  $name - Name of the other party
+        * @param int     $awarded - The points the Assurer wanted to issue (not rounded down)
+        * @param int     $points - The points recognised by the system (rounded down)
+        * @param string  $location - Where the assurance took place
+        * @param string  $method - The method used to make the assurance (Face-to-Face, Administrative Increase, etc.)
+        * @param int     $experience - Number of experience points the Assurer got for this assurance
+        * @param int     $userid - Id of the user whichs given/received assurances are displayed
+        * @param int     $support - set to 1 if the output is for the support interface
+        * @param bool    $revoked - whether the assurance is already revoked
+        * @param string  $ticketno - ticket number currently set in the support interface
+        */
        function output_assurances_row($assuranceid,$date,$when,$email,$name,$awarded,$points,$location,$method,$experience,$userid,$support,$revoked, $ticketno)
        {
 
                <td class="DataTD" <?=$tdstyle?>><?=$emopen?><?=$assuranceid?><?=$emclose?></td>
                <td class="DataTD" <?=$tdstyle?>><?=$emopen?><?=$date?><?=$emclose?></td>
 <?
-               if ($support == "1")
+               if ($support == 1)
                {
 ?>
                <td class="DataTD" <?=$tdstyle?>><?=$emopen?><?=$when?><?=$emclose?></td>
                <td class="DataTD" <?=$tdstyle?>><?=$emopen?><?=$method?><?=$emclose?></td>
                <td class="DataTD" <?=$tdstyle?>><?=$emopen?><?=$experience?><?=$emclose?></td>
 <?
-               if ($support == "1")
+               if ($support == 1)
                {
                        if ($revoked == true)
                        {
 
 // ************* output given assurances ******************
 
+       /**
+        * Helper function to render assurances given by the user
+        * @param int  $userid
+        * @param int& $points - [out] sum of given points
+        * @param int& $sum_experience - [out] sum of experience points gained
+        * @param int  $support - set to 1 if the output is for the support interface
+        * @param string $ticketno - the ticket number set in the support interface
+        */
        function output_given_assurances_content($userid,&$points,&$sum_experience,$support, $ticketno)
        {
                $points = 0;
 
 // ************* output received assurances ******************
 
+       /**
+        * Helper function to render assurances received by the user
+        * @param int  $userid
+        * @param int& $points - [out] sum of received points
+        * @param int& $sum_experience - [out] sum of experience points the assurers gained
+        * @param int  $support - set to 1 if the output is for the support interface
+        * @param string $ticketno - the ticket number set in the support interface
+        */
        function output_received_assurances_content($userid,&$points,&$sum_experience,$support, $ticketno)
        {
                $points = 0;
                return $issue_points;
        }
 
+       /**
+        * Render assurances given by the user
+        * @param int $userid
+        * @param int $support - set to 1 if the output is for the support interface
+        * @param string $ticketno - the ticket number set in the support interface
+        */
        function output_given_assurances($userid, $support=0, $ticketno='')
        {
                output_assurances_header(_("Assurance Points You Issued"),$support);
                output_assurances_footer(_("Total Points Issued"),$points,_("Total Experience Points"),$sum_experience,$support);
        }
 
+       /**
+        * Render assurances received by the user
+        * @param int $userid
+        * @param int $support - set to 1 if the output is for the support interface
+        * @param string $ticketno - the ticket number set in the support interface
+        */
        function output_received_assurances($userid,$support=0, $ticketno='')
        {
                output_assurances_header(_("Your Assurance Points"),$support);
index 51eb6ef..8d76789 100644 (file)
@@ -26,7 +26,7 @@ $res =get_user_data($userid);
 
 if(mysql_num_rows($res) <= 0)
 {
-    echo _("I'm sorry, the user you were looking for seems to have disappeared! Bad things are a foot!");
+    echo _("I'm sorry, the user you were looking for seems to have disappeared! Bad things are afoot!");
     exit;
 }
 
@@ -46,7 +46,8 @@ if(intval($_REQUEST['oldid'])==43){
 }
 $ticketno = ""; if(array_key_exists('ticketno', $_SESSION)) $ticketno = $_SESSION['ticketno'];
 if (!valid_ticket_number($ticketno) && $support == 1) {
-    printf(_("I'm sorry, you did not enter a ticket number!%sSupport is not allowed to view the account history without a ticket number.%s"), '<br/>', '<br/><a href="account.php?id=43&amp;userid=' . intval($_REQUEST['userid']) .'">'. _('Back to previous page.').'</a>');
+    printf(_("I'm sorry, you did not enter a ticket number!%sSupport is not allowed to view the account history without a ticket number."), '<br/>');
+    echo '<br/><a href="account.php?id=43&amp;userid=' . intval($_REQUEST['userid']) .'">'. _('Back to previous page.').'</a>';
     showfooter();
     exit;
 }