GEANT / CAT

web/lib/admin/view/html/Table.php

Doc Comments +1 added lines, -2 removed lines

@@ -29,7 +29,7 @@ 
     
     /**
      * 
-     * @return number
+     * @return integer
      */
     public function size(){
         return count($this->rows);
@@ -53,7 +53,6 @@ 
     
     /**
      * 
-     * @param array $row
      */
     public function addRowArray($cells){
         $this->addRow(new Row($cells));

tests/unit/web/lib/admin/view/InstitutionPageBuilderTest.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      * @param unknown $input
      * @param unknown $owner
      * @throws Exception
-     * @return mixed
+     * @return MockInstitution
      */
     private function valid_IdP($input, $owner){
         if ($input == 1){

web/admin/inc/manageAdmins.inc.php

Switch Indentation +8 added lines, -8 removed lines

@@ -97,14 +97,14 @@
         case "SUCCESS":
             $cryptText = "";
             switch ($_GET['transportsecurity']) {
-            case "ENCRYPTED":
-                $cryptText = _("and <b>encrypted</b> to the mail domain");
-                break;
-            case "CLEAR":
-                $cryptText = _("but <b>in clear text</b> to the mail domain");
-                break;
-            default:
-                throw new Exception("Error: unknown encryption status of invitation!?!");
+                case "ENCRYPTED":
+                    $cryptText = _("and <b>encrypted</b> to the mail domain");
+                    break;
+                case "CLEAR":
+                    $cryptText = _("but <b>in clear text</b> to the mail domain");
+                    break;
+                default:
+                    throw new Exception("Error: unknown encryption status of invitation!?!");
             }
             echo $uiElements->boxRemark(sprintf(_("The invitation email was sent successfully %s."), $cryptText), _("The invitation email was sent."));
             break;

core/diag/Telepath.php

Doc Comments +3 added lines

@@ -120,6 +120,9 @@
         return Telepath::STATUS_GOOD;
     }
 
+    /**
+     * @param string $homeFlr
+     */
     private function checkNROFlow($visitedFlr, $homeFlr) {
         // TODO: this is a stub, need eduroam OT API to query the current server status
         // APIQueryNRODirect($visitedFlr, $homeFlr);

web/lib/admin/domain/SilverbulletInvitation.php

Doc Comments +1 added lines, -1 removed lines

@@ -53,7 +53,7 @@
     
     /**
      * 
-     * @param $silverbulletUser SilverbulletUser
+     * @param SilverbulletUser|null $silverbulletUser SilverbulletUser
      */
     public function __construct($silverbulletUser) {
         parent::__construct(self::TABLE, self::TYPE_INST);

web/lib/admin/UIElements.php

Doc Comments +11 added lines, -4 removed lines

@@ -120,6 +120,9 @@ 
         return $find[0];
     }
 
+    /**
+     * @param string $input
+     */
     public function tooltip($input) {
         $descriptions = [];
         if (count(CONFIG_CONFASSISTANT['CONSORTIUM']['ssid']) > 0) {
@@ -256,6 +259,10 @@ 
         return $number . " B";
     }
 
+    /**
+     * @param string $ref
+     * @param boolean $checkpublic
+     */
     public static function getBlobFromDB($ref, $checkpublic) {
         $validator = new \web\lib\common\InputValidation();
         $reference = $validator->databaseReference($ref);
@@ -402,7 +409,7 @@ 
      * @param string $text the text to display
      * @param string $caption the caption to display
      * @param bool $omittabletags the output usually has tr/td table tags, this option suppresses them
-     * @return type
+     * @return string
      */
     public function boxOkay(string $text = NULL, string $caption = NULL, bool $omittabletags = FALSE) {
         return $this->boxFlexible(\core\common\Entity::L_OK, $text, $caption, $omittabletags);
@@ -414,7 +421,7 @@ 
      * @param string $text the text to display
      * @param string $caption the caption to display
      * @param bool $omittabletags the output usually has tr/td table tags, this option suppresses them
-     * @return type
+     * @return string
      */
     public function boxRemark(string $text = NULL, string $caption = NULL, bool $omittabletags = FALSE) {
         return $this->boxFlexible(\core\common\Entity::L_REMARK, $text, $caption, $omittabletags);
@@ -426,7 +433,7 @@ 
      * @param string $text the text to display
      * @param string $caption the caption to display
      * @param bool $omittabletags the output usually has tr/td table tags, this option suppresses them
-     * @return type
+     * @return string
      */
     public function boxWarning(string $text = NULL, string $caption = NULL, bool $omittabletags = FALSE) {
         return $this->boxFlexible(\core\common\Entity::L_WARN, $text, $caption, $omittabletags);
@@ -438,7 +445,7 @@ 
      * @param string $text the text to display
      * @param string $caption the caption to display
      * @param bool $omittabletags the output usually has tr/td table tags, this option suppresses them
-     * @return type
+     * @return string
      */
     public function boxError(string $text = NULL, string $caption = NULL, bool $omittabletags = FALSE) {
         return $this->boxFlexible(\core\common\Entity::L_ERROR, $text, $caption, $omittabletags);

web/admin/inc/sendinvite.inc.php

Switch Indentation +78 added lines, -78 removed lines

@@ -77,90 +77,90 @@
 }
 
 switch ($operationMode) {
-    case OPERATION_MODE_EDIT:
-        $idp = $validator->IdP($_GET['inst_id']);
-        // editing IdPs is done from within the popup. When we're done, send the 
-        // user back to the popup (append the result of the operation later)
-        $redirect_destination = "manageAdmins.inc.php?inst_id=" . $idp->identifier . "&";
-        $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
-        // is the user admin of this IdP?
-        $is_owner = FALSE;
-        $owners = $idp->owner();
-        foreach ($owners as $oneowner) {
-            if ($oneowner['ID'] == $_SESSION['user'] && $oneowner['LEVEL'] == "FED") {
-                $is_owner = TRUE;
+        case OPERATION_MODE_EDIT:
+            $idp = $validator->IdP($_GET['inst_id']);
+            // editing IdPs is done from within the popup. When we're done, send the 
+            // user back to the popup (append the result of the operation later)
+            $redirect_destination = "manageAdmins.inc.php?inst_id=" . $idp->identifier . "&";
+            $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
+            // is the user admin of this IdP?
+            $is_owner = FALSE;
+            $owners = $idp->owner();
+            foreach ($owners as $oneowner) {
+                if ($oneowner['ID'] == $_SESSION['user'] && $oneowner['LEVEL'] == "FED") {
+                    $is_owner = TRUE;
+                }
+            }
+            // check if he is (also) federation admin for the federation this IdP is in. His invitations have more blessing then.
+            $fedadmin = $userObject->isFederationAdmin($idp->federation);
+            // check if he is either one, if not, complain
+            if (!$is_owner && !$fedadmin) {
+                echo "<p>" . sprintf(_("Something's wrong... you are a %s admin, but not for the %s the requested %s belongs to!"), $uiElements->nomenclature_fed, $uiElements->nomenclature_fed, $uiElements->nomenclature_inst) . "</p>";
+                exit(1);
             }
-        }
-        // check if he is (also) federation admin for the federation this IdP is in. His invitations have more blessing then.
-        $fedadmin = $userObject->isFederationAdmin($idp->federation);
-        // check if he is either one, if not, complain
-        if (!$is_owner && !$fedadmin) {
-            echo "<p>" . sprintf(_("Something's wrong... you are a %s admin, but not for the %s the requested %s belongs to!"), $uiElements->nomenclature_fed, $uiElements->nomenclature_fed, $uiElements->nomenclature_inst) . "</p>";
-            exit(1);
-        }
 
-        $prettyprintname = $idp->name;
-        $newtoken = $mgmt->createToken($fedadmin, $mailaddress, $idp);
-        $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP " . $idp->identifier . " - Token created for " . $mailaddress);
-        $introtext = sprintf(_("a %s of the %s %s \"%s\" has invited you to manage the %s together with him."), $uiElements->nomenclature_fed, CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_inst, $prettyprintname, $uiElements->nomenclature_inst) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
-        break;
-    case OPERATION_MODE_NEWUNLINKED:
-        $redirect_destination = "../overview_federation.php?";
-        $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
-        // run an input check and conversion of the raw inputs... just in case
-        $newinstname = $validator->string($_POST['name']);
-        $newcountry = $validator->string($_POST['country']);
-        $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($newcountry);
-        if ($new_idp_authorized_fedadmin !== TRUE) {
-            throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
-        }
-        $federation = $validator->Federation($newcountry);
-        $prettyprintname = $newinstname;
-        $introtext = sprintf(_("a %s %s has invited you to manage the future %s  \"%s\" (%s)."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname, $newcountry) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
-        // send the user back to his federation overview page, append the result of the operation later
-        // do the token creation magic
-        $newtoken = $mgmt->createToken(TRUE, $mailaddress, $newinstname, 0, $newcountry);
-        $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
-        break;
-    case OPERATION_MODE_NEWFROMDB:
-        $redirect_destination = "../overview_federation.php?";
-        $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
-        // a real external DB entry was submitted and all the required parameters are there
-        $newexternalid = $validator->string($_POST['externals']);
-        $extinfo = $catInstance->getExternalDBEntityDetails($newexternalid);
-        $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($extinfo['country']);
-        if ($new_idp_authorized_fedadmin !== TRUE) {
-            throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
-        }
-        $federation = $validator->Federation($extinfo['country']);
-        $newcountry = $extinfo['country'];
-        // see if the inst name is defined in the currently set language; if not, pick its English name; if N/A, pick the last in the list
-        $prettyprintname = "";
-        foreach ($extinfo['names'] as $lang => $name) {
-            if ($lang == $languageInstance->getLang()) {
-                $prettyprintname = $name;
+            $prettyprintname = $idp->name;
+            $newtoken = $mgmt->createToken($fedadmin, $mailaddress, $idp);
+            $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP " . $idp->identifier . " - Token created for " . $mailaddress);
+            $introtext = sprintf(_("a %s of the %s %s \"%s\" has invited you to manage the %s together with him."), $uiElements->nomenclature_fed, CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_inst, $prettyprintname, $uiElements->nomenclature_inst) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
+            break;
+        case OPERATION_MODE_NEWUNLINKED:
+            $redirect_destination = "../overview_federation.php?";
+            $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
+            // run an input check and conversion of the raw inputs... just in case
+            $newinstname = $validator->string($_POST['name']);
+            $newcountry = $validator->string($_POST['country']);
+            $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($newcountry);
+            if ($new_idp_authorized_fedadmin !== TRUE) {
+                throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
             }
-        }
-        if ($prettyprintname == "" && isset($extinfo['names']['en'])) {
-            $prettyprintname = $extinfo['names']['en'];
-        }
-        if ($prettyprintname == "") {
-            foreach ($extinfo['names'] as $name) {
-                $prettyprintname = $name;
+            $federation = $validator->Federation($newcountry);
+            $prettyprintname = $newinstname;
+            $introtext = sprintf(_("a %s %s has invited you to manage the future %s  \"%s\" (%s)."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname, $newcountry) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
+            // send the user back to his federation overview page, append the result of the operation later
+            // do the token creation magic
+            $newtoken = $mgmt->createToken(TRUE, $mailaddress, $newinstname, 0, $newcountry);
+            $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
+            break;
+        case OPERATION_MODE_NEWFROMDB:
+            $redirect_destination = "../overview_federation.php?";
+            $mailaddress = abortOnBogusMail($newmailaddress, $redirect_destination);
+            // a real external DB entry was submitted and all the required parameters are there
+            $newexternalid = $validator->string($_POST['externals']);
+            $extinfo = $catInstance->getExternalDBEntityDetails($newexternalid);
+            $new_idp_authorized_fedadmin = $userObject->isFederationAdmin($extinfo['country']);
+            if ($new_idp_authorized_fedadmin !== TRUE) {
+                throw new Exception("Something's wrong... you want to create a new " . $uiElements->nomenclature_inst . ", but are not a " . $uiElements->nomenclature_fed . " admin for the " . $uiElements->nomenclature_fed . " it should be in!");
             }
-        }
-        // fill the rest of the text
-        $introtext = sprintf(_("a %s %s has invited you to manage the %s  \"%s\"."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
-        // do the token creation magic
-        $newtoken = $mgmt->createToken(TRUE, $mailaddress, $prettyprintname, $newexternalid);
-        $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
-        break;
-    default: // includes OPERATION_MODE_INVALID
-        $wrongcontent = print_r($_POST, TRUE);
-        echo "<pre>Wrong parameters in POST:
+            $federation = $validator->Federation($extinfo['country']);
+            $newcountry = $extinfo['country'];
+            // see if the inst name is defined in the currently set language; if not, pick its English name; if N/A, pick the last in the list
+            $prettyprintname = "";
+            foreach ($extinfo['names'] as $lang => $name) {
+                if ($lang == $languageInstance->getLang()) {
+                    $prettyprintname = $name;
+                }
+            }
+            if ($prettyprintname == "" && isset($extinfo['names']['en'])) {
+                $prettyprintname = $extinfo['names']['en'];
+            }
+            if ($prettyprintname == "") {
+                foreach ($extinfo['names'] as $name) {
+                    $prettyprintname = $name;
+                }
+            }
+            // fill the rest of the text
+            $introtext = sprintf(_("a %s %s has invited you to manage the %s  \"%s\"."), CONFIG_CONFASSISTANT['CONSORTIUM']['display_name'], $uiElements->nomenclature_fed, $uiElements->nomenclature_inst, $prettyprintname) . " " . sprintf(_("This invitation is valid for 24 hours from now, i.e. until %s."), strftime("%x %X", time() + 86400));
+            // do the token creation magic
+            $newtoken = $mgmt->createToken(TRUE, $mailaddress, $prettyprintname, $newexternalid);
+            $loggerInstance->writeAudit($_SESSION['user'], "NEW", "IdP FUTURE  - Token created for " . $mailaddress);
+            break;
+        default: // includes OPERATION_MODE_INVALID
+            $wrongcontent = print_r($_POST, TRUE);
+            echo "<pre>Wrong parameters in POST:
 " . htmlspecialchars($wrongcontent) . "
 </pre>";
-        exit(1);
+            exit(1);
 }
 // are we on https?
 $proto = "http://";

core/UserAPI.php

Doc Comments +5 added lines, -1 removed lines

@@ -125,6 +125,7 @@ 
      * 
      * @param string $device
      * @param AbstractProfile $profile
+     * @param string $generatedFor
      * @return array info about the new installer (mime and link)
      */
     private function generateNewInstaller($device, $profile, $generatedFor, $token, $password) {
@@ -459,6 +460,10 @@ 
         readfile($file);
     }
 
+    /**
+     * @param string $destFile
+     * @param integer $resize
+     */
     private function processImage($inputImage, $destFile, $width, $height, $resize) {
         $info = new \finfo();
         $filetype = $info->buffer($inputImage, FILEINFO_MIME_TYPE);
@@ -485,7 +490,6 @@ 
      * When called for DiscoJuice, first check if file cache exists
      * If not then generate the file and save it in the cache
      * @param int $idp IdP identifier
-     * @param int $disco flag turning on image generation for DiscoJuice
      * @param int $width maximum width of the generated image 
      * @param int $height  maximum height of the generated image
      * if one of these is 0 then it is treated as no upper bound

core/DeviceConfig.php

Doc Comments +6 added lines

@@ -260,6 +260,9 @@ 
         return _("Sorry, this should not happen - no additional information is available");
     }
     
+    /**
+     * @param string $file
+     */
     private function findSourceFile($file) {
         if (is_file($this->module_path . '/Files/' . $this->device_id . '/' . $file)) {
             return $this->module_path . '/Files/' . $this->device_id . '/' . $file;
@@ -540,6 +543,9 @@ 
         'application/pdf' => 'pdf',
     ];
 
+    /**
+     * @param string $type
+     */
     private function saveLogoFile($logos,$type) {
         $iterator = 0;
         $returnarray = [];