Issue #2029033 by narragansett, EllaTheHarpy, deekayen: Fix spacing and section order in Simpletest docblocks.
Alex Pott
parent
4ac8645745
commit
5a66f5d152
|
|
@ -159,9 +159,9 @@ abstract class TestBase {
|
|||
/**
|
||||
* Whether to die in case any test assertion fails.
|
||||
*
|
||||
* @see run-tests.sh
|
||||
*
|
||||
* @var boolean
|
||||
*
|
||||
* @see run-tests.sh
|
||||
*/
|
||||
public $dieOnFail = FALSE;
|
||||
|
||||
|
|
@ -316,6 +316,7 @@ abstract class TestBase {
|
|||
*
|
||||
* @param $message_id
|
||||
* Message ID of the assertion to delete.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion was deleted, FALSE otherwise.
|
||||
*
|
||||
|
|
@ -384,6 +385,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -407,6 +409,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -428,6 +431,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -449,6 +453,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -472,6 +477,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -495,6 +501,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -518,6 +525,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -541,6 +549,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -594,6 +603,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE.
|
||||
*/
|
||||
|
|
@ -613,6 +623,7 @@ abstract class TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* FALSE.
|
||||
*/
|
||||
|
|
@ -634,6 +645,7 @@ abstract class TestBase {
|
|||
* this default.
|
||||
* @param $caller
|
||||
* The caller of the error.
|
||||
*
|
||||
* @return
|
||||
* FALSE.
|
||||
*/
|
||||
|
|
@ -976,13 +988,13 @@ abstract class TestBase {
|
|||
* the test process still contains an old kernel and service container with an
|
||||
* old module list.
|
||||
*
|
||||
* @see TestBase::prepareEnvironment()
|
||||
* @see TestBase::tearDown()
|
||||
*
|
||||
* @todo Fix http://drupal.org/node/1708692 so that module enable/disable
|
||||
* changes are immediately reflected in drupal_container(). Until then,
|
||||
* tests can invoke this workaround when requiring services from newly
|
||||
* enabled modules to be immediately available in the same request.
|
||||
*
|
||||
* @see TestBase::prepareEnvironment()
|
||||
* @see TestBase::tearDown()
|
||||
*/
|
||||
protected function rebuildContainer() {
|
||||
$this->kernel = new DrupalKernel('testing', drupal_classloader(), FALSE);
|
||||
|
|
@ -1087,6 +1099,7 @@ abstract class TestBase {
|
|||
* Handle errors during test runs.
|
||||
*
|
||||
* Because this is registered in set_error_handler(), it has to be public.
|
||||
*
|
||||
* @see set_error_handler
|
||||
*/
|
||||
public function errorHandler($severity, $message, $file = NULL, $line = NULL) {
|
||||
|
|
|
|||
|
|
@ -249,6 +249,7 @@ class SimpleTestTest extends WebTestBase {
|
|||
* @param string $status Assertion status.
|
||||
* @param string $file File where the assertion originated.
|
||||
* @param string $functuion Function where the assertion originated.
|
||||
*
|
||||
* @return Assertion result.
|
||||
*/
|
||||
function assertAssertion($message, $type, $status, $file, $function) {
|
||||
|
|
@ -315,6 +316,7 @@ class SimpleTestTest extends WebTestBase {
|
|||
*
|
||||
* @param $element
|
||||
* Element to extract text from.
|
||||
*
|
||||
* @return
|
||||
* Extracted text.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -390,6 +390,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* 'php', 'sql', 'text'.
|
||||
* @param $size
|
||||
* File size in bytes to match. Please check the tests/files folder.
|
||||
*
|
||||
* @return
|
||||
* List of files that match filter.
|
||||
*/
|
||||
|
|
@ -574,6 +575,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* Permissions to check.
|
||||
* @param $reset
|
||||
* Reset cached available permissions.
|
||||
*
|
||||
* @return
|
||||
* TRUE or FALSE depending on whether the permissions are valid.
|
||||
*/
|
||||
|
|
@ -1125,12 +1127,12 @@ abstract class WebTestBase extends TestBase {
|
|||
/**
|
||||
* Reads headers and registers errors received from the tested site.
|
||||
*
|
||||
* @see _drupal_log_error().
|
||||
*
|
||||
* @param $curlHandler
|
||||
* The cURL handler.
|
||||
* @param $header
|
||||
* An header.
|
||||
*
|
||||
* @see _drupal_log_error().
|
||||
*/
|
||||
protected function curlHeaderCallback($curlHandler, $header) {
|
||||
// Header fields can be extended over multiple lines by preceding each
|
||||
|
|
@ -1219,6 +1221,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* @param $headers
|
||||
* An array containing additional HTTP request headers, each formatted as
|
||||
* "name: value".
|
||||
*
|
||||
* @return
|
||||
* The retrieved HTML string, also available as $this->drupalGetContent()
|
||||
*/
|
||||
|
|
@ -1688,6 +1691,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* @param $headers
|
||||
* An array containing additional HTTP request headers, each formatted as
|
||||
* "name: value".
|
||||
*
|
||||
* @return
|
||||
* The retrieved headers, also available as $this->drupalGetContent()
|
||||
*/
|
||||
|
|
@ -1721,6 +1725,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* Form submit button value.
|
||||
* @param $form
|
||||
* Array of form elements.
|
||||
*
|
||||
* @return
|
||||
* Submit value matches a valid submit input in the form.
|
||||
*/
|
||||
|
|
@ -1881,6 +1886,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* An array of arguments with keys in the form ':name' matching the
|
||||
* placeholders in the query. The values may be either strings or numeric
|
||||
* values.
|
||||
*
|
||||
* @return
|
||||
* An XPath query with arguments replaced.
|
||||
*/
|
||||
|
|
@ -1920,6 +1926,7 @@ abstract class WebTestBase extends TestBase {
|
|||
*
|
||||
* @param $xpath
|
||||
* The xpath string to use in the search.
|
||||
*
|
||||
* @return
|
||||
* The return value of the xpath search. For details on the xpath string
|
||||
* format and return values see the SimpleXML documentation,
|
||||
|
|
@ -1944,6 +1951,7 @@ abstract class WebTestBase extends TestBase {
|
|||
*
|
||||
* @param $element
|
||||
* The element for which to get the options.
|
||||
*
|
||||
* @return
|
||||
* Option elements in select.
|
||||
*/
|
||||
|
|
@ -1981,6 +1989,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -2006,6 +2015,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE if the assertion succeeded, FALSE otherwise.
|
||||
*/
|
||||
|
|
@ -2076,6 +2086,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* Text between the anchor tags.
|
||||
* @param $index
|
||||
* Link position counting from zero.
|
||||
*
|
||||
* @return
|
||||
* Page on success, or FALSE on failure.
|
||||
*/
|
||||
|
|
@ -2100,6 +2111,7 @@ abstract class WebTestBase extends TestBase {
|
|||
*
|
||||
* @param $path
|
||||
* A path from the internal browser content.
|
||||
*
|
||||
* @return
|
||||
* The $path with $base_url prepended, if necessary.
|
||||
*/
|
||||
|
|
@ -2146,6 +2158,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* @param $all_requests
|
||||
* Boolean value specifying whether to return headers from all requests
|
||||
* instead of just the last request. Defaults to FALSE.
|
||||
*
|
||||
* @return
|
||||
* A name/value array if headers from only the last request are requested.
|
||||
* If headers from all requests are requested, an array of name/value
|
||||
|
|
@ -2200,6 +2213,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* @param $all_requests
|
||||
* Boolean value specifying whether to check all requests if the header is
|
||||
* not found in the last request. Defaults to FALSE.
|
||||
*
|
||||
* @return
|
||||
* The HTTP header value or FALSE if not found.
|
||||
*/
|
||||
|
|
@ -2245,6 +2259,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* @param $filter
|
||||
* An array containing key/value pairs used to filter the e-mails that are
|
||||
* returned.
|
||||
*
|
||||
* @return
|
||||
* An array containing e-mail messages captured during the current test.
|
||||
*/
|
||||
|
|
@ -2340,6 +2355,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2366,6 +2382,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2394,6 +2411,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2419,6 +2437,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2444,6 +2463,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* this default.
|
||||
* @param $not_exists
|
||||
* TRUE if this text should not exist, FALSE if it should.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2475,6 +2495,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2500,6 +2521,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2526,6 +2548,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* @param $be_unique
|
||||
* TRUE if this text should be found only once, FALSE if it should be found
|
||||
* more than once.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2559,6 +2582,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2583,6 +2607,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2607,6 +2632,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2635,6 +2661,7 @@ abstract class WebTestBase extends TestBase {
|
|||
* in test output. Use 'Debug' to indicate this is debugging output. Do not
|
||||
* translate this string. Defaults to 'Other'; most tests do not override
|
||||
* this default.
|
||||
*
|
||||
* @return
|
||||
* TRUE on pass, FALSE on fail.
|
||||
*/
|
||||
|
|
@ -2750,6 +2777,7 @@ abstract class WebTestBase extends TestBase {
|
|||
*
|
||||
* @param $element
|
||||
* SimpleXMLElement select element.
|
||||
*
|
||||
* @return
|
||||
* The selected value or FALSE.
|
||||
*/
|
||||
|
|
@ -3335,7 +3363,6 @@ abstract class WebTestBase extends TestBase {
|
|||
*
|
||||
* @param bool $clean_urls
|
||||
* Whether to mock the request using clean urls.
|
||||
*
|
||||
* @param $override_server_vars
|
||||
* An array of server variables to override.
|
||||
*
|
||||
|
|
|
|||
Loading…
Reference in New Issue