www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/simpletest/simpletest.api.php

   1 <?php
   2
   3 /**
   4  * @file
   5  * Hooks provided by the SimpleTest module.
   6  */
   7
   8 /**
   9  * @addtogroup hooks
  10  * @{
  11  */
  12
  13 /**
  14  * Alter the list of tests.
  15  *
  16  * This hook will not be invoked by the phpunit tool.
  17  *
  18  * @param $groups
  19  *   A two dimensional array, the first key is the test group, the second is the
  20  *   name of the test class, and the value is in associative array containing
  21  *   'name', 'description', 'group', and 'requires' keys.
  22  *
  23  * @deprecated in Drupal 8.6.x and will be removed before Drupal 9.0.0. Convert
  24  *   your test to a PHPUnit-based one and implement test listeners.
  25  *
  26  * @see https://www.drupal.org/node/2939892
  27  */
  28 function hook_simpletest_alter(&$groups) {
  29   // An alternative session handler module would not want to run the original
  30   // Session HTTPS handling test because it checks the sessions table in the
  31   // database.
  32   unset($groups['Session']['testHttpsSession']);
  33 }
  34
  35 /**
  36  * A test group has started.
  37  *
  38  * This hook is called just once at the beginning of a test group.
  39  */
  40 function hook_test_group_started() {
  41 }
  42
  43 /**
  44  * A test group has finished.
  45  *
  46  * This hook is called just once at the end of a test group.
  47  */
  48 function hook_test_group_finished() {
  49 }
  50
  51 /**
  52  * An individual test has finished.
  53  *
  54  * This hook is called when an individual test has finished.
  55  *
  56  * @param
  57  *   $results The results of the test as gathered by
  58  *   \Drupal\simpletest\WebTestBase.
  59  *
  60  * @see \Drupal\simpletest\WebTestBase::results()
  61  */
  62 function hook_test_finished($results) {
  63 }
  64
  65 /**
  66  * @} End of "addtogroup hooks".
  67  */