Better @return description for getEmbeddedMimeParts()

Also, the plain driver should extend _getEmbeddedMimeParts(), not the
public getEmbeddedMimeParts().

diff --git a/imp/lib/Mime/Viewer/Partial.php b/imp/lib/Mime/Viewer/Partial.php
index 6f0a2d2..9f5b24b 100644 (file)
--- a/imp/lib/Mime/Viewer/Partial.php
+++ b/imp/lib/Mime/Viewer/Partial.php
@@ -31,8 +31,10 @@ class IMP_Horde_Mime_Viewer_Partial extends Horde_Mime_Viewer_Driver
      * MIME parts exist, return a list of MIME parts that contain the embedded
      * MIME part information.
      *
-     * @return array  An array of Horde_Mime_Part objects, with the key as
-     *                the ID, or null if no embedded MIME parts exist.
+     * @return mixed  An array with MIME IDs as the keys and Horde_Mime_Part
+     *                objects as the parts to replace the current value of
+     *                the given MIME ID.
+     *                Returns null if no embedded MIME parts exist.
      */
     protected function _getEmbeddedMimeParts()
     {

diff --git a/imp/lib/Mime/Viewer/Pgp.php b/imp/lib/Mime/Viewer/Pgp.php
index e225295..a3ca197 100644 (file)
--- a/imp/lib/Mime/Viewer/Pgp.php
+++ b/imp/lib/Mime/Viewer/Pgp.php
@@ -106,8 +106,10 @@ class IMP_Horde_Mime_Viewer_Pgp extends Horde_Mime_Viewer_Driver
      * MIME parts exist, return an altered version of the Horde_Mime_Part that
      * contains the embedded MIME part information.
      *
-     * @return mixed  A Horde_Mime_Part with the embedded MIME part information
-     *                or null if no embedded MIME parts exist.
+     * @return mixed  An array with MIME IDs as the keys and Horde_Mime_Part
+     *                objects as the parts to replace the current value of
+     *                the given MIME ID.
+     *                Returns null if no embedded MIME parts exist.
      */
     protected function _getEmbeddedMimeParts()
     {

diff --git a/imp/lib/Mime/Viewer/Plain.php b/imp/lib/Mime/Viewer/Plain.php
index 37b967c..bdd72f5 100644 (file)
--- a/imp/lib/Mime/Viewer/Plain.php
+++ b/imp/lib/Mime/Viewer/Plain.php
@@ -137,10 +137,12 @@ class IMP_Horde_Mime_Viewer_Plain extends Horde_Mime_Viewer_Plain
      * MIME parts exist, return a list of MIME parts that contain the embedded
      * MIME part information.
      *
-     * @return mixed  An array of Horde_Mime_Part objects, with the key as
-     *                the ID, or null if no embedded MIME parts exist.
+     * @return mixed  An array with MIME IDs as the keys and Horde_Mime_Part
+     *                objects as the parts to replace the current value of
+     *                the given MIME ID.
+     *                Returns null if no embedded MIME parts exist.
      */
-    public function getEmbeddedMimeParts()
+    protected function _getEmbeddedMimeParts()
     {
         $ret = null;