Changeset 47122 for trunk/tests/phpunit/tests/http/http.php

Timestamp:

01/29/2020 12:43:23 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:

• trunk/tests/phpunit/tests/http/http.php (modified) (8 diffs)

trunk/tests/phpunit/tests/http/http.php

@@ -18 +18 @@
 
     function make_absolute_url_testcases() {
-        // 0: The Location header, 1: The current url, 3: The expected url
-        return array(
-            array( 'http://site.com/', 'http://example.com/', 'http://site.com/' ), // Absolute URL provided
-            array( '/location', '', '/location' ), // No current url provided
-
-            array( '', 'http://example.com', 'http://example.com/' ), // No location provided
-
-            // Location provided relative to site root
+        // 0: The Location header, 1: The current URL, 3: The expected URL.
+        return array(
+            // Absolute URL provided.
+            array( 'http://site.com/', 'http://example.com/', 'http://site.com/' ),
+            // No current URL provided.
+            array( '/location', '', '/location' ),
+
+            // No location provided.
+            array( '', 'http://example.com', 'http://example.com/' ),
+
+            // Location provided relative to site root.
             array( '/root-relative-link.ext', 'http://example.com/', 'http://example.com/root-relative-link.ext' ),
             array( '/root-relative-link.ext?with=query', 'http://example.com/index.ext?query', 'http://example.com/root-relative-link.ext?with=query' ),
 
-            // Location provided relative to current file/directory
+            // Location provided relative to current file/directory.
             array( 'relative-file.ext', 'http://example.com/', 'http://example.com/relative-file.ext' ),
             array( 'relative-file.ext', 'http://example.com/filename', 'http://example.com/relative-file.ext' ),
             array( 'relative-file.ext', 'http://example.com/directory/', 'http://example.com/directory/relative-file.ext' ),
 
-            // Location provided relative to current file/directory but in a parent directory
+            // Location provided relative to current file/directory but in a parent directory.
             array( '../file-in-parent.ext', 'http://example.com', 'http://example.com/file-in-parent.ext' ),
             array( '../file-in-parent.ext', 'http://example.com/filename', 'http://example.com/file-in-parent.ext' ),
@@ -40 +43 @@
             array( '../file-in-parent.ext', 'http://example.com/directory/filename', 'http://example.com/file-in-parent.ext' ),
 
-            // Location provided in muliple levels higher, including impossible to reach (../ below DOCROOT)
+            // Location provided in muliple levels higher, including impossible to reach (../ below DOCROOT).
             array( '../../file-in-grand-parent.ext', 'http://example.com', 'http://example.com/file-in-grand-parent.ext' ),
             array( '../../file-in-grand-parent.ext', 'http://example.com/filename', 'http://example.com/file-in-grand-parent.ext' ),
@@ -53 +56 @@
             array( 'otherfile.ext?query=string', 'http://example.com/file.ext?existing=query-string', 'http://example.com/otherfile.ext?query=string' ),
 
-            // A file with a leading dot
+            // A file with a leading dot.
             array( '.ext', 'http://example.com/', 'http://example.com/.ext' ),
 
-            // URls within URLs
+            // URLs within URLs.
             array( '/expected', 'http://example.com/sub/http://site.com/sub/', 'http://example.com/expected' ),
             array( '/expected/http://site.com/sub/', 'http://example.com/', 'http://example.com/expected/http://site.com/sub/' ),
 
-            // Schemeless URL's (Not valid in HTTP Headers, but may be used elsewhere)
+            // Schemeless URL's (not valid in HTTP Headers, but may be used elsewhere).
             array( '//example.com/sub/', 'https://example.net', 'https://example.com/sub/' ),
         );
@@ -74 +77 @@
 
     function parse_url_testcases() {
-        // 0: The URL, 1: The expected resulting structure
+        // 0: The URL, 1: The expected resulting structure.
         return array(
             array(
@@ -98 +101 @@
             ),
 
-            // < PHP 5.4.7: Schemeless URL
+            // < PHP 5.4.7: Schemeless URL.
             array(
                 '//example.com/path/',
@@ -142 +145 @@
             ),
 
-            // PHP's parse_url() calls this an invalid url, we handle it as a path
+            // PHP's parse_url() calls this an invalid url, we handle it as a path.
             array( '/://example.com/', array( 'path' => '/://example.com/' ) ),
 
@@ -244 +247 @@
             array( '//fonts.googleapis.com/css?family=Open+Sans:400&subset=latin', PHP_URL_PATH, '/css' ),
             array( '//fonts.googleapis.com/css?family=Open+Sans:400&subset=latin', PHP_URL_QUERY, 'family=Open+Sans:400&subset=latin' ),
-            array( '//fonts.googleapis.com/css?family=Open+Sans:400', PHP_URL_HOST, 'fonts.googleapis.com' ), // 25
+            array( '//fonts.googleapis.com/css?family=Open+Sans:400', PHP_URL_HOST, 'fonts.googleapis.com' ),  // 25
             array( '//fonts.googleapis.com/css?family=Open+Sans:400', PHP_URL_PORT, null ),
-            array( '//fonts.googleapis.com/css?family=Open+Sans:400', PHP_URL_PATH, '/css' ), //27
-            array( '//fonts.googleapis.com/css?family=Open+Sans:400', PHP_URL_QUERY, 'family=Open+Sans:400' ), //28
+            array( '//fonts.googleapis.com/css?family=Open+Sans:400', PHP_URL_PATH, '/css' ),                  // 27
+            array( '//fonts.googleapis.com/css?family=Open+Sans:400', PHP_URL_QUERY, 'family=Open+Sans:400' ), // 28
 
             // Empty string or non-string passed in.
@@ -340 +343 @@
             array( 'http://example.com/', PHP_URL_HOST, 'example.com' ),
             array( 'http://example.com/', PHP_URL_USER, null ),
-            array( 'http:///example.com', -1, false ), // Malformed.
+            array( 'http:///example.com', -1, false ),          // Malformed.
             array( 'http:///example.com', PHP_URL_HOST, null ), // Malformed.
         );