cms/drupal/modules/simpletest/simpletest.api.php
changeset 541 e756a8c72c3d
equal deleted inserted replaced
540:07239de796bb 541:e756a8c72c3d
       
     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  * @param $groups
       
    17  *   A two dimension array, the first key is the test group (as defined in
       
    18  *   getInfo) the second is the name of the class and the value is the return
       
    19  *   value of the getInfo method.
       
    20  */
       
    21 function hook_simpletest_alter(&$groups) {
       
    22   // An alternative session handler module would not want to run the original
       
    23   // Session HTTPS handling test because it checks the sessions table in the
       
    24   // database.
       
    25   unset($groups['Session']['testHttpsSession']);
       
    26 }
       
    27 
       
    28 /**
       
    29  * A test group has started.
       
    30  *
       
    31  * This hook is called just once at the beginning of a test group.
       
    32  */
       
    33 function hook_test_group_started() {
       
    34 }
       
    35 
       
    36 /**
       
    37  * A test group has finished.
       
    38  *
       
    39  * This hook is called just once at the end of a test group.
       
    40  */
       
    41 function hook_test_group_finished() {
       
    42 }
       
    43 
       
    44 /**
       
    45  * An individual test has finished.
       
    46  *
       
    47  * This hook is called when an individual test has finished.
       
    48  *
       
    49  * @param
       
    50  *   $results The results of the test as gathered by DrupalWebTestCase.
       
    51  *
       
    52  * @see DrupalWebTestCase->results
       
    53  */
       
    54 function hook_test_finished($results) {
       
    55 }
       
    56 
       
    57 
       
    58 /**
       
    59  * @} End of "addtogroup hooks".
       
    60  */