[mms] Added Horde_Mail_Rfc822_List#first() function.

horde · Nov 2, 2014 · 93cc4f1 · 93cc4f1
1 parent 0db6c2e
commit 93cc4f1
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/framework/Mail/doc/Horde/Mail/UPGRADING b/framework/Mail/doc/Horde/Mail/UPGRADING
@@ -28,6 +28,12 @@ Upgrading to 2.5
 
     Added the 'eai' property.
 
+  - Horde_Mail_Rfc822_List
+
+    - first()
+
+      This method has been added.
+
   - Horde_Mail_Mbox_Parse
 
     Added object to parse mbox format mailbox data.

diff --git a/framework/Mail/lib/Horde/Mail/Rfc822/List.php b/framework/Mail/lib/Horde/Mail/Rfc822/List.php
@@ -31,7 +31,9 @@
  * @property-read array $raw_addresses  The list of all addresses (Address
  *                                      objects).
  */
-class Horde_Mail_Rfc822_List extends Horde_Mail_Rfc822_Object implements ArrayAccess, Countable, SeekableIterator, Serializable
+class Horde_Mail_Rfc822_List
+    extends Horde_Mail_Rfc822_Object
+    implements ArrayAccess, Countable, SeekableIterator, Serializable
 {
     /** Filter masks. */
     const HIDE_GROUPS = 1;
@@ -275,6 +277,21 @@ public function contains($address)
         return false;
     }
 
+    /**
+     * Convenience method to return the first element in a list.
+     *
+     * Useful since it allows chaining; older PHP versions did not allow array
+     * access dereferencing from the results of a function call.
+     *
+     * @since 2.5.0
+     *
+     * @return Horde_Mail_Rfc822_Object  Rfc822 object, or null if no object.
+     */
+    public function first()
+    {
+        return $this[0];
+    }
+
     /**
      * Normalize objects to add to list.
      *

diff --git a/framework/Mail/package.xml b/framework/Mail/package.xml
@@ -21,6 +21,7 @@
  </stability>
  <license uri="http://www.horde.org/licenses/bsd">BSD-2-Clause</license>
  <notes>
+* [mms] Added Horde_Mail_Rfc822_List#first() function.
 * [mms] Add property to address object to indicate whether it is an EAI address.
 * [mms] Transport driver now indicates whether it handles EAI data.
 * [mms] Support validation of EAI addresses (RFC 6532).
@@ -646,6 +647,7 @@
    <date>2014-08-14</date>
    <license uri="http://www.horde.org/licenses/bsd">BSD-2-Clause</license>
    <notes>
+* [mms] Added Horde_Mail_Rfc822_List#first() function.
 * [mms] Add property to address object to indicate whether it is an EAI address.
 * [mms] Transport driver now indicates whether it handles EAI data.
 * [mms] Support validation of EAI addresses (RFC 6532).