cilogon / service-lib

src/Service/Content.php

Doc Comments +5 added lines, -2 removed lines

@@ -1105,6 +1105,7 @@ 
      * @param string $class (Optionals) A CSS class for the icon. Will be
      *        appended after the 'helpcursor' class. Defaults to empty
      *        string.
+     * @param string $icon
      */
     public static function printIcon($icon, $popuptext = '', $class = '')
     {
@@ -1225,6 +1226,7 @@ 
      *        the authnContextClassRef? If not, then ignore the 'Request
      *        Silver' checkbox and silver certification in metadata.
      *        Defaults to true.
+     * @param string $responseurl
      */
     public static function redirectToGetShibUser(
         $providerId = '',
@@ -2272,7 +2274,7 @@ 
      *        following: 'pkcs12', 'gsca', or 'delegate'.
      * @param int $defaultmaxlifetime Default maxlifetime (in hours) for the
      *        credential.
-     * @return array An array consisting of two entries: the minimum and
+     * @return integer[] An array consisting of two entries: the minimum and
      *         maximum lifetimes (in hours) for a credential.
      */
     public static function getMinMaxLifetimes($section, $defaultmaxlifetime)
@@ -2343,7 +2345,7 @@ 
      * IdPs based on the skin's whitelist/blacklist and the global
      * blacklist file. For the TestIdP page, the list is all InCommon IdPs.
      *
-     * @param bool $incommon idps (Optional) Show all InCommon IdPs in
+     * @param bool $incommonidps idps (Optional) Show all InCommon IdPs in
      *        selection list? Defaults to false, which means show only
      *        whitelisted IdPs.
      */
@@ -2420,6 +2422,7 @@ 
      * @param string $clientparams
      * @param string $redirect
      * @param string $redirectform (Optional)
+     * @param string $lastname
      */
     public static function printAttributeReleaseErrorMessage(
         $ePPN,

Unused Use Statements +5 added lines, -5 removed lines

@@ -2,13 +2,13 @@
 
 namespace CILogon\Service;
 
-use CILogon\Service\Util;
-use CILogon\Service\TwoFactor;
-use CILogon\Service\MyProxy;
-use CILogon\Service\PortalCookie;
 use CILogon\Service\DBService;
-use CILogon\Service\OAuth2Provider;
 use CILogon\Service\Loggit;
+use CILogon\Service\MyProxy;
+use CILogon\Service\OAuth2Provider;
+use CILogon\Service\PortalCookie;
+use CILogon\Service\TwoFactor;
+use CILogon\Service\Util;
 use Net_LDAP2_Util;
 
 // If needed, set the 'Notification' banner text to a non-empty value

src/Service/CSRF.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace CILogon\Service;
 
-use CILogon\Service\Util;
 use CILogon\Service\Loggit;
+use CILogon\Service\Util;
 
 /**
  * CSRF

src/Service/DBProps.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -3,8 +3,8 @@
 namespace CILogon\Service;
 
 use CILogon\Service\Util;
-use PEAR;
 use DB;
+use PEAR;
 
 /**
  * DBProps

src/Service/DBService.php

Doc Comments -6 removed lines

@@ -383,12 +383,6 @@
      * appropriately.  If the servlet returns correctly (i.e. an HTTP
      * status code of 200), this method returns true.
      *
-     * @param string $params,... Variable number of parameters: 1, or more.
-     *        For 1 parameter : $uid (database user identifier)
-     *        For more than 1 parameter, parameters can include:
-     *            $remote_user, $idp, $idp_display_name,
-     *            $first_name, $last_name, $display_name, $email,
-     *            $eppn, $eptid, $openid, $oidc, $affiliation, $ou
      *
      * @return bool True if the servlet returned correctly. Else false.
      */

src/Service/IdpList.php

Doc Comments +3 added lines, -3 removed lines

@@ -158,7 +158,7 @@ 
      *
      * @param string $filetype (Optional) Type type of file to read, either
      *        'xml' or 'json'. Defaults to 'json'.
-     * @return bool True if the idplist was read from file. False otherwise.
+     * @return boolean|null True if the idplist was read from file. False otherwise.
      */
     public function read($filetype = 'json')
     {
@@ -236,7 +236,7 @@ 
      *
      * @param string $filetype (Optional) Type type of file to write, either
      *        'xml' or 'json'. Defaults to 'json'.
-     * @return bool True if the idplist was written to file. False
+     * @return boolean|null True if the idplist was written to file. False
      *         otherwise.
      */
     public function write($filetype = 'json')
@@ -325,7 +325,7 @@ 
      * the internal idparray at the same time as the idpdom.
      *
      * @param DOMDocument $dom A DOMDocument object
-     * @param DOMElement $idpnode A pointer to a parent <idp> DOMElement
+     * @param \DOMElement $idpnode A pointer to a parent <idp> DOMElement
      * @param string $nodename The name of the new child node DOMElement
      * @param string $nodevalue The value of the new child node DOMElement
      */

Unused Use Statements +1 added lines, -1 removed lines

@@ -5,8 +5,8 @@
 use CILogon\Service\Util;
 use DOMDocument;
 use DOMImplementation;
-use XSLTProcessor;
 use SimpleXMLElement;
+use XSLTProcessor;
 
 /**
  * IdpList

src/Service/ShibError.php

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,9 +2,9 @@
 
 namespace CILogon\Service;
 
-use CILogon\Service\Util;
 use CILogon\Service\Content;
 use CILogon\Service\Loggit;
+use CILogon\Service\Util;
 
 /**
  * ShibError

src/Service/TwoFactor.php

Doc Comments +1 added lines

@@ -159,6 +159,7 @@
      * @param string $key The secret registration key to set for the
      *        two-factor type. Empty string implies unregister
      *        the $tftype.
+     * @param string $tftype
      */
     public static function setRegister($tftype, $key)
     {

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,9 +2,9 @@
 
 namespace CILogon\Service;
 
-use CILogon\Service\Util;
 use CILogon\Service\Content;
 use CILogon\Service\DuoConfig;
+use CILogon\Service\Util;
 use Duo\Web;
 use Endroid\QrCode\QrCode;
 use PHPGangsta_GoogleAuthenticator;

src/Service/Util.php

Doc Comments +1 added lines, -1 removed lines

@@ -100,7 +100,7 @@
      * $skin to be used by other classes (since loading the skin is
      * potentially expensive).
      *
-     * @return The class instantiated Skin object.
+     * @return Skin class instantiated Skin object.
      */
     public static function getSkin()
     {

Unused Use Statements +4 added lines, -4 removed lines

@@ -3,15 +3,15 @@
 namespace CILogon\Service;
 
 use CILogon\Service\CSRF;
-use CILogon\Service\Loggit;
-use CILogon\Service\IdpList;
 use CILogon\Service\DBService;
+use CILogon\Service\IdpList;
+use CILogon\Service\Loggit;
+use CILogon\Service\PortalCookie;
 use CILogon\Service\SessionMgr;
 use CILogon\Service\Skin;
 use CILogon\Service\TimeIt;
-use CILogon\Service\PortalCookie;
-use PEAR;
 use Config;
+use PEAR;
 
 // Full path to the php.ini-style config file for the CILogon Service
 define('CILOGON_INI_FILE', '/var/www/config/cilogon.ini');