PathUrlTest
extends CiviEndToEndTestCase
in package
uses
HttpTestTrait
Class PathUrlTest
Tags
Table of Contents
Properties
- $httpHistory : array<string|int, mixed>
- List of HTTP requests that have been made by this test.
Methods
- setUpBeforeClass() : void
- testGetUrl_WpAdmin() : void
- testPaths_getPath() : void
- `Civi::paths()->getPath()` should generate working paths.
- testPaths_getUrl() : void
- `Civi::paths()->getUrl()` should generate working URLs.
- testPaths_getVariable() : void
- `Civi::paths()->getVariable()` should generate working paths+URLs.
- testSystemRouter() : void
- `CRM_Utils_System::url()` should generate working URLs.
- testUrl() : void
- Get URLs through Civi::url().
- testUrl_DefaultUI() : void
- testUrl_FrontBackCurrent() : void
- Check that 'frontend://', 'backend://', and 'current://' have the expected relations.
- assertBodyRegexp() : mixed
- Assert that the response body matches a regular-expression.
- assertContentType() : $this
- assertNotBodyRegexp() : mixed
- Assert that the response body DOES NOT match a regular-expression.
- assertPageNotShown() : void
- Assert that the response did NOT produce a normal page-view.
- assertStatusCode() : $this
- callApi4AjaxError() : mixed
- callApi4AjaxSuccess() : mixed
- createGuzzle() : Client
- Create an HTTP client suitable for simulating AJAX requests.
- formatFailure() : false|string
- Given that an HTTP request has yielded a failed response, format a blurb to summarize the details of the request+response.
- resolveResponse() : ResponseInterface
- assertFileContentRegex() : mixed
- assertUrlContentRegex() : mixed
Properties
$httpHistory
List of HTTP requests that have been made by this test.
protected
array<string|int, mixed>
$httpHistory
= []
Methods
setUpBeforeClass()
public
static setUpBeforeClass() : void
testGetUrl_WpAdmin()
public
testGetUrl_WpAdmin() : void
Tags
testPaths_getPath()
`Civi::paths()->getPath()` should generate working paths.
public
testPaths_getPath() : void
testPaths_getUrl()
`Civi::paths()->getUrl()` should generate working URLs.
public
testPaths_getUrl() : void
testPaths_getVariable()
`Civi::paths()->getVariable()` should generate working paths+URLs.
public
testPaths_getVariable() : void
testSystemRouter()
`CRM_Utils_System::url()` should generate working URLs.
public
testSystemRouter() : void
testUrl()
Get URLs through Civi::url().
public
testUrl() : void
Tags
testUrl_DefaultUI()
public
testUrl_DefaultUI() : void
testUrl_FrontBackCurrent()
Check that 'frontend://', 'backend://', and 'current://' have the expected relations.
public
testUrl_FrontBackCurrent() : void
assertBodyRegexp()
Assert that the response body matches a regular-expression.
protected
assertBodyRegexp(string $regexp[, ResponseInterface $response = null ][, string $message = null ]) : mixed
Parameters
- $regexp : string
- $response : ResponseInterface = null
- $message : string = null
assertContentType()
protected
assertContentType(mixed $expectType[, ResponseInterface|null $response = null ]) : $this
Parameters
- $expectType : mixed
- $response : ResponseInterface|null = null
-
If NULL, then it uses the last response.
Return values
$thisassertNotBodyRegexp()
Assert that the response body DOES NOT match a regular-expression.
protected
assertNotBodyRegexp(string $regexp[, ResponseInterface $response = null ][, string $message = null ]) : mixed
Parameters
- $regexp : string
- $response : ResponseInterface = null
- $message : string = null
assertPageNotShown()
Assert that the response did NOT produce a normal page-view.
protected
assertPageNotShown([mixed $response = null ]) : void
This is basically assertStatusCode(404), except that the local configuration
(CMS/setings/exts/yaddayadda) may change how the error manifests.
Parameters
- $response : mixed = null
assertStatusCode()
protected
assertStatusCode(mixed $expectCode[, ResponseInterface|null $response = null ]) : $this
Parameters
- $expectCode : mixed
- $response : ResponseInterface|null = null
-
If NULL, then it uses the last response.
Return values
$thiscallApi4AjaxError()
protected
callApi4AjaxError(string $entity, string $action[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $entity : string
- $action : string
- $params : array<string|int, mixed> = []
callApi4AjaxSuccess()
protected
callApi4AjaxSuccess(string $entity, string $action[, array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $entity : string
- $action : string
- $params : array<string|int, mixed> = []
createGuzzle()
Create an HTTP client suitable for simulating AJAX requests.
protected
createGuzzle([array<string|int, mixed> $options = [] ]) : Client
The client may include some mix of these middlewares:
Parameters
- $options : array<string|int, mixed> = []
Tags
Return values
ClientformatFailure()
Given that an HTTP request has yielded a failed response, format a blurb to summarize the details of the request+response.
protected
formatFailure(ResponseInterface $response) : false|string
Parameters
- $response : ResponseInterface
Return values
false|stringresolveResponse()
protected
resolveResponse(ResponseInterface|null $response) : ResponseInterface
Parameters
- $response : ResponseInterface|null
Return values
ResponseInterfaceassertFileContentRegex()
private
assertFileContentRegex(string $expectContentRegex, string $file) : mixed
Parameters
- $expectContentRegex : string
- $file : string
assertUrlContentRegex()
private
assertUrlContentRegex(string $expectContentRegex, string $url) : mixed
Parameters
- $expectContentRegex : string
- $url : string