CRM/Contact/Form/Inline/IM.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.6                                                |
   5  +--------------------------------------------------------------------+
   6  | Copyright CiviCRM LLC (c) 2004-2014                                |
   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-2014
  32  * $Id$
  33  *
  34  */
  35
  36 /**
  37  * form helper class for an IM object
  38  */
  39 class CRM_Contact_Form_Inline_IM extends CRM_Contact_Form_Inline {
  40
  41   /**
  42    * Ims of the contact that is been viewed
  43    */
  44   private $_ims = array();
  45
  46   /**
  47    * No of im 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 ims
  58     $im = new CRM_Core_BAO_IM();
  59     $im->contact_id = $this->_contactId;
  60
  61     $this->_ims = CRM_Core_BAO_Block::retrieveBlock($im, NULL);
  62   }
  63
  64   /**
  65    * Build the form object elements for im object
  66    *
  67    * @return void
  68    */
  69   public function buildQuickForm() {
  70     parent::buildQuickForm();
  71
  72     $totalBlocks = $this->_blockCount;
  73     $actualBlockCount = 1;
  74     if (count($this->_ims) > 1) {
  75       $actualBlockCount = $totalBlocks = count($this->_ims);
  76       if ($totalBlocks < $this->_blockCount) {
  77         $additionalBlocks = $this->_blockCount - $totalBlocks;
  78         $totalBlocks += $additionalBlocks;
  79       }
  80       else {
  81         $actualBlockCount++;
  82         $totalBlocks++;
  83       }
  84     }
  85
  86     $this->assign('actualBlockCount', $actualBlockCount);
  87     $this->assign('totalBlocks', $totalBlocks);
  88
  89     $this->applyFilter('__ALL__', 'trim');
  90
  91     for ($blockId = 1; $blockId < $totalBlocks; $blockId++) {
  92       CRM_Contact_Form_Edit_IM::buildQuickForm($this, $blockId, TRUE);
  93     }
  94
  95     $this->addFormRule(array('CRM_Contact_Form_Inline_IM', 'formRule'));
  96   }
  97
  98   /**
  99    * Global validation rules for the form
 100    *
 101    * @param array $fields
 102    *   Posted values of the form.
 103    * @param array $errors
 104    *   List of errors to be posted back to the form.
 105    *
 106    * @return array
 107    * @static
 108    */
 109   public static function formRule($fields, $errors) {
 110     $hasData = $hasPrimary = $errors = array();
 111     if (!empty($fields['im']) && is_array($fields['im'])) {
 112       foreach ($fields['im'] as $instance => $blockValues) {
 113         $dataExists = CRM_Contact_Form_Contact::blockDataExists($blockValues);
 114
 115         if ($dataExists) {
 116           $hasData[] = $instance;
 117           if (!empty($blockValues['is_primary'])) {
 118             $hasPrimary[] = $instance;
 119             if (!$primaryID && !empty($blockValues['im'])) {
 120                 $primaryID = $blockValues['im'];
 121             }
 122           }
 123         }
 124       }
 125
 126       if (empty($hasPrimary) && !empty($hasData)) {
 127         $errors["im[1][is_primary]"] = ts('One IM should be marked as primary.');
 128       }
 129
 130       if (count($hasPrimary) > 1) {
 131         $errors["im[" . array_pop($hasPrimary) . "][is_primary]"] = ts('Only one IM can be marked as primary.');
 132       }
 133     }
 134     return $errors;
 135   }
 136
 137   /**
 138    * Set defaults for the form
 139    *
 140    * @return array
 141    */
 142   public function setDefaultValues() {
 143     $defaults = array();
 144     if (!empty($this->_ims)) {
 145       foreach ($this->_ims as $id => $value) {
 146         $defaults['im'][$id] = $value;
 147       }
 148     }
 149     else {
 150       // get the default location type
 151       $locationType = CRM_Core_BAO_LocationType::getDefault();
 152       $defaults['im'][1]['location_type_id'] = $locationType->id;
 153     }
 154     return $defaults;
 155   }
 156
 157   /**
 158    * Process the form
 159    *
 160    * @return void
 161    */
 162   public function postProcess() {
 163     $params = $this->exportValues();
 164
 165     // Process / save IMs
 166     $params['contact_id'] = $this->_contactId;
 167     $params['updateBlankLocInfo'] = TRUE;
 168     CRM_Core_BAO_Block::create('im', $params);
 169
 170     $this->log();
 171     $this->response();
 172   }
 173 }