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