GEANT / CAT

core/SanityTests.php

Doc Comments +3 added lines

@@ -138,6 +138,9 @@
         $this->test_result['global'] = max($this->test_result['global'],$level);
     }
 
+    /**
+     * @param string $s
+     */
     private function get_exec_path($s) {
         $the_path = "";
         $exec_is = "UNDEFINED";

core/User.php

Doc Comments +6 added lines, -2 removed lines

@@ -124,7 +124,7 @@ 
      * The function's single parameter $option_name is optional - if specified, it only returns the attributes of the given type.
      * Otherwise, all known attributes are returned.
      * 
-     * @param string $option_name name of the option whose values are to be returned
+     * @param integer $option_name name of the option whose values are to be returned
      * @return array of attributes
      */
     public function getAttributes($option_name = 0) {
@@ -194,7 +194,7 @@ 
      * user is a federation administrator of *any* federation. When given a parameter (ISO shortname of federation), it checks
      * if the user administers this particular federation.
      * 
-     * @param string $federation optional: federation to be checked
+     * @param integer $federation optional: federation to be checked
      * @return boolean TRUE if the user is federation admin, FALSE if not 
      */
     public function isFederationAdmin($federation = 0) {
@@ -226,6 +226,7 @@ 
    /**
     *  This function tests if the current user is an ovner of a given IdP
     *
+    * @param integer $idp
     * @return boolean TRUE if the user is an owner, FALSE if not 
     */
     public function isIdPOwner($idp) {
@@ -236,6 +237,9 @@ 
        return FALSE;
     }
 
+    /**
+     * @param string $content
+     */
     public function sendMailToUser($subject, $content) {
         // use PHPMailer to send the mail
         $mail = new PHPMailer();

core/UserAPI.php

Doc Comments -2 removed lines

@@ -260,7 +260,6 @@ 
 /**
  * Return the list of IdPs in a given country
  *
- * @param int $idp_id the IdP identifier
  * @return string JSON encoded data
  */
 
@@ -301,7 +300,6 @@ 
 /**
  * Return the list of IdPs in a given country ordered with respect to the user location
  *
- * @param int $idp_id the IdP identifier
  * @return string JSON encoded data
  */
 

core/UserManagement.php

Doc Comments +4 added lines, -5 removed lines

@@ -211,10 +211,9 @@ 
      * 
      * @param boolean $by_fedadmin is the invitation token created for a federation admin or from an existing inst admin
      * @param type $for identifier (typically email address) for which the invitation is created
-     * @param mixed $inst either an instance of the IdP class (for existing institutions to invite new admins) or a string (new institution - this is the inst name then)
-     * @param string $external_id if the IdP to be created is related to an external DB entity, this parameter contains that ID
-     * @param type $country if the institution is new (i.e. $inst is a string) this parameter needs to specify the federation of the new inst
-     * @return mixed The function returns either the token (as string) or FALSE if something went wrong
+     * @param integer $external_id if the IdP to be created is related to an external DB entity, this parameter contains that ID
+     * @param integer $country if the institution is new (i.e. $inst is a string) this parameter needs to specify the federation of the new inst
+     * @return string|false The function returns either the token (as string) or FALSE if something went wrong
      */
     public function createToken($by_fedadmin, $for, $inst_identifier, $external_id = 0, $country = 0) {
         $for = DBConnection::escape_value(UserManagement::$DB_TYPE, $for);
@@ -245,7 +244,7 @@ 
     /**
      * Retrieves all pending invitations for an institution or for a federation.
      * 
-     * @param type $idp_identifier the identifier of the institution. If not set, returns invitations for not-yet-created insts
+     * @param integer $idp_identifier the identifier of the institution. If not set, returns invitations for not-yet-created insts
      * @return if idp_identifier is set: an array of strings (mail addresses); otherwise an array of tuples (country;name;mail)
      */
     public function listPendingInvitations($idp_identifier = 0) {

core/X509.php

Doc Comments +2 added lines, -2 removed lines

@@ -28,7 +28,7 @@ 
 /** transform PEM formed certificate to DER format
  *
  *  @param mixed $pem_data blob of data, which is hopefully a PEM certificate
- *  @return the DER representation of the certificate
+ *  @return string DER representation of the certificate
  *
  *  @author http://php.net/manual/en/ref.openssl.php (comment from 29-Mar-2007)
  */
@@ -137,7 +137,7 @@ 
   * returns an array containing the PEM format of the certificate (s)
   * if the file contains multiple certificates it gets split into components
   *
-  * @param blob $cadata certificate in ether PEM or DER format
+  * @param string $cadata certificate in ether PEM or DER format
   * @return array
   */
 

devices/chromebook/chromebook.php

Doc Comments -3 removed lines

@@ -78,9 +78,6 @@
      * It is CRUTCIAL that the constructor sets $this->supportedEapMethods to an array of methods
      * available for the particular device.
      * {@source}
-     * @param string $device a pointer to a device module, which must
-     * be an index of one of the devices defined in the {@link Devices}
-     * array in {@link devices.php}.
      * @final not to be redefined
      */
     final public function __construct() {

devices/ms/Vista7.php

Doc Comments +3 added lines

@@ -350,6 +350,9 @@
 
 /**
  * produce PEAP and TLS configuration files for Vista and Windows 7
+ * @param string $auth
+ * @param string $encryption
+ * @param integer $i
  */
   private function writeWLANprofile($wlan_profile_name,$ssid,$auth,$encryption,$eap_config,$i) {
 $profile_file_contents = '<?xml version="1.0"?>

devices/ms/W8.php

Doc Comments +3 added lines

@@ -308,6 +308,9 @@
 
 /**
  * produce PEAP, TLS and TTLS configuration files for Windows 8
+ * @param string $auth
+ * @param string $encryption
+ * @param integer $i
  */
   private function writeWLANprofile($wlan_profile_name,$ssid,$auth,$encryption,$eap_config,$i) {
 $profile_file_contents = '<?xml version="1.0"?>

devices/ms/WindowsCommon.php

Doc Comments +3 added lines

@@ -21,6 +21,9 @@
   echo preg_replace('/"/','$\"',$in);
 }
 
+/**
+ * @return string
+ */
 function sprint_nsi($in) {
   return preg_replace('/"/','$\"',$in);
 }