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){

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);

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 = [];

core/AbstractProfile.php

Doc Comments +10 added lines, -1 removed lines

@@ -96,6 +96,12 @@ 
      */
     protected $frontendHandle;
 
+    /**
+     * @param integer $idpIdentifier
+     * @param string $deviceId
+     * @param string $area
+     * @param string $lang
+     */
     protected function saveDownloadDetails($idpIdentifier, $profileId, $deviceId, $area, $lang, $eapType) {
         if (CONFIG['PATHS']['logdir']) {
             $f = fopen(CONFIG['PATHS']['logdir'] . "/download_details.log", "a");
@@ -285,6 +291,9 @@ 
      * 
      * @param string device the device identifier string
      * @param string path the path where the new installer can be found
+     * @param string $device
+     * @param string $path
+     * @param integer $integerEapType
      */
     abstract public function updateCache($device, $path, $mime, $integerEapType);
 
@@ -600,7 +609,7 @@ 
      * it? Silverbullet will always return TRUE; RADIUS profiles need to do some
      * heavy lifting here.
      * 
-     * * @return boolean TRUE if enough info is set to enable installers
+     * * @return integer TRUE if enough info is set to enable installers
      */
     public function readinessLevel() {
         $result = $this->databaseHandle->exec("SELECT sufficient_config, showtime FROM profile WHERE profile_id = ?", "i", $this->identifier);

web/lib/admin/OptionDisplay.php

Doc Comments +1 added lines, -1 removed lines

@@ -205,7 +205,7 @@
      * @param int $rowid the HTML field base name of the option to be displayed
      * @param string $optionName the name of the option to display
      * @param string $optionValue the value of the option to display
-     * @param mixed $optionLang the language of the option to display
+     * @param null|string $optionLang the language of the option to display
      * @return string HTML code
      * @throws Exception
      */