Add missing phpdoc

Author: tvdijen

lib/Cas/CasException.php

@@ -12,6 +12,7 @@ class CasException extends \Exception
     const INVALID_TICKET = 'INVALID_TICKET';
     const INVALID_SERVICE = 'INVALID_SERVICE';
 
+    /** @var string */
     private $casCode;
 
     /**

lib/Cas/Protocol/SamlValidateResponder.php

@@ -52,6 +52,11 @@ public function convertToSaml(array $ticket)
         return $ret;
     }
 
+
+    /**
+     * @param string $samlResponse
+     * @return string
+     */
     public function wrapInSoap($samlResponse)
     {
         $envelope = <<<SOAP

lib/Cas/Ticket/TicketStore.php

@@ -42,11 +42,13 @@ abstract public function getTicket($ticketId);
 
     /**
      * @param array $ticket
+     * @return void
      */
     abstract public function addTicket(array $ticket);
 
     /**
      * @param string $ticketId
+     * @return void
      */
     abstract public function deleteTicket($ticketId);
 }

lib/Cas/TicketValidator.php

@@ -25,6 +25,7 @@ class TicketValidator
      */
     const INVALID_TICKET = 'INVALID_TICKET';
 
+
     /**
      * TicketValidator constructor.
      * @param Configuration $casconfig
@@ -43,6 +44,7 @@ public function __construct(Configuration $casconfig)
         $this->ticketFactory = new $ticketFactoryClass($casconfig);
     }
 
+
     /**
      * @param string $ticket the ticket id to load validate
      * @param string $service the service that the ticket was issued to
@@ -88,6 +90,11 @@ public function validateAndDeleteTicket($ticket, $service)
         return $serviceTicket;
     }
 
+
+    /**
+     * @param string $parameter
+     * @return string
+     */
     public static function sanitize($parameter)
     {
         return preg_replace(

tests/bootstrap.php

@@ -15,6 +15,7 @@
  * Sets a link in the simplesamlphp vendor directory
  * @param string $target
  * @param string $link
+ * @return void
  */
 function symlinkModulePathInVendorDirectory($target, $link)
 {

tests/lib/Cas/Protocol/SamlValidateTest.php

@@ -7,6 +7,9 @@
 
 class SamlValidateTest extends \PHPUnit\Framework\TestCase
 {
+    /**
+     * @return void
+     */
     public function testSamlValidatXmlGeneration()
     {
         $serviceUrl = 'http://jellyfish.greatvalleyu.com:7777/ssomanager/c/SSB';

tests/lib/TicketValidatorTest.php

@@ -28,6 +28,10 @@ class TicketValidatorTest extends TestCase
      */
     private $ticketStore;
 
+
+    /**
+     * @return void
+     */
     protected function setUp() : void
     {
         parent::setUp();
@@ -42,6 +46,9 @@ protected function setUp() : void
     }
 
 
+    /**
+     * @return void
+     */
     public function testNonExistantTicket()
     {
         $id = 'no-such-ticket';
@@ -55,6 +62,10 @@ public function testNonExistantTicket()
         }
     }
 
+
+    /**
+     * @return void
+     */
     public function testValidTicket()
     {
         $serviceUrl =  'http://efh.com?a=b&';
@@ -75,6 +86,10 @@ public function testValidTicket()
         }
     }
 
+
+    /**
+     * @return void
+     */
     public function testWrongServiceUrlTicket()
     {
         $serviceUrl =  'http://efh.com?a=b&';
@@ -95,6 +110,10 @@ public function testWrongServiceUrlTicket()
         $this->assertNull($this->ticketStore->getTicket($id), "ticket deleted after loading");
     }
 
+
+    /**
+     * @return void
+     */
     public function testExpiredTicket()
     {
         $serviceUrl =  'http://efh.com?a=b&';
@@ -112,6 +131,7 @@ public function testExpiredTicket()
         $this->assertNull($this->ticketStore->getTicket($id), "ticket deleted after loading");
     }
 
+
     /**
      * Create a ticket to use for testing
      * @param string $serviceUrl The service url for this ticket

tests/www/LoginIntegrationTest.php

@@ -43,6 +43,7 @@ class LoginIntegrationTest extends \PHPUnit\Framework\TestCase
      */
     protected $cookies_file;
 
+
     /**
      * The setup method that is run before any tests in this class.
      * @return void
@@ -56,6 +57,7 @@ protected function setup() : void
         $this->cookies_file = sys_get_temp_dir().'/'.$this->server_pid.'.cookies';
     }
 
+
     /**
      * The tear down method that is executed after all tests in this class.
      * Removes the lock file and cookies file
@@ -149,6 +151,7 @@ public function testValidServiceUrl()
         );
     }
 
+
     /**
      * Test outputting user info instead of redirecting
      * @return void
@@ -175,6 +178,7 @@ public function testDebugOutput()
         );
     }
 
+
     /**
      * Test outputting user info instead of redirecting
      * @return void
@@ -202,8 +206,10 @@ public function testDebugOutputSamlValidate()
         );
     }
 
+
     /**
      * Test outputting user info instead of redirecting
+     * @return void
      */
     public function testAlternateServiceConfigUsed()
     {
@@ -231,6 +237,7 @@ public function testAlternateServiceConfigUsed()
         );
     }
 
+
     /**
      * test a valid service URL with Post
      * @return void
@@ -285,6 +292,10 @@ public function testValidServiceUrlWithPost()
         );
     }
 
+
+    /**
+     * @return void
+     */
     public function testSamlValidate()
     {
         $service_url = 'http://host1.domain:1234/path1';
@@ -334,6 +345,7 @@ public function testSamlValidate()
         $this->assertStringContainsString('[email protected]</NameIdentifier>', $resp['body']);
     }
 
+
     /**
      * Sets up an authenticated session for the cookie $jar
      * @return void
@@ -354,6 +366,7 @@ private function authenticate()
         $this->assertEquals(200, $resp['code'], $resp['body']);
     }
 
+
     /**
      * TODO: migrate into BuiltInServer
      * @param resource $ch
@@ -382,6 +395,7 @@ private function execAndHandleCurlResponse($ch)
         ];
     }
 
+
     /**
      * TODO: migrate into BuiltInServer
      * @param string $query The path at the embedded server to query