Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/widgetsburritos/webpagetest
PHP Library for Interacting with WebPageTest.org
https://github.com/widgetsburritos/webpagetest
php-library webpagetest
Last synced: about 1 month ago
JSON representation
PHP Library for Interacting with WebPageTest.org
- Host: GitHub
- URL: https://github.com/widgetsburritos/webpagetest
- Owner: WidgetsBurritos
- License: gpl-3.0
- Created: 2017-06-09T23:41:57.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-06-10T23:53:53.000Z (over 2 years ago)
- Last Synced: 2024-09-16T14:48:47.705Z (4 months ago)
- Topics: php-library, webpagetest
- Language: PHP
- Homepage:
- Size: 84 KB
- Stars: 11
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# webpagetest
[](https://travis-ci.org/WidgetsBurritos/webpagetest) [](https://packagist.org/packages/widgetsburritos/webpagetest) [](https://packagist.org/packages/widgetsburritos/webpagetest) [](https://packagist.org/packages/widgetsburritos/webpagetest)
A php library for interacting with webpagetest.org.
*Requires PHP 7.1+*
## Usage
### Instantiating a new instance
To obtain a key, see [Request API Key](http://www.webpagetest.org/getkey.php).
```php
```
^ Note: the switching protocol and payment required status checks are not a mistake. As of 10/25/2017, [webpagetest.org returns a "101 switching protocols" status for pending tests and a "402 Payment Required" status for cancelled tests.](https://github.com/WPO-Foundation/webpagetest/blob/7d5b9136f9e85e9905aa710d8b197d10356b5799/www/testStatus.inc#L315-L327)
### Running a URL test
```php
runTest('https://www.google.com')) {
if ($response->statusCode == StatusCode::OK) {
// All test info is available in $response->data.
$test_id = $response->data->testId;
}
}
?>
```
The library automatically populates the `k`, `f` and `url` query string parameters. Optionally, you can supply additional parameters by passing in array.
```php
'My Test Label',
'noimages' => 1,
'mobile' => 1,
];
if ($response = $wpt->runTest('https://www.google.com', $options)) {
if ($response->statusCode == StatusCode::OK) {
// All test info is available in $response->data.
$test_id = $response->data->testId;
}
}
?>
```
[See the Web Page Test API documentation](https://sites.google.com/a/webpagetest.org/docs/advanced-features/webpagetest-restful-apis#TOC-Parameters) for more information on supported parameters.
### Getting a test's status
```php
getTestStatus($test_id)) {
// All test info is available in $response->data.
if ($response->statusCode == StatusCode::OK) {
// Test is complete.
}
else if ($response->statusCode == StatusCode::CONTINUING) {
// Test is running.
}
else if ($response->startCode == StatusCode::SWITCHING_PROTOCOLS) {
// Test is waiting to start.
}
else if ($response->statusCode == StatusCode::PAYMENT_REQUIRED) {
// Test has been cancelled.
else {
// Test failed.
}
}
?>
```
### Getting a test's results
```php
getTestResults($test_id)) {
// All test result info is available in $response->data.
if ($response->statusCode == StatusCode::OK) {
// Test is complete.
}
else if (in_array($response->statusCode, [StatusCode::CONTINUING, StatusCode::SWITCHING_PROTOCOLS])) {
// Test is not yet complete.
}
else {
// Test failed.
}
}
?>
```
### Getting test locations
```php
getLocations()) {
if ($response->statusCode == StatusCode::OK) {
// All locations info is available in $response->data.
}
}
?>
```
### Cancelling a Test
You can cancel a test by simply running:
```php
cancelTest($test_id);
?>
```