CRM/Contact/Form/Inline/Lock.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  * Auxilary class to provide support for locking (and ignoring locks on)
  38  * contact records.
  39  */
  40 class CRM_Contact_Form_Inline_Lock {
  41
  42   /**
  43    * This function provides the HTML form elements
  44    *
  45    * @param object $form form object
  46    * @param int $inlineEditMode ( 1 for contact summary
  47    * top bar form and 2 for display name edit )
  48    *
  49    * @access public
  50    * @return void
  51    */
  52   static function buildQuickForm(&$form, $contactID) {
  53     // We provide a value for oplock_ts to client, but JS uses it carefully
  54     // -- i.e.  when loading the first inline form, JS copies oplock_ts to a
  55     // global value, and that global value is used for future form submissions.
  56     // Any time a form is submitted, the value will be updated.  This
  57     // handles cases like:
  58     // - V1:open V1.phone:open V1.email:open V1.email:submit V1.phone:submit
  59     // - V1:open E1:open E1:submit V1.email:open V1.email:submit
  60     // - V1:open V1.email:open E1:open E1:submit V1.email:submit V1:lock
  61     $timestamps = CRM_Contact_BAO_Contact::getTimestamps($contactID);
  62     $form->addElement('hidden', 'oplock_ts', $timestamps['modified_date'], array('id' => 'oplock_ts'));
  63     $form->addFormRule(array('CRM_Contact_Form_Inline_Lock', 'formRule'), $contactID);
  64   }
  65
  66   /**
  67    * Ensure that oplock_ts hasn't changed in the underlying DB
  68    *
  69    * @param array $fields  the input form values
  70    * @param array $files   the uploaded files if any
  71    * @param array $options additional user data
  72    *
  73    * @return true if no errors, else array of errors
  74    * @access public
  75    * @static
  76    */
  77   static function formRule($fields, $files, $contactID = NULL) {
  78     $errors = array();
  79
  80     $timestamps = CRM_Contact_BAO_Contact::getTimestamps($contactID);
  81     if ($fields['oplock_ts'] != $timestamps['modified_date']) {
  82       // Inline buttons generated via JS
  83       $open = sprintf("<div class='update_oplock_ts' data:update_oplock_ts='%s'>", $timestamps['modified_date']);
  84       $close = "</div>";
  85       $errors['oplock_ts'] = $open . ts('This record was modified by another user!') . $close;
  86     }
  87
  88     return empty($errors) ? TRUE : $errors;
  89   }
  90
  91   /**
  92    * Return any post-save data
  93    *
  94    * @return array extra options to return in JSON
  95    */
  96   static function getResponse($contactID) {
  97     $timestamps = CRM_Contact_BAO_Contact::getTimestamps($contactID);
  98     return array('oplock_ts' => $timestamps['modified_date']);
  99   }
 100 }