add comments && update annotations

Author: leo108

src/Contracts/Interactions/UserLogin.php

@@ -15,24 +15,32 @@
 interface UserLogin
 {
     /**
+     * Retrive user from credential in request
+     *
      * @param Request $request
-     * @return UserModel
+     * @return UserModel|null
      */
     public function login(Request $request);
 
     /**
+     * Get current logged in user
+     *
      * @param Request $request
      * @return UserModel|null
      */
     public function getCurrentUser(Request $request);
 
     /**
+     * Show failed message when authenticate failed
+     *
      * @param Request $request
      * @return Response
      */
     public function showAuthenticateFailed(Request $request);
 
     /**
+     * Show login page with warning message
+     *
      * @param Request $request
      * @param string  $jumpUrl
      * @param string  $service
@@ -41,25 +49,32 @@ public function showAuthenticateFailed(Request $request);
     public function showLoginWarnPage(Request $request, $jumpUrl, $service);
 
     /**
+     * Show login page
+     *
      * @param Request $request
      * @param array   $errors
      * @return Response
      */
     public function showLoginPage(Request $request, array $errors = []);
 
     /**
+     * Redirect to home page
+     *
      * @param array $errors
      * @return Response
      */
     public function redirectToHome(array $errors = []);
 
     /**
+     * Execute logout logic (clear session / cookie etc)
+     *
      * @param Request $request
      * @return void
      */
     public function logout(Request $request);
 
     /**
+     *
      * @param Request $request
      * @return Response
      */

src/Contracts/Models/UserModel.php

@@ -13,11 +13,15 @@
 interface UserModel
 {
     /**
+     * Get user's name (should be unique in whole cas system)
+     *
      * @return string
      */
     public function getName();
 
     /**
+     * Get user's attributes
+     *
      * @return array
      */
     public function getCASAttributes();

src/Contracts/Responses/ProxyFailureResponse.php

@@ -8,7 +8,6 @@
 
 namespace Leo108\CAS\Contracts\Responses;
 
-
 interface ProxyFailureResponse extends BaseResponse
 {
     /**

src/Contracts/TicketLocker.php

@@ -8,7 +8,6 @@
 
 namespace Leo108\CAS\Contracts;
 
-
 interface TicketLocker
 {
     /**

src/Models/PGTicket.php

@@ -25,6 +25,7 @@
  * @property Carbon    $created_at
  * @property Carbon    $expire_at
  * @property UserModel $user
+ * @property Service   $service
  */
 class PGTicket extends Model
 {

src/Models/ServiceHost.php

@@ -10,6 +10,13 @@
 
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * Class ServiceHost
+ * @package Leo108\CAS\Models
+ *
+ * @property integer $service_id
+ * @property Service $service
+ */
 class ServiceHost extends Model
 {
     protected $table = 'cas_service_hosts';

src/Models/Ticket.php

@@ -25,6 +25,7 @@
  * @property Carbon    $created_at
  * @property Carbon    $expire_at
  * @property UserModel $user
+ * @property Service   $service
  */
 class Ticket extends Model
 {

src/Repositories/TicketRepository.php

@@ -49,7 +49,7 @@ public function __construct(Ticket $ticket, ServiceRepository $serviceRepository
      * @param string    $serviceUrl
      * @param array     $proxies
      * @throws CasException
-     * @return \Leo108\CAS\Models\Ticket
+     * @return Ticket
      */
     public function applyTicket(UserModel $user, $serviceUrl, $proxies = [])
     {
@@ -117,4 +117,4 @@ function ($ticket) {
             10
         );
     }
-}
+}

src/Responses/BaseXmlResponse.php

@@ -93,4 +93,4 @@ public function toResponse()
 
         return new Response($content, 200, ['Content-Type' => 'application/xml']);
     }
-}
+}