Changeset 10482

Timestamp:

01/30/2016 08:39:59 PM (10 years ago)

Author:

djpaul

Message:

Emails: new param for set_bcc|cc|to() to add to current values

The default behaviour remains to replace the current value.

This will allow plugin developers to easily append a new email
recipient without having to re-add the existing recipients.

See #6592

Location:

trunk

Files:

• src/bp-core/classes/class-bp-email.php (modified) (9 diffs)
• tests/phpunit/testcases/core/class-bp-email.php (modified) (1 diff)

trunk/src/bp-core/classes/class-bp-email.php

@@ -522 +522 @@
      *                                              or an array containing any combination of the above.
      * @param string $name Optional. If $bcc_address is a string, this is the recipient's name.
-     * @return BP_Email
-     */
-    public function set_bcc( $bcc_address, $name = '' ) {
-        $bcc = array();
+     * @param string $operation Optional. If "replace", $to_address replaces current setting (default).
+     *                          If "add", $to_address is added to the current setting.
+     * @return BP_Email
+     */
+    public function set_bcc( $bcc_address, $name = '', $operation = 'replace' ) {
+        $bcc = ( $operation !== 'replace' ) ? $this->bcc : array();
 
         if ( is_array( $bcc_address ) ) {
@@ -533 +535 @@
 
         } else {
-            $bcc = array( new BP_Email_Recipient( $bcc_address, $name ) );
+            $bcc[] = new BP_Email_Recipient( $bcc_address, $name );
         }
 
@@ -545 +547 @@
          *                                              or an array containing any combination of the above.
          * @param string $name Optional. If $bcc_address is a string, this is the recipient's name.
-         * @param BP_Email $this Current instance of the email type class.
-         */
-        $this->bcc = apply_filters( 'bp_email_set_bcc', $bcc, $bcc_address, $name, $this );
+         * @param string $operation If "replace", $to_address replaced previous recipients. If "add",
+         *                          $to_address was added to the array of recipients.
+         * @param BP_Email $this Current instance of the email type class.
+         */
+        $this->bcc = apply_filters( 'bp_email_set_bcc', $bcc, $bcc_address, $name, $operation, $this );
 
         return $this;
@@ -566 +570 @@
      *                                             or an array containing any combination of the above.
      * @param string $name Optional. If $cc_address is a string, this is the recipient's name.
-     * @return BP_Email
-     */
-    public function set_cc( $cc_address, $name = '' ) {
-        $cc = array();
+     * @param string $operation Optional. If "replace", $to_address replaces current setting (default).
+     *                          If "add", $to_address is added to the current setting.
+     * @return BP_Email
+     */
+    public function set_cc( $cc_address, $name = '', $operation = 'replace' ) {
+        $cc = ( $operation !== 'replace' ) ? $this->cc : array();
 
         if ( is_array( $cc_address ) ) {
@@ -577 +583 @@
 
         } else {
-            $cc = array( new BP_Email_Recipient( $cc_address, $name ) );
+            $cc[] = new BP_Email_Recipient( $cc_address, $name );
         }
 
@@ -589 +595 @@
          *                                             or an array containing any combination of the above.
          * @param string $name Optional. If $cc_address is a string, this is the recipient's name.
-         * @param BP_Email $this Current instance of the email type class.
-         */
-        $this->cc = apply_filters( 'bp_email_set_cc', $cc, $cc_address, $name, $this );
+         * @param string $operation If "replace", $to_address replaced previous recipients. If "add",
+         *                          $to_address was added to the array of recipients.
+         * @param BP_Email $this Current instance of the email type class.
+         */
+        $this->cc = apply_filters( 'bp_email_set_cc', $cc, $cc_address, $name, $operation, $this );
 
         return $this;
@@ -834 +842 @@
      *                                             or an array containing any combination of the above.
      * @param string $name Optional. If $to_address is a string, this is the recipient's name.
-     * @return BP_Email
-     */
-    public function set_to( $to_address, $name = '' ) {
-        $to = array();
+     * @param string $operation Optional. If "replace", $to_address replaces current setting (default).
+     *                          If "add", $to_address is added to the current setting.
+     * @return BP_Email
+     */
+    public function set_to( $to_address, $name = '', $operation = 'replace' ) {
+        $to = ( $operation !== 'replace' ) ? $this->to : array();
 
         if ( is_array( $to_address ) ) {
@@ -845 +855 @@
 
         } else {
-            $to = array( new BP_Email_Recipient( $to_address, $name ) );
+            $to[] = new BP_Email_Recipient( $to_address, $name );
         }
 
@@ -856 +866 @@
          * @param string $to_address "To" address.
          * @param string $name "To" name.
-         * @param BP_Email $this Current instance of the email type class.
-         */
-        $this->to = apply_filters( 'bp_email_set_to', $to, $to_address, $name, $this );
+         * @param string $operation If "replace", $to_address replaced previous recipients. If "add",
+         *                          $to_address was added to the array of recipients.
+         * @param BP_Email $this Current instance of the email type class.
+         */
+        $this->to = apply_filters( 'bp_email_set_to', $to, $to_address, $name, $operation, $this );
 
         return $this;

trunk/tests/phpunit/testcases/core/class-bp-email.php

@@ -223 +223 @@
         $this->assertSame( $user3,             $addresses[2]->get_address() );
     }
+
+    public function test_replacing_existing_recipients_with_new_recipients() {
+        $email              = new BP_Email( 'fake_type' );
+        $original_recipient = 'test1@example.com';
+        $new_recipient      = 'test2@example.com';
+
+        $email->set_to( $original_recipient );
+        $addresses = $email->get_to();
+        $this->assertSame( $original_recipient, $addresses[0]->get_address() );
+
+        $email->set_to( $new_recipient );
+        $addresses = $email->get_to();
+        $this->assertSame( $new_recipient, $addresses[0]->get_address() );
+    }
+
+    public function test_appending_new_recipients_to_existing_recipients() {
+        $email              = new BP_Email( 'fake_type' );
+        $original_recipient = 'test1@example.com';
+        $new_recipient      = 'test2@example.com';
+
+        $email->set_to( $original_recipient );
+        $addresses = $email->get_to();
+        $this->assertSame( $original_recipient, $addresses[0]->get_address() );
+
+        $email->set_to( $new_recipient, '', 'add' );
+        $addresses = $email->get_to();
+        $this->assertSame( $original_recipient, $addresses[0]->get_address() );
+        $this->assertSame( $new_recipient, $addresses[1]->get_address() );
+    }
 }