Fix internal doc and type hinting (Ref #711)

Author: lcharette

app/sprinkles/core/src/Alert/CacheAlertStream.php

@@ -7,41 +7,50 @@
  */
 namespace UserFrosting\Sprinkle\Core\Alert;
 
+use Illuminate\Cache\TaggedCache;
+use UserFrosting\I18n\MessageTranslator;
+use UserFrosting\Support\Repository\Repository;
+
 /**
- * CacheAlertStream Class
- *
- * Implements a message stream for use between HTTP requests, with i18n support via the MessageTranslator class
- * Using the cache system to store the alerts. Note that the tags are added each time instead of the constructor
- * since the session_id can change when the user logs in or out
+ *    CacheAlertStream Class
+ *    Implements a message stream for use between HTTP requests, with i18n
+ *    support via the MessageTranslator class using the cache system to store
+ *    the alerts. Note that the tags are added each time instead of the
+ *    constructor since the session_id can change when the user logs in or out
  *
- * @author Louis Charette
+ *    @author Louis Charette
  */
 class CacheAlertStream extends AlertStream
 {
     /**
-     * @var Illuminate\\Cache\\*Store Object We use the cache object so that added messages will automatically appear in the cache.
+     *    @var TaggedCache Object We use the cache object so that added messages will automatically appear in the cache.
      */
     protected $cache;
 
     /**
-     * @var Illuminate\\Cache\\*Store Object We use the cache object so that added messages will automatically appear in the cache.
+     *    @var Repository Object We use the cache object so that added messages will automatically appear in the cache.
      */
     protected $config;
 
     /**
-     * Create a new message stream.
+     *    Create a new message stream.
+     *
+     *    @param string $messagesKey Store the messages under this key
+     *    @param MessageTranslator|null $translator
+     *    @param TaggedCache $cache
+     *    @param Repository $config
      */
-    public function __construct($messagesKey, $translator = null, $cache, $config)
+    public function __construct($messagesKey, MessageTranslator $translator = null, TaggedCache $cache, Repository $config)
     {
         $this->cache = $cache;
         $this->config = $config;
         parent::__construct($messagesKey, $translator);
     }
 
     /**
-     * Get the messages from this message stream.
+     *    Get the messages from this message stream.
      *
-     * @return array An array of messages, each of which is itself an array containing "type" and "message" fields.
+     *    @return array An array of messages, each of which is itself an array containing "type" and "message" fields.
      */
     public function messages()
     {
@@ -53,15 +62,20 @@ public function messages()
     }
 
     /**
-     * Clear all messages from this message stream.
+     *    Clear all messages from this message stream.
+     *
+     *    @return void
      */
     public function resetMessageStream()
     {
         $this->cache->tags([$this->config['cache.prefix'], "_s".session_id()])->forget($this->messagesKey);
     }
 
     /**
-     * Save messages to the stream
+     *    Save messages to the stream
+     *
+     *    @param  string $messages The message
+     *    @return void
      */
     protected function saveMessages($messages)
     {

app/sprinkles/core/src/Alert/SessionAlertStream.php

@@ -7,50 +7,61 @@
  */
 namespace UserFrosting\Sprinkle\Core\Alert;
 
+use UserFrosting\I18n\MessageTranslator;
+use UserFrosting\Session\Session;
+
 /**
- * SessionAlertStream Class
- *
- * Implements a message stream for use between HTTP requests, with i18n support via the MessageTranslator class
- * Using the session storage to store the alerts
+ *    SessionAlertStream Class
+ *    Implements a message stream for use between HTTP requests, with i18n support via the MessageTranslator class
+ *    Using the session storage to store the alerts
  *
- * @author Alex Weissman (https://alexanderweissman.com)
+ *    @author Alex Weissman (https://alexanderweissman.com)
  */
 class SessionAlertStream extends AlertStream
 {
     /**
-     * @var UserFrosting\Session\Session We use the session object so that added messages will automatically appear in the session.
+     *    @var Session We use the session object so that added messages will automatically appear in the session.
      */
     protected $session;
 
     /**
-     * Create a new message stream.
+     *    Create a new message stream.
+     *
+     *    @param string $messagesKey Store the messages under this key
+     *    @param MessageTranslator|null $translator
+     *    @param Session $session
      */
-    public function __construct($messagesKey, $translator = null, $session)
+    public function __construct($messagesKey, MessageTranslator $translator = null, Session $session)
     {
         $this->session = $session;
         parent::__construct($messagesKey, $translator);
     }
 
     /**
-     * Get the messages from this message stream.
+     *    Get the messages from this message stream.
      *
-     * @return array An array of messages, each of which is itself an array containing "type" and "message" fields.
+     *    @return array An array of messages, each of which is itself an array containing "type" and "message" fields.
      */
     public function messages()
     {
         return $this->session[$this->messagesKey] ?: [];
     }
 
     /**
-     * Clear all messages from this message stream.
+     *    Clear all messages from this message stream.
+     *
+     *    @return void
      */
     public function resetMessageStream()
     {
         $this->session[$this->messagesKey] = [];
     }
 
     /**
-     * Save messages to the stream
+     *    Save messages to the stream
+     *
+     *    @param  string $messages The message
+     *    @return void
      */
     protected function saveMessages($messages)
     {

app/sprinkles/core/src/ServicesProvider/ServicesProvider.php

@@ -149,7 +149,7 @@ public function register(ContainerInterface $container)
         /**
          * Cache service.
          *
-         * @todo Create an option somewhere to flush the cache
+         * @return \Illuminate\Cache\TaggedCache
          */
         $container['cache'] = function ($c) {