tests/phpunit - Declare `@group headless`
[civicrm-core.git] / tests / phpunit / CRM / Core / TransactionTest.php
index 980d0ae60d72e48a6cb9cedf06b0100185023cb0..2b32ca28dce6c86f510df44bc7300f3e606592a1 100644 (file)
@@ -1,10 +1,8 @@
 <?php
-require_once 'CiviTest/CiviUnitTestCase.php';
-require_once 'CiviTest/Contact.php';
-require_once 'CiviTest/Custom.php';
 
 /**
  * Class CRM_Core_TransactionTest
+ * @group headless
  */
 class CRM_Core_TransactionTest extends CiviUnitTestCase {
 
@@ -27,6 +25,9 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
     $this->cids = array();
   }
 
+  /**
+   * @return array
+   */
   public function dataCreateStyle() {
     return array(
       array('sql-insert'),
@@ -34,6 +35,9 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
     );
   }
 
+  /**
+   * @return array
+   */
   public function dataCreateAndCommitStyles() {
     return array(
       array('sql-insert', 'implicit-commit'),
@@ -67,7 +71,7 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
   }
 
   /**
-   * Test in which an outer function makes multiple calls to inner functions
+   * Test in which an outer function makes multiple calls to inner functions.
    * but then rolls back the entire set.
    *
    * @param string $createStyle
@@ -205,19 +209,19 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
 
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_PRE_COMMIT, array($this, '_preCommit'), array(
         'qwe',
-        'rty'
+        'rty',
       ));
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_COMMIT, array($this, '_postCommit'), array(
         'uio',
-        'p[]'
+        'p[]',
       ));
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_PRE_ROLLBACK, array(
         $this,
-        '_preRollback'
+        '_preRollback',
       ), array('asd', 'fgh'));
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_ROLLBACK, array(
         $this,
-        '_postRollback'
+        '_postRollback',
       ), array('jkl', ';'));
 
     CRM_Core_DAO::executeQuery('UPDATE civicrm_contact SET id = 100 WHERE id = 100');
@@ -233,19 +237,19 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
 
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_PRE_COMMIT, array($this, '_preCommit'), array(
         'ewq',
-        'ytr'
+        'ytr',
       ));
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_COMMIT, array($this, '_postCommit'), array(
         'oiu',
-        '][p'
+        '][p',
       ));
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_PRE_ROLLBACK, array(
         $this,
-        '_preRollback'
+        '_preRollback',
       ), array('dsa', 'hgf'));
     CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_ROLLBACK, array(
         $this,
-        '_postRollback'
+        '_postRollback',
       ), array('lkj', ';'));
 
     CRM_Core_DAO::executeQuery('UPDATE civicrm_contact SET id = 100 WHERE id = 100');
@@ -385,7 +389,7 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
   }
 
   /**
-   * Perform a series of operations within smaller transactions
+   * Perform a series of operations within smaller transactions.
    *
    * @param string $nesting
    *   'reuse-tx'|'nest-tx' how to construct transaction.
@@ -395,8 +399,7 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
    *   See assertContactsMix.
    * @param string $outcome
    *   'rollback'|'implicit-commit'|'explicit-commit' how to finish transaction.
-   * @return int
-   *   cid
+   * @return void
    */
   public function runBatch($nesting, $callbacks, $existsByOffset, $outcome) {
     if ($nesting != 'reuse-tx' && $nesting != 'nest-tx') {
@@ -424,19 +427,36 @@ class CRM_Core_TransactionTest extends CiviUnitTestCase {
     } // else: implicit-commit
   }
 
+  /**
+   * @param $arg1
+   * @param $arg2
+   */
   public function _preCommit($arg1, $arg2) {
     $this->callbackLog[] = array('_preCommit', $arg1, $arg2);
   }
 
+  /**
+   * @param $arg1
+   * @param $arg2
+   */
   public function _postCommit($arg1, $arg2) {
     $this->callbackLog[] = array('_postCommit', $arg1, $arg2);
   }
 
+  /**
+   * @param $arg1
+   * @param $arg2
+   */
   public function _preRollback($arg1, $arg2) {
     $this->callbackLog[] = array('_preRollback', $arg1, $arg2);
   }
 
+  /**
+   * @param $arg1
+   * @param $arg2
+   */
   public function _postRollback($arg1, $arg2) {
     $this->callbackLog[] = array('_postRollback', $arg1, $arg2);
   }
+
 }