annotate core/modules/simpletest/simpletest.api.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children 129ea1e6d783
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /**
Chris@0 4 * @file
Chris@0 5 * Hooks provided by the SimpleTest module.
Chris@0 6 */
Chris@0 7
Chris@0 8 /**
Chris@0 9 * @addtogroup hooks
Chris@0 10 * @{
Chris@0 11 */
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Alter the list of tests.
Chris@0 15 *
Chris@0 16 * @param $groups
Chris@0 17 * A two dimensional array, the first key is the test group, the second is the
Chris@0 18 * name of the test class, and the value is in associative array containing
Chris@0 19 * 'name', 'description', 'group', and 'requires' keys.
Chris@0 20 */
Chris@0 21 function hook_simpletest_alter(&$groups) {
Chris@0 22 // An alternative session handler module would not want to run the original
Chris@0 23 // Session HTTPS handling test because it checks the sessions table in the
Chris@0 24 // database.
Chris@0 25 unset($groups['Session']['testHttpsSession']);
Chris@0 26 }
Chris@0 27
Chris@0 28 /**
Chris@0 29 * A test group has started.
Chris@0 30 *
Chris@0 31 * This hook is called just once at the beginning of a test group.
Chris@0 32 */
Chris@0 33 function hook_test_group_started() {
Chris@0 34 }
Chris@0 35
Chris@0 36 /**
Chris@0 37 * A test group has finished.
Chris@0 38 *
Chris@0 39 * This hook is called just once at the end of a test group.
Chris@0 40 */
Chris@0 41 function hook_test_group_finished() {
Chris@0 42 }
Chris@0 43
Chris@0 44 /**
Chris@0 45 * An individual test has finished.
Chris@0 46 *
Chris@0 47 * This hook is called when an individual test has finished.
Chris@0 48 *
Chris@0 49 * @param
Chris@0 50 * $results The results of the test as gathered by
Chris@0 51 * \Drupal\simpletest\WebTestBase.
Chris@0 52 *
Chris@0 53 * @see \Drupal\simpletest\WebTestBase::results()
Chris@0 54 */
Chris@0 55 function hook_test_finished($results) {
Chris@0 56 }
Chris@0 57
Chris@0 58
Chris@0 59 /**
Chris@0 60 * @} End of "addtogroup hooks".
Chris@0 61 */