Fix various PHPDoc issues

phpstan-baseline.neon

@@ -271,11 +271,6 @@ parameters:
 			count: 2
 			path: plugins/markasjunk/drivers/email_learn.php
 
-		-
-			message: "#^Access to an undefined property object\\:\\:\\$mime_id\\.$#"
-			count: 1
-			path: plugins/markasjunk/drivers/sa_detach.php
-
 		-
 			message: "#^Access to an undefined property rcube\\:\\:\\$action\\.$#"
 			count: 2
@@ -1059,31 +1054,6 @@ parameters:
 			count: 1
 			path: program/lib/Roundcube/rcube_ldap.php
 
-		-
-			message: "#^Access to an undefined property object\\:\\:\\$content_id\\.$#"
-			count: 1
-			path: program/lib/Roundcube/rcube_message.php
-
-		-
-			message: "#^Access to an undefined property object\\:\\:\\$content_location\\.$#"
-			count: 1
-			path: program/lib/Roundcube/rcube_message.php
-
-		-
-			message: "#^Access to an undefined property object\\:\\:\\$mime_id\\.$#"
-			count: 2
-			path: program/lib/Roundcube/rcube_message.php
-
-		-
-			message: "#^Access to an undefined property object\\:\\:\\$mimetype\\.$#"
-			count: 1
-			path: program/lib/Roundcube/rcube_message.php
-
-		-
-			message: "#^Cannot access property \\$parts on bool\\|object\\.$#"
-			count: 1
-			path: program/lib/Roundcube/rcube_message.php
-
 		-
 			message: "#^Method rcube\\:\\:url\\(\\) invoked with 4 parameters, 1 required\\.$#"
 			count: 1
@@ -1099,11 +1069,6 @@ parameters:
 			count: 1
 			path: program/lib/Roundcube/rcube_message.php
 
-		-
-			message: "#^Method rcube_message\\:\\:get_part_content\\(\\) should return string but return statement is missing\\.$#"
-			count: 1
-			path: program/lib/Roundcube/rcube_message.php
-
 		-
 			message: "#^Method rcube_storage\\:\\:get_message_part\\(\\) invoked with 8 parameters, 1\\-6 required\\.$#"
 			count: 3
@@ -1124,11 +1089,6 @@ parameters:
 			count: 1
 			path: program/lib/Roundcube/rcube_mime.php
 
-		-
-			message: "#^Cannot access property \\$size on object\\|true\\.$#"
-			count: 1
-			path: program/lib/Roundcube/rcube_mime_decode.php
-
 		-
 			message: "#^Access to an undefined property rcube\\:\\:\\$action\\.$#"
 			count: 1

program/lib/Roundcube/cache/memcache.php

@@ -44,7 +44,7 @@ public function __construct($userid, $prefix = '', $ttl = 0, $packed = true, $in
     /**
      * Get global handle for memcache access
      *
-     * @return object Memcache
+     * @return Memcache
      */
     public static function engine()
     {

program/lib/Roundcube/cache/memcached.php

@@ -50,7 +50,7 @@ public function __construct($userid, $prefix = '', $ttl = 0, $packed = true, $in
     /**
      * Get global handle for memcache access
      *
-     * @return object Memcache
+     * @return Memcache
      */
     public static function engine()
     {

program/lib/Roundcube/cache/redis.php

@@ -46,7 +46,7 @@ public function __construct($userid, $prefix = '', $ttl = 0, $packed = true, $in
     /**
      * Get global handle for redis access
      *
-     * @return object Redis
+     * @return Redis
      */
     public static function engine()
     {

program/lib/Roundcube/rcube_imap.php

@@ -1888,7 +1888,7 @@ public function get_message_headers($uid, $folder = null, $force = false)
      * @param int    $uid    Message UID to fetch
      * @param string $folder Folder to read from
      *
-     * @return object rcube_message_header Message data
+     * @return rcube_message_header Message data
      */
     public function get_message($uid, $folder = null)
     {
@@ -2401,7 +2401,7 @@ protected function structure_charset($structure)
      * @param int                $max_bytes         Only read this number of bytes
      * @param bool               $formatted         Enables formatting of text/* parts bodies
      *
-     * @return string Message/part body if not printed
+     * @return string|true|null Message/part body if not printed
      */
     public function get_message_part($uid, $part = 1, $o_part = null, $print = null, $fp = null,
         $skip_charset_conv = false, $max_bytes = 0, $formatted = true)
@@ -2452,6 +2452,7 @@ public function get_message_part($uid, $part = 1, $o_part = null, $print = null,
                         $o_part->charset = $this->default_charset;
                     }
                 }
+
                 $body = rcube_charset::convert($body, $o_part->charset);
             }
         }

program/lib/Roundcube/rcube_ldap.php

@@ -964,7 +964,7 @@ public function search($fields, $value, $mode = 0, $select = true, $nocount = fa
     /**
      * Count number of available contacts in database
      *
-     * @return object rcube_result_set Resultset with values for 'count' and 'first'
+     * @return rcube_result_set Resultset with values for 'count' and 'first'
      */
     public function count()
     {
@@ -1070,7 +1070,7 @@ protected function extended_search($count = false)
     /**
      * Return the last result set
      *
-     * @return object rcube_result_set Current resultset or NULL if nothing selected yet
+     * @return rcube_result_set Current resultset or NULL if nothing selected yet
      */
     public function get_result()
     {

program/lib/Roundcube/rcube_message.php

@@ -56,15 +56,23 @@ class rcube_message
     public $sender;
     public $context;
     public $body;
-    public $parts        = [];
-    public $mime_parts   = [];
-    public $inline_parts = [];
-    public $attachments  = [];
-    public $subject      = '';
-    public $is_safe      = false;
-    public $pgp_mime     = false;
+    public $subject  = '';
+    public $is_safe  = false;
+    public $pgp_mime = false;
     public $encrypted_part;
 
+    /** @var array<rcube_message_part> */
+    public $parts = [];
+
+    /** @var array<rcube_message_part> */
+    public $mime_parts = [];
+
+    /** @var array<rcube_message_part> */
+    public $inline_parts = [];
+
+    /** @var array<rcube_message_part> */
+    public $attachments = [];
+
     public const BODY_MAX_SIZE = 1048576; // 1MB
 
     /**
@@ -645,6 +653,7 @@ private function parse_structure($structure, $recursive = false)
             return;
         }
 
+        /** @var rcube_message_part $structure */
         $structure = $plugin['structure'];
         $mimetype  = $plugin['mimetype'];
         $recursive = $plugin['recursive'];
@@ -801,8 +810,7 @@ private function parse_structure($structure, $recursive = false)
         // message contains multiple parts
         elseif (is_array($structure->parts) && !empty($structure->parts)) {
             // iterate over parts
-            for ($i = 0; $i < count($structure->parts); $i++) {
-                $mail_part      = &$structure->parts[$i];
+            foreach ($structure->parts as $mail_part) {
                 $primary_type   = $mail_part->ctype_primary;
                 $secondary_type = $mail_part->ctype_secondary;
                 $part_mimetype  = $mail_part->mimetype;
@@ -890,6 +898,7 @@ private function parse_structure($structure, $recursive = false)
 
                     // add winmail.dat to the list if it's content is unknown
                     if (empty($tnef_parts) && !empty($mail_part->filename)) {
+                        // @phpstan-ignore-next-line
                         $this->mime_parts[$mail_part->mime_id] = $mail_part;
                         $this->add_part($mail_part, 'attachment');
                     }

program/lib/Roundcube/rcube_message_part.php

@@ -90,7 +90,7 @@ class rcube_message_part
     /**
      * Sub-Parts
      *
-     * @var array
+     * @var array<rcube_message_part>
      */
     public $parts = [];
 

program/lib/Roundcube/rcube_mime.php

@@ -60,7 +60,7 @@ public static function get_charset()
      *
      * @param string $raw_body The message source
      *
-     * @return object rcube_message_part The message structure
+     * @return rcube_message_part The message structure
      */
     public static function parse_message($raw_body)
     {

program/lib/Roundcube/rcube_mime_decode.php

@@ -63,7 +63,7 @@ public function __construct($params = [])
      * @param string $input   The input to decode
      * @param bool   $convert Convert result to rcube_message_part structure
      *
-     * @return object|bool Decoded results or False on failure
+     * @return rcube_message_part|false Decoded results or False on failure
      */
     public function decode($input, $convert = true)
     {
@@ -91,7 +91,7 @@ public function decode($input, $convert = true)
      * @param string $body          Body section
      * @param string $default_ctype Default content type
      *
-     * @return object|bool Decoded results or False on error
+     * @return rcube_message_part|false Decoded results or False on error
      */
     protected function do_decode($headers, $body, $default_ctype = 'text/plain')
     {
@@ -352,11 +352,11 @@ protected function decodeHeader($input)
      * Recursive method to convert a rcube_mime_decode structure
      * into a rcube_message_part object.
      *
-     * @param object $part   A message part struct
-     * @param int    $count  Part count
-     * @param string $parent Parent MIME ID
+     * @param rcube_message_part $part   A message part struct
+     * @param int                $count  Part count
+     * @param string             $parent Parent MIME ID
      *
-     * @return object rcube_message_part
+     * @return rcube_message_part
      *
      * @see self::decode()
      */

program/lib/Roundcube/rcube_storage.php

@@ -439,7 +439,7 @@ abstract public function refresh_search();
      * @param int    $uid    Message UID to fetch
      * @param string $folder Folder to read from
      *
-     * @return object rcube_message_header Message data
+     * @return rcube_message_header Message data
      */
     abstract public function get_message($uid, $folder = null);
 
@@ -464,7 +464,7 @@ abstract public function get_message_headers($uid, $folder = null, $force = fals
      * @param resource           $fp                File pointer to save the message part
      * @param bool               $skip_charset_conv Disables charset conversion
      *
-     * @return string Message/part body if not printed
+     * @return string|true|null Message/part body if not printed
      */
     abstract public function get_message_part($uid, $part = 1, $o_part = null, $print = null, $fp = null, $skip_charset_conv = false);