GEANT / CAT

core/CAT.php

Doc Comments +1 added lines, -1 removed lines

@@ -230,7 +230,7 @@
      * @param string $user persistent identifier of the user who triggered the action
      * @param string $category type of modification, from the fixed vocabulary: "NEW", "OWN", "MOD", "DEL"
      * @param string $message message to log into the audit log
-     * @return boolean TRUE if successful. Will terminate script execution on failure. 
+     * @return boolean|null TRUE if successful. Will terminate script execution on failure. 
      */
     public static function writeAudit($user, $category, $message) {
         switch ($category) {

core/DBConnection.php

Doc Comments +4 added lines

@@ -87,6 +87,7 @@ 
     /**
      * executes a query and triggers logging to the SQL audit log if it's not a SELECT
      * @param string $querystring the query to be executed
+     * @param string $db
      * @return mixed the query result as mysqli_result object; or TRUE on non-return-value statements
      */
     public static function exec($db, $querystring) {
@@ -134,6 +135,8 @@ 
     /**
      * Checks if a raw data pointer is public data (return value FALSE) or if 
      * yes who the authorised admins to view it are (return array of user IDs)
+     * @param string $table
+     * @param string $row
      */
     public static function isDataRestricted($table, $row) {
         if ($table != "institution_option" && $table != "profile_option" && $table != "federation_option")
@@ -175,6 +178,7 @@ 
 
     /**
      * Retrieves the last auto-id of an INSERT. Needs to be called immediately after the corresponding exec() call
+     * @param string $db
      * @return int the last autoincrement-ID
      */
     public static function lastID($db) {

core/DeviceConfig.php

Doc Comments +2 added lines, -5 removed lines

@@ -172,7 +172,7 @@ 
     * named the same as device_id. The second option takes precedence.
     *
     * @param string $source_name The source file name
-    * @param string $output_name The destination file name
+    * @param integer $output_name The destination file name
     *
     * @return bool result of the copy operation
     * @final not to be redefined
@@ -216,8 +216,7 @@ 
     * named the same as device_id. The second option takes precedence.
     *
     * @param string $source_name The source file name
-    * @param string $output_name The destination file name
-    * @param int $use_win_cp Set Windows charset if non-zero
+    * @param integer $output_name The destination file name
     *
     * @final not to be redefined
     */
@@ -262,8 +261,6 @@ 
     * The second optional parameter, if nonzero, should be the character set understood by iconv
     * This is required by the Windows installer and is expected to go away in the future.
     *
-    * @param string $source_name The source file name
-    * @param int $use_win_cp Set Windows charset if non-zero
     *
     * @final not to be redefined
     */

core/Federation.php

Doc Comments +1 added lines, -1 removed lines

@@ -661,7 +661,7 @@
      * This function retrieves the federation attributes. If called with the optional parameter, only attribute values for the attribute
      * name in $option_name are retrieved; otherwise, all attributes are retrieved.
      *
-     * @param string $option_name optionally, the name of the attribute that is to be retrieved
+     * @param integer $option_name optionally, the name of the attribute that is to be retrieved
      * @return array of arrays of attributes which were set for this IdP
      */
     public function getAttributes($option_name = 0) {

core/Helper.php

Doc Comments +2 added lines, -1 removed lines

@@ -32,6 +32,7 @@ 
 /**
  * write debug messages to the log
  *
+ * @param integer $level
  */
 function debug($level, $t) {
     if (Config::$DEBUG_LEVEL >= $level) {
@@ -130,7 +131,7 @@ 
  * generates a UUID
  *
  * @param string $prefix an extra prefix to set before the UUID
- * @return UUID (possibly prefixed)
+ * @return string (possibly prefixed)
  */
 function uuid($prefix = '', $deterministic_source = NULL) {
     if ($deterministic_source === NULL) 

core/IdP.php

Doc Comments +3 added lines, -2 removed lines

@@ -68,6 +68,7 @@ 
      * Cannot be used to define a new IdP in the database! This happens via Federation::newIdP()
      *
      * @param integer $i_id the database row identifier
+     * @return string
      */
     public function __construct($i_id) {
         debug(3, "--- BEGIN Constructing new IdP object ... ---\n");
@@ -247,7 +248,7 @@ 
      * This function retrieves the IdP-wide attributes. If called with the optional parameter, only attribute values for the attribute
      * name in $option_name are retrieved; otherwise, all attributes are retrieved.
      *
-     * @param string $option_name optionally, the name of the attribute that is to be retrieved
+     * @param integer $option_name optionally, the name of the attribute that is to be retrieved
      * @return array of arrays of attributes which were set for this IdP
      */
     public function getAttributes($option_name = 0) {
@@ -318,7 +319,7 @@ 
      * Adds a new profile to this IdP.
      * Only creates the DB entry for the Profile. If you want to add attributes later, see Profile::addAttribute().
      *
-     * @return object new Profile object if successful, or FALSE if an error occured
+     * @return Profile|null new Profile object if successful, or FALSE if an error occured
      */
     public function newProfile() {
         DBConnection::exec(IdP::$DB_TYPE, "INSERT INTO profile (inst_id) VALUES($this->identifier)");

core/Options.php

Doc Comments +1 added lines, -1 removed lines

@@ -94,7 +94,7 @@
      * 
      * @assert ("user") == Array("user:email","user:fedadmin","user:realname")
      * 
-     * @param string $class_name optionally specifies the class of options to be listed (class is the part of the option name before the : sign)
+     * @param integer $class_name optionally specifies the class of options to be listed (class is the part of the option name before the : sign)
      * @return array of options
      */
     public function availableOptions($class_name = 0) {

core/phpqrcode.php

Doc Comments +108 added lines

@@ -96,6 +96,10 @@ 
 	define('QR_FORMAT_PNG',  1);

 	

 	class qrstr {

+
+		/**
+		 * @param string $repl
+		 */
 		public static function set(&$srctab, $x, $y, $repl, $replLen = false) {

 			$srctab[$y] = substr_replace($srctab[$y], ($replLen !== false)?substr($repl,0,$replLen):$repl, $x, ($replLen !== false)?$replLen:strlen($repl));

 		}

@@ -231,6 +235,11 @@ 
         }

 

         //----------------------------------------------------------------------

+
+        /**
+         * @param boolean $outfile
+         * @param string $err
+         */
         public static function log($outfile, $err)

         {

             if (QR_LOG_DIR !== false) {

@@ -256,6 +265,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $markerId
+         */
         public static function markTime($markerId)

         {

             list($usec, $sec) = explode(" ", microtime());

@@ -410,18 +423,30 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public static function getWidth($version)

         {

             return self::$capacity[$version][QRCAP_WIDTH];

         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public static function getRemainder($version)

         {

             return self::$capacity[$version][QRCAP_REMINDER];

         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $size
+         */
         public static function getMinimumVersion($size, $level)

         {

 

@@ -535,6 +560,9 @@ 
         //----------------------------------------------------------------------

         // CACHEABLE!!!

         

+        /**
+         * @param integer $version
+         */
         public static function getEccSpec($version, $level, array &$spec)

         {

             if (count($spec) < 5) {

@@ -857,12 +885,20 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $code
+         */
         public static function unserial($code)

         {

             return explode("\n", gzuncompress($code));

         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public static function newFrame($version)

         {

             if($version < 1 || $version > QRSPEC_VERSION_MAX) 

@@ -1236,6 +1272,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public function encodeBitStream($version)

         {

             try {

@@ -1313,6 +1353,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public function setVersion($version)

         {

             if($version < 0 || $version > QRSPEC_VERSION_MAX) {

@@ -1351,6 +1395,12 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param QRinput $mode
+         * @param integer $size
+         * @param integer $data
+         */
         public function append($mode, $size, $data)

         {

             try {

@@ -1446,6 +1496,10 @@ 
         ];

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $c
+         */
         public static function lookAnTable($c)

         {

             return (($c > 127)?-1:self::$anTable[$c]);

@@ -1531,6 +1585,10 @@ 
         

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         */
         public function estimateBitStreamSize($version)

         {

             $bits = 0;

@@ -1648,6 +1706,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param QRbitstream $bstream
+         */
         public function appendPaddingBit(&$bstream)

         {

             $bits = $bstream->size();

@@ -1977,6 +2039,10 @@ 
         public $modeHint;

 

         //----------------------------------------------------------------------

+
+        /**
+         * @param QRinput $input
+         */
         public function __construct($dataStr, $input, $modeHint) 

         {

             $this->dataStr  = $dataStr;

@@ -1985,6 +2051,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $str
+         */
         public static function isdigitat($str, $pos)

         {    

             if ($pos >= strlen($str))

@@ -1994,6 +2064,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $str
+         */
         public static function isalnumat($str, $pos)

         {

             if ($pos >= strlen($str))

@@ -2114,6 +2188,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @return integer
+         */
         public function eatKanji()

         {

             $p = 0;

@@ -2447,6 +2525,13 @@ 
         public static $items = [];

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $symsize
+         * @param integer $gfpoly
+         * @param integer $fcr
+         * @param integer $prim
+         */
         public static function init_rs($symsize, $gfpoly, $fcr, $prim, $nroots, $pad)

         {

             foreach(self::$items as $rs) {

@@ -2601,6 +2686,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param string $code
+         */
         public static function unserial($code)

         {

             $codeArr = [];

@@ -2661,6 +2750,10 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $length
+         */
         public function calcN1N3($length)

         {

             $demerit = 0;

@@ -2971,6 +3064,10 @@ 
         public $data; 

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $mask
+         */
         public function encodeMask(QRinput $input, $mask)

         {

             if($input->getVersion() < 0 || $input->getVersion() > QRSPEC_VERSION_MAX) {

@@ -3052,6 +3149,11 @@ 
         }

         

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         * @param integer $level
+         */
         public function encodeString8bit($string, $version, $level)

         {

             if(string == NULL) {

@@ -3071,6 +3173,12 @@ 
         }

 

         //----------------------------------------------------------------------

+
+        /**
+         * @param integer $version
+         * @param integer $level
+         * @param boolean $casesensitive
+         */
         public function encodeString($string, $version, $level, $hint, $casesensitive)

         {

 

core/Profile.php

Doc Comments +11 added lines, -9 removed lines

@@ -73,7 +73,7 @@ 
      * supported EAP types from the DB and stores them in the priv_ arrays.
      * 
      * @param int $p_id identifier of the profile in the DB
-     * @param IdP $idp_object optionally, the institution to which this Profile belongs. Saves the construction of the IdP instance. If omitted, an extra query and instantiation is executed to find out.
+     * @param integer $idp_object optionally, the institution to which this Profile belongs. Saves the construction of the IdP instance. If omitted, an extra query and instantiation is executed to find out.
      */
     public function __construct($p_id, $idp_object = 0) {
         debug(3, "--- BEGIN Constructing new Profile object ... ---\n");
@@ -372,6 +372,8 @@ 
      * 
      * @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
      */
     public function updateCache($device, $path,$mime) {
         $device = DBConnection::escape_value(Profile::$DB_TYPE, $device);
@@ -384,9 +386,9 @@ 
     /**
      * Log a new download for our stats
      * 
-     * @param device the device id string
-     * @param area either admin or user
-     * @return TRUE if incrementing worked, FALSE if not
+     * @param device string device id string
+     * @param area string admin or user
+     * @return boolean if incrementing worked, FALSE if not
      */
     public function incrementDownloadStats($device, $area) {
         $device = DBConnection::escape_value(Profile::$DB_TYPE, $device);
@@ -399,7 +401,7 @@ 
 
     /**
      * Retrieve current download stats from database, either for one specific device or for all devices
-     * @param string $device the device id string
+     * @param integer $device the device id string
      * @return mixed user downloads of this profile; if device is given, returns the counter as int, otherwise an array with devicename => counter
      */
     public function getUserDownloadStats($device = 0) {
@@ -464,7 +466,7 @@ 
      * @param string $attr_name name of the attribute to set
      * @param string $attr_value value of the attribute to set
      * @param int $eap_type identifier of the EAP type in the database. 0 if the attribute is valid for all EAP types.
-     * @param string $device identifier of the device in the databse. Omit the argument if attribute is valid for all devices.
+     * @param integer $device identifier of the device in the databse. Omit the argument if attribute is valid for all devices.
      */
     public function addAttribute($attr_name, $attr_value, $eap_type, $device = 0) {
         $attr_name = DBConnection::escape_value(Profile::$DB_TYPE, $attr_name);
@@ -574,7 +576,7 @@ 
     /** Returns an array of the profile's attributes.
      * 
      * @param string option_name the name of a specific option. If set, only returns option values for this option name
-     * @param eapmethod the EAP type, in array ("OUTER/INNER") notation. If set, returns only attributes which are specific to that EAP type
+     * @param eapmethod integer EAP type, in array ("OUTER/INNER") notation. If set, returns only attributes which are specific to that EAP type
      * @param string device the device ID string. If set, returns only attributes which are specific to that device
      * @return array attributes of the profile
      */
@@ -658,7 +660,7 @@ 
     /**
      * list all devices marking their availabiblity and possible redirects
      *
-     * @param string $locale for text-based attributes, either returns values for the default value, or if specified here, in the locale specified
+     * @param integer $locale for text-based attributes, either returns values for the default value, or if specified here, in the locale specified
      * @return array of device ids display names and their status
      */
     public function listDevices($locale = 0) {
@@ -713,7 +715,7 @@ 
      * as wel as the chosen language.
      * can be called with an optional $eap argument
      * 
-     * @param array $eap if specified, retrieves attributes specific to the given EAP type
+     * @param integer $eap if specified, retrieves attributes specific to the given EAP type
      * @return array list of attributes in collapsed style (index is the attrib name, value is an array of different values)
      */
     public function getCollapsedAttributes($eap = 0) {