Merge pull request #4941 from totten/master-batch-14
[civicrm-core.git] / CRM / Contact / Form / Edit / Lock.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
6a488035 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
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
06b69b18 31 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
32 * $Id$
33 *
34 */
35
36/**
37 * Auxilary class to provide support for locking (and ignoring locks on)
38 * contact records.
39 */
40class CRM_Contact_Form_Edit_Lock {
41
42 /**
c490a46a 43 * Build the form object
6a488035 44 *
77c5b619
TO
45 * @param CRM_Core_Form $form
46 * Form object.
6a488035 47 *
6a488035
TO
48 * @return void
49 */
50 public static function buildQuickForm(&$form) {
51 $form->addElement('hidden', 'modified_date', '', array('id' => 'modified_date'));
52 }
53
54 /**
55 * Ensure that modified_date hasn't changed in the underlying DB
56 *
77c5b619
TO
57 * @param array $fields
58 * The input form values.
59 * @param array $files
60 * The uploaded files if any.
100fef9d 61 * @param int $contactID
6c8f6e67 62 *
72b3a70c
CW
63 * @return bool|array
64 * true if no errors, else array of errors
6a488035 65 */
00be9182 66 public static function formRule($fields, $files, $contactID = NULL) {
6a488035
TO
67 $errors = array();
68
69 $timestamps = CRM_Contact_BAO_Contact::getTimestamps($contactID);
70 if ($fields['modified_date'] != $timestamps['modified_date']) {
71 // Inline buttons generated via JS
72 $open = sprintf("<span id='update_modified_date' data:latest_modified_date='%s'>", $timestamps['modified_date']);
73 $close = "</span>";
74 $errors['modified_date'] = $open . ts('This record was modified by another user!') . $close;
75 }
76
77 return empty($errors) ? TRUE : $errors;
78 }
79}