simpletest.api.php

Hooks provided by the SimpleTest module.

File

drupal/modules/simpletest/simpletest.api.php
View source
  1. <?php
  2. /**
  3. * @file
  4. * Hooks provided by the SimpleTest module.
  5. */
  6. /**
  7. * @addtogroup hooks
  8. * @{
  9. */
  10. /**
  11. * Alter the list of tests.
  12. *
  13. * @param $groups
  14. * A two dimension array, the first key is the test group (as defined in
  15. * getInfo) the second is the name of the class and the value is the return
  16. * value of the getInfo method.
  17. */
  18. function hook_simpletest_alter(&$groups) {
  19. // An alternative session handler module would not want to run the original
  20. // Session HTTPS handling test because it checks the sessions table in the
  21. // database.
  22. unset($groups['Session']['testHttpsSession']);
  23. }
  24. /**
  25. * A test group has started.
  26. *
  27. * This hook is called just once at the beginning of a test group.
  28. */
  29. function hook_test_group_started() {
  30. }
  31. /**
  32. * A test group has finished.
  33. *
  34. * This hook is called just once at the end of a test group.
  35. */
  36. function hook_test_group_finished() {
  37. }
  38. /**
  39. * An individual test has finished.
  40. *
  41. * This hook is called when an individual test has finished.
  42. *
  43. * @param
  44. * $results The results of the test as gathered by DrupalWebTestCase.
  45. *
  46. * @see DrupalWebTestCase->results
  47. */
  48. function hook_test_finished($results) {
  49. }
  50. /**
  51. * @} End of "addtogroup hooks".
  52. */

Functions

Namesort descending Description
hook_simpletest_alter Alter the list of tests.
hook_test_finished An individual test has finished.
hook_test_group_finished A test group has finished.
hook_test_group_started A test group has started.