GEANT / CAT

core/Profile.php

Doc Comments +11 added lines, -9 removed lines

@@ -59,7 +59,7 @@ 
      * supported EAP types from the DB and stores them in the priv_ arrays.
      * 
      * @param int $profileId identifier of the profile in the DB
-     * @param IdP $idpObject 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 $idpObject 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($profileId, $idpObject = 0) {
         debug(3, "--- BEGIN Constructing new Profile object ... ---\n");
@@ -293,6 +293,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) {
         $escapedDevice = DBConnection::escape_value($this->databaseType, $device);
@@ -305,9 +307,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) {
         $escapedDevice = DBConnection::escape_value($this->databaseType, $device);
@@ -320,7 +322,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) {
@@ -353,7 +355,7 @@ 
      * @param string $attrName name of the attribute to set
      * @param string $attrValue value of the attribute to set
      * @param int $eapType 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($attrName, $attrValue, $eapType, $device = 0) {
         $escapedAttrName = DBConnection::escape_value($this->databaseType, $attrName);
@@ -463,7 +465,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
      */
@@ -557,7 +559,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) {
@@ -613,7 +615,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) {

Indentation +8 added lines, -8 removed lines

@@ -134,14 +134,14 @@
         $localValueIfAny = (preg_match('/@/', $this->realm) ? substr($this->realm, 0, strpos($this->realm, '@')) : "anonymous" );
         
         $internalAttributes = [
-          "internal:profile_count" => $idp->profileCount(),
-          "internal:checkuser_outer" => $this->checkuser_outer,
-          "internal:checkuser_value" => $this->checkuser_value,
-          "internal:verify_userinput_suffix" => $this->verify,
-          "internal:hint_userinput_suffix" => $this->hint,
-          "internal:realm" => preg_replace('/^.*@/', '', $this->realm),
-          "internal:use_anon_outer" => $this->use_anon_outer,
-          "internal:anon_local_value" => $localValueIfAny,
+            "internal:profile_count" => $idp->profileCount(),
+            "internal:checkuser_outer" => $this->checkuser_outer,
+            "internal:checkuser_value" => $this->checkuser_value,
+            "internal:verify_userinput_suffix" => $this->verify,
+            "internal:hint_userinput_suffix" => $this->hint,
+            "internal:realm" => preg_replace('/^.*@/', '', $this->realm),
+            "internal:use_anon_outer" => $this->use_anon_outer,
+            "internal:anon_local_value" => $localValueIfAny,
         ];
 
         foreach ($internalAttributes as $attName => $attValue) {

Spacing +6 added lines, -6 removed lines

@@ -110,7 +110,7 @@ 
                 $temparray[] = [
                     "name" => $attributeQuery->option_name,
                     "value" => $attributeQuery->option_value,
-                    "level" => ($attributeQuery->device_id == NULL && $attributeQuery->method == 0 ? "Profile" : "Method" ),
+                    "level" => ($attributeQuery->device_id == NULL && $attributeQuery->method == 0 ? "Profile" : "Method"),
                     "row" => $attributeQuery->row,
                     "device" => $attributeQuery->device_id,
                     "flag" => $optinfo['flag'],
@@ -120,8 +120,8 @@ 
 
                 $temparray[] = [
                     "name" => $attributeQuery->option_name,
-                    "value" => ( $decodedAttribute['lang'] == "" ? $decodedAttribute['content'] : serialize($decodedAttribute)),
-                    "level" => ($attributeQuery->device_id == NULL && $attributeQuery->method == 0 ? "Profile" : "Method" ),
+                    "value" => ($decodedAttribute['lang'] == "" ? $decodedAttribute['content'] : serialize($decodedAttribute)),
+                    "level" => ($attributeQuery->device_id == NULL && $attributeQuery->method == 0 ? "Profile" : "Method"),
                     "row" => $attributeQuery->row,
                     "flag" => $optinfo['flag'],
                     "device" => $attributeQuery->device_id,
@@ -131,7 +131,7 @@ 
         // add internal attributes
         // they share many attribute properties, so condense the generation
         
-        $localValueIfAny = (preg_match('/@/', $this->realm) ? substr($this->realm, 0, strpos($this->realm, '@')) : "anonymous" );
+        $localValueIfAny = (preg_match('/@/', $this->realm) ? substr($this->realm, 0, strpos($this->realm, '@')) : "anonymous");
         
         $internalAttributes = [
           "internal:profile_count" => $idp->profileCount(),
@@ -360,7 +360,7 @@ 
         $escapedAttrValue = DBConnection::escape_value($this->databaseType, $attrValue);
 
         DBConnection::exec($this->databaseType, "INSERT INTO $this->entityOptionTable ($this->entityIdColumn, option_name, option_value, eap_method_id" . ($device !== 0 ? ",device_id" : "") . ") 
-                          VALUES(" . $this->identifier . ", '$escapedAttrName', '$escapedAttrValue', $eapType" . ($device !== 0 ? ",'" . DBConnection::escape_value($this->databaseType, $device) . "'" : "" ) . ")");
+                          VALUES(" . $this->identifier . ", '$escapedAttrName', '$escapedAttrValue', $eapType" . ($device !== 0 ? ",'" . DBConnection::escape_value($this->databaseType, $device) . "'" : "") . ")");
         $this->updateFreshness();
     }
 
@@ -415,7 +415,7 @@ 
      */
     public function setRealmCheckUser($shallwe, $localpart = NULL) {
         DBConnection::exec($this->databaseType, "UPDATE profile SET checkuser_outer = " . ($shallwe == true ? "1" : "0") .
-                ( $localpart !== NULL ? ", checkuser_value = '$localpart' " : "") .
+                ($localpart !== NULL ? ", checkuser_value = '$localpart' " : "") .
                 " WHERE profile_id = $this->identifier");
     }