tests/SugarTestEmailAddressUtilities.php

   1 <?php
   2 /*********************************************************************************
   3  * SugarCRM Community Edition is a customer relationship management program developed by
   4  * SugarCRM, Inc. Copyright (C) 2004-2012 SugarCRM Inc.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it under
   7  * the terms of the GNU Affero General Public License version 3 as published by the
   8  * Free Software Foundation with the addition of the following permission added
   9  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
  10  * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
  11  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
  12  *
  13  * This program is distributed in the hope that it will be useful, but WITHOUT
  14  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  15  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License along with
  19  * this program; if not, see http://www.gnu.org/licenses or write to the Free
  20  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  21  * 02110-1301 USA.
  22  *
  23  * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
  24  * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
  25  *
  26  * The interactive user interfaces in modified source and object code versions
  27  * of this program must display Appropriate Legal Notices, as required under
  28  * Section 5 of the GNU Affero General Public License version 3.
  29  *
  30  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
  31  * these Appropriate Legal Notices must retain the display of the "Powered by
  32  * SugarCRM" logo. If the display of the logo is not reasonably feasible for
  33  * technical reasons, the Appropriate Legal Notices must display the words
  34  * "Powered by SugarCRM".
  35  ********************************************************************************/
  36
  37
  38 require_once 'modules/EmailAddresses/EmailAddress.php';
  39
  40 class SugarTestEmailAddressUtilities
  41 {
  42     private static $createdAddresses = array();
  43
  44     private function __construct() {}
  45
  46     public static function createEmailAddress($address = null)
  47     {
  48         if (null === $address)
  49         {
  50             $address = 'address-' . mt_rand() . '@example.com';
  51         }
  52
  53         $email_address = new EmailAddress();
  54         $email_address->email_address = $address;
  55         $email_address->save();
  56
  57         self::$createdAddresses[] = $email_address;
  58         return $email_address;
  59     }
  60
  61     /**
  62      * Add specified email address to the person
  63      *
  64      * @param Person $person
  65      * @param string|EmailAddress $address
  66      * @param array $additional_values
  67      * @return boolean|EmailAddress
  68      * @throws InvalidArgumentException
  69      */
  70     public static function addAddressToPerson(Person $person, $address, array $additional_values = array())
  71     {
  72         if (is_string($address))
  73         {
  74             $address = self::createEmailAddress($address);
  75         }
  76
  77         if (!$address instanceof EmailAddress)
  78         {
  79             throw new InvalidArgumentException(
  80                 'Address must be a string or an instance of EmailAddress, '
  81                     . gettype($address) . ' given'
  82             );
  83         }
  84
  85         if (!$person->load_relationship('email_addresses'))
  86         {
  87             return false;
  88         }
  89
  90         // create relation between user and email address
  91         $person->email_addresses->add(array($address), $additional_values);
  92         $GLOBALS['db']->commit();
  93         return $address;
  94     }
  95
  96     public static function removeAllCreatedAddresses()
  97     {
  98         $ids = self::getCreatedEmailAddressIds();
  99         if (count($ids) > 0)
 100         {
 101             $GLOBALS['db']->query('DELETE FROM email_addresses WHERE id IN (\'' . implode("', '", $ids) . '\')');
 102         }
 103         self::$createdAddresses = array();
 104     }
 105
 106     public static function getCreatedEmailAddressIds()
 107     {
 108         $ids = array();
 109         foreach (self::$createdAddresses as $address)
 110         {
 111             $ids[] = $address->id;
 112         }
 113         return $ids;
 114     }
 115 }