CRM/Contact/Form/Inline/Email.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.4                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2013                                |
   7  +--------------------------------------------------------------------+
   8  | This file is a part of CiviCRM.                                    |
   9  |                                                                    |
  10  | CiviCRM is free software; you can copy, modify, and distribute it  |
  11  | under the terms of the GNU Affero General Public License           |
  12  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  13  |                                                                    |
  14  | CiviCRM is distributed in the hope that it will be useful, but     |
  15  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  16  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  17  | See the GNU Affero General Public License for more details.        |
  18  |                                                                    |
  19  | You should have received a copy of the GNU Affero General Public   |
  20  | License and the CiviCRM Licensing Exception along                  |
  21  | with this program; if not, contact CiviCRM LLC                     |
  22  | at info[AT]civicrm[DOT]org. If you have questions about the        |
  23  | GNU Affero General Public License or the licensing of CiviCRM,     |
  24  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  25  +--------------------------------------------------------------------+
  26 */
  27
  28 /**
  29  *
  30  * @package CRM
  31  * @copyright CiviCRM LLC (c) 2004-2013
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * form helper class for an Email object
  38  */
  39 class CRM_Contact_Form_Inline_Email extends CRM_Contact_Form_Inline {
  40
  41   /**
  42    * email addresses of the contact that is been viewed
  43    */
  44   private $_emails = array();
  45
  46   /**
  47    * No of email blocks for inline edit
  48    */
  49   private $_blockCount = 6;
  50
  51   /**
  52    * call preprocess
  53    */
  54   public function preProcess() {
  55     parent::preProcess();
  56
  57     //get all the existing email addresses
  58     $email = new CRM_Core_BAO_Email();
  59     $email->contact_id = $this->_contactId;
  60
  61     $this->_emails = CRM_Core_BAO_Block::retrieveBlock($email, NULL);
  62   }
  63
  64   /**
  65    * build the form elements for an email object
  66    *
  67    * @return void
  68    * @access public
  69    */
  70   public function buildQuickForm() {
  71     parent::buildQuickForm();
  72
  73     $totalBlocks = $this->_blockCount;
  74     $actualBlockCount = 1;
  75     if (count($this->_emails) > 1) {
  76       $actualBlockCount = $totalBlocks = count($this->_emails);
  77       if ($totalBlocks < $this->_blockCount) {
  78       $additionalBlocks = $this->_blockCount - $totalBlocks;
  79       $totalBlocks += $additionalBlocks;
  80     }
  81       else {
  82         $actualBlockCount++;
  83         $totalBlocks++;
  84       }
  85     }
  86
  87     $this->assign('actualBlockCount', $actualBlockCount);
  88     $this->assign('totalBlocks', $totalBlocks);
  89
  90     $this->applyFilter('__ALL__', 'trim');
  91
  92     for ($blockId = 1; $blockId < $totalBlocks; $blockId++) {
  93       CRM_Contact_Form_Edit_Email::buildQuickForm($this, $blockId, TRUE);
  94     }
  95
  96     $this->addFormRule(array('CRM_Contact_Form_Inline_Email', 'formRule'));
  97   }
  98
  99   /**
 100    * global validation rules for the form
 101    *
 102    * @param array $fields     posted values of the form
 103    * @param array $errors     list of errors to be posted back to the form
 104    *
 105    * @return $errors
 106    * @static
 107    * @access public
 108    */
 109   static function formRule($fields, $errors) {
 110     $hasData = $hasPrimary = $errors = array();
 111     if (CRM_Utils_Array::value('email', $fields) && is_array($fields['email'])) {
 112       foreach ($fields['email'] as $instance => $blockValues) {
 113         $dataExists = CRM_Contact_Form_Contact::blockDataExists($blockValues);
 114
 115         if ($dataExists) {
 116           $hasData[] = $instance;
 117           if (CRM_Utils_Array::value('is_primary', $blockValues)) {
 118             $hasPrimary[] = $instance;
 119             }
 120           }
 121         }
 122
 123
 124       if (empty($hasPrimary) && !empty($hasData)) {
 125         $errors["email[1][is_primary]"] = ts('One email should be marked as primary.');
 126       }
 127
 128       if (count($hasPrimary) > 1) {
 129         $errors["email[".array_pop($hasPrimary)."][is_primary]"] = ts('Only one email can be marked as primary.');
 130       }
 131     }
 132     return $errors;
 133   }
 134
 135   /**
 136    * set defaults for the form
 137    *
 138    * @return array
 139    * @access public
 140    */
 141   public function setDefaultValues() {
 142     $defaults = array();
 143     if (!empty($this->_emails)) {
 144       foreach ($this->_emails as $id => $value) {
 145         $defaults['email'][$id] = $value;
 146       }
 147     }
 148     else {
 149       // get the default location type
 150       $locationType = CRM_Core_BAO_LocationType::getDefault();
 151       $defaults['email'][1]['location_type_id'] = $locationType->id;
 152     }
 153
 154     return $defaults;
 155   }
 156
 157   /**
 158    * process the form
 159    *
 160    * @return void
 161    * @access public
 162    */
 163   public function postProcess() {
 164     $params = $this->exportValues();
 165
 166     // Process / save emails
 167     $params['contact_id'] = $this->_contactId;
 168     $params['updateBlankLocInfo'] = TRUE;
 169     CRM_Core_BAO_Block::create('email', $params);
 170
 171     $this->log();
 172     $this->response();
 173   }
 174 }