Merge pull request #5760 from sudhabisht/SMSissue

[civicrm-core.git] / CRM / Core / Lock.php

diff --git a/CRM/Core/Lock.php b/CRM/Core/Lock.php
index 73c16cde9f33c9aa146f36f6bf965e8b48cb1c8a..0a096909f8fbfefa9577d0fbebb94fd41a639017 100644 (file)
--- a/CRM/Core/Lock.php
+++ b/CRM/Core/Lock.php
@@ -3,7 +3,7 @@
  +--------------------------------------------------------------------+
  | CiviCRM version 4.6                                                |
  +--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2014                                |
+ | Copyright CiviCRM LLC (c) 2004-2015                                |
  +--------------------------------------------------------------------+
  | This file is a part of CiviCRM.                                    |
  |                                                                    |
@@ -23,12 +23,12 @@
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
-*/
+ */
 
 /**
  *
  * @package CRM
- * @copyright CiviCRM LLC (c) 2004-2014
+ * @copyright CiviCRM LLC (c) 2004-2015
  * $Id$
  *
  */
@@ -44,10 +44,13 @@ class CRM_Core_Lock {
   /**
    * Initialize the constants used during lock acquire / release
    *
-   * @param string $name name of the lock. Please prefix with component / functionality
+   * @param string $name
+   *   Name of the lock. Please prefix with component / functionality.
    *                      e.g. civimail.cronjob.JOB_ID
-   * @param int $timeout the number of seconds to wait to get the lock. 1 if not set
-   * @param boolean $serverWideLock should this lock be applicable across your entire mysql server
+   * @param int $timeout
+   *   The number of seconds to wait to get the lock. 1 if not set.
+   * @param bool $serverWideLock
+   *   Should this lock be applicable across your entire mysql server.
    *                                this is useful if you have multiple sites running on the same
    *                                mysql server and you want to limit the number of parallel cron
    *                                jobs - CRM-91XX
@@ -145,11 +148,11 @@ class CRM_Core_Lock {
    *
    * @param string $jobLog
    * @throws CRM_Core_Exception
-   * @return boolean
+   * @return bool
    */
   public function hackyHandleBrokenCode($jobLog) {
     if (stristr($this->_name, 'job')) {
-      throw new CRM_Core_Exception('lock aquisition for ' . $this->_name . 'attempted when ' . $jobLog . 'is not released');
+      throw new CRM_Core_Exception('lock acquisition for ' . $this->_name . 'attempted when ' . $jobLog . 'is not released');
     }
     if (defined('CIVICRM_LOCK_DEBUG')) {
       CRM_Core_Error::debug_log_message('(CRM-12856) faking lock for ' . $this->_name);
@@ -157,5 +160,5 @@ class CRM_Core_Lock {
     $this->_hasLock = TRUE;
     return TRUE;
   }
-}
 
+}