CRM/Queue - Code style
[civicrm-core.git] / CRM / Queue / Page / AJAX.php
index 44fe9c9e56de125ca4d659cf6cb19b68661126df..28b5bad7ab540deed2522ef7c483e097e186c827 100644 (file)
@@ -33,86 +33,95 @@ class CRM_Queue_Page_AJAX {
   /**
    * Run the next task and return status information
    *
-   * @return array(is_error => bool, is_continue => bool, numberOfItems => int, exception => htmlString)
+   * Outputs JSON: array(
+   *   is_error => bool,
+   *   is_continue => bool,
+   *   numberOfItems => int,
+   *   exception => htmlString
+   * )
    */
-  static function runNext() {
+  public static function runNext() {
     $errorPolicy = new CRM_Queue_ErrorPolicy();
-    $errorPolicy->call(
-    function () {
-        global $activeQueueRunner;
-        $qrid = CRM_Utils_Request::retrieve('qrid', 'String', CRM_Core_DAO::$_nullObject, TRUE, NULL, 'POST');
-        $activeQueueRunner = CRM_Queue_Runner::instance($qrid);
-        if (!is_object($activeQueueRunner)) {
-          throw new Exception('Queue runner must be configured before execution.');
+    $errorPolicy->call(function () {
+      global $activeQueueRunner;
+      $qrid = CRM_Utils_Request::retrieve('qrid', 'String', CRM_Core_DAO::$_nullObject, TRUE, NULL, 'POST');
+      $activeQueueRunner = CRM_Queue_Runner::instance($qrid);
+      if (!is_object($activeQueueRunner)) {
+        throw new Exception('Queue runner must be configured before execution.');
       }
-        $result = $activeQueueRunner->runNext(TRUE);
-        CRM_Queue_Page_AJAX::_return('runNext', $result);
-      }
-    );
+      $result = $activeQueueRunner->runNext(TRUE);
+      CRM_Queue_Page_AJAX::_return('runNext', $result);
+    });
   }
 
   /**
    * Run the next task and return status information
    *
-   * @return array(is_error => bool, is_continue => bool, numberOfItems => int, exception => htmlString)
+   * Outputs JSON: array(
+   *   is_error => bool,
+   *   is_continue => bool,
+   *   numberOfItems => int,
+   *   exception => htmlString
+   * )
    */
-  static function skipNext() {
+  public static function skipNext() {
     $errorPolicy = new CRM_Queue_ErrorPolicy();
-    $errorPolicy->call(
-    function () {
-        global $activeQueueRunner;
-        $qrid = CRM_Utils_Request::retrieve('qrid', 'String', CRM_Core_DAO::$_nullObject, TRUE, NULL, 'POST');
-        $activeQueueRunner = CRM_Queue_Runner::instance($qrid);
-        if (!is_object($activeQueueRunner)) {
-          throw new Exception('Queue runner must be configured before execution.');
-      }
-        $result = $activeQueueRunner->skipNext(TRUE);
-        CRM_Queue_Page_AJAX::_return('skipNext', $result);
+    $errorPolicy->call(function () {
+      global $activeQueueRunner;
+      $qrid = CRM_Utils_Request::retrieve('qrid', 'String', CRM_Core_DAO::$_nullObject, TRUE, NULL, 'POST');
+      $activeQueueRunner = CRM_Queue_Runner::instance($qrid);
+      if (!is_object($activeQueueRunner)) {
+        throw new Exception('Queue runner must be configured before execution.');
       }
-    );
+      $result = $activeQueueRunner->skipNext(TRUE);
+      CRM_Queue_Page_AJAX::_return('skipNext', $result);
+    });
   }
 
   /**
    * Run the next task and return status information
    *
-   * @return array(is_error => bool, is_continue => bool, numberOfItems => int, exception => htmlString)
+   * Outputs JSON: array(
+   *   is_error => bool,
+   *   is_continue => bool,
+   *   numberOfItems => int,
+   *   exception => htmlString
+   * )
    */
-  static function onEnd() {
+  public static function onEnd() {
     $errorPolicy = new CRM_Queue_ErrorPolicy();
-    $errorPolicy->call(
-    function () {
-        global $activeQueueRunner;
-        $qrid = CRM_Utils_Request::retrieve('qrid', 'String', CRM_Core_DAO::$_nullObject, TRUE, NULL, 'POST');
-        $activeQueueRunner = CRM_Queue_Runner::instance($qrid);
-        if (!is_object($activeQueueRunner)) {
-          throw new Exception('Queue runner must be configured before execution. - onEnd');
+    $errorPolicy->call(function () {
+      global $activeQueueRunner;
+      $qrid = CRM_Utils_Request::retrieve('qrid', 'String', CRM_Core_DAO::$_nullObject, TRUE, NULL, 'POST');
+      $activeQueueRunner = CRM_Queue_Runner::instance($qrid);
+      if (!is_object($activeQueueRunner)) {
+        throw new Exception('Queue runner must be configured before execution. - onEnd');
       }
-        $result = $activeQueueRunner->handleEnd(FALSE);
-        CRM_Queue_Page_AJAX::_return('onEnd', $result);
-    }
-    );
+      $result = $activeQueueRunner->handleEnd(FALSE);
+      CRM_Queue_Page_AJAX::_return('onEnd', $result);
+    });
   }
 
   /**
    * Performing any view-layer filtering on result and send to client.
    */
-  static function _return($op, $result) {
-        if ($result['is_error']) {
+  public static function _return($op, $result) {
+    if ($result['is_error']) {
       if (is_object($result['exception'])) {
         CRM_Core_Error::debug_var("CRM_Queue_Page_AJAX_{$op}_error", CRM_Core_Error::formatTextException($result['exception']));
 
         $config = CRM_Core_Config::singleton();
         if ($config->backtrace || CRM_Core_Config::isUpgradeMode()) {
           $result['exception'] = CRM_Core_Error::formatHtmlException($result['exception']);
-      }
+        }
         else {
           $result['exception'] = $result['exception']->getMessage();
         }
-      } else {
+      }
+      else {
         CRM_Core_Error::debug_var("CRM_Queue_Page_AJAX_{$op}_error", $result);
       }
     }
-        CRM_Utils_JSON::output($result);
-    }
+    CRM_Utils_JSON::output($result);
   }
-
+}