CRM/Contact/Form/Edit/Lock.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | CiviCRM version 4.5                                                |
   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_Edit_Lock {
  41
  42   /**
  43    * This function provides the HTML form elements
  44    *
  45    * @param object $form form object
  46    *
  47    * @internal param int $inlineEditMode ( 1 for contact summary
  48    * top bar form and 2 for display name edit )
  49    *
  50    * @access public
  51    * @return void
  52    */
  53   public static function buildQuickForm(&$form) {
  54     $form->addElement('hidden', 'modified_date', '', array('id' => 'modified_date'));
  55   }
  56
  57   /**
  58    * Ensure that modified_date hasn't changed in the underlying DB
  59    *
  60    * @param array $fields the input form values
  61    * @param array $files the uploaded files if any
  62    * @param null $contactID
  63    *
  64    * @internal param array $options additional user data
  65    *
  66    * @return true if no errors, else array of errors
  67    * @access public
  68    * @static
  69    */
  70   static function formRule($fields, $files, $contactID = NULL) {
  71     $errors = array();
  72
  73     $timestamps = CRM_Contact_BAO_Contact::getTimestamps($contactID);
  74     if ($fields['modified_date'] != $timestamps['modified_date']) {
  75       // Inline buttons generated via JS
  76       $open = sprintf("<span id='update_modified_date' data:latest_modified_date='%s'>", $timestamps['modified_date']);
  77       $close = "</span>";
  78       $errors['modified_date'] = $open . ts('This record was modified by another user!') . $close;
  79     }
  80
  81     return empty($errors) ? TRUE : $errors;
  82   }
  83 }