From bd69cf2d041b2a5d947bc043897bdead1871f83a Mon Sep 17 00:00:00 2001 From: Michael M Slusarz Date: Wed, 28 Oct 2009 15:49:59 -0600 Subject: [PATCH] Better @return description for getEmbeddedMimeParts() Also, the plain driver should extend _getEmbeddedMimeParts(), not the public getEmbeddedMimeParts(). --- imp/lib/Mime/Viewer/Partial.php | 6 ++++-- imp/lib/Mime/Viewer/Pgp.php | 6 ++++-- imp/lib/Mime/Viewer/Plain.php | 8 +++++--- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/imp/lib/Mime/Viewer/Partial.php b/imp/lib/Mime/Viewer/Partial.php index 6f0a2d215..9f5b24b2f 100644 --- 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 e225295ae..a3ca1972d 100644 --- 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 37b967c7a..bdd72f5d6 100644 --- 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; -- 2.11.0