webpagetest

WebPageTest

Библиотека PHP для взаимодействия с WebPageTest.org.

Требуется PHP 7.1+

Использование

Создание нового экземпляра

Чтобы получить ключ, см. Ключ запроса API.

 <?php

use WidgetsBurritos  WebPageTest  WebPageTest ;

$ wpt = new WebPageTest ( ' YOUR_API_KEY ' );

Чтобы указать альтернативный обработчик соединения:

 <?php
use WidgetsBurritosWebPageTestWebPageTest;

$wpt = new WebPageTest('YOUR_API_KEY', $handler);

Чтобы указать альтернативный экземпляр хостинга:

 <?php
use WidgetsBurritosWebPageTestWebPageTest;

$wpt = new WebPageTest('YOUR_API_KEY', $handler, 'https://www.example.com');

Коды статуса

Рекомендуется использовать внешнюю библиотеку, такую ​​как чайник вместо кодов жесткой кодирования.

 <?php
use TeapotStatusCode;

# Examples:
StatusCode::CONTINUING;          // 100 (Test Started)
StatusCode::SWITCHING_PROTOCOLS; // 101 (Test Pending)
StatusCode::OK;                  // 200 (Test Complete)
StatusCode::BAD_REQUEST;         // 400 (Test Not Found)
StatusCode::UNAUTHORIZED;        // 401 (Test Request Not Found)
StatusCode::PAYMENT_REQUIRED;    // 402 (Test Cancelled)
?>

^ ПРИМЕЧАНИЕ. Протокол переключения и требуемые проверки статуса платежа не являются ошибкой. По состоянию на 25.10.2017 WebPageTest.org возвращает статус «101 переключения» для ожидающих испытаний и статус «402, требуемый» для отмененных тестов.

Запуск теста на URL

 <?php

if ( $ response = $ wpt -> runTest ( ' https://www.google.com ' )) {
  if ( $ response -> statusCode == StatusCode:: OK ) {
    // All test info is available in $response->data.
    $ test_id = $ response -> data -> testId ;
  }
}
?>

Библиотека автоматически заполняет параметры строки запроса k , f и url . При желании вы можете предоставить дополнительные параметры, проходя в массиве.

 <?php
$ options = [
  ' label ' => ' 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 ;
  }
}
?>

См. Документацию по API тестирования веб -страницы для получения дополнительной информации о поддерживаемых параметрах.

Получение статуса теста

 <?php
if ( $ response = $ wpt -> 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.
  }
}
?>

Получение результатов теста

 <?php
if ( $ response = $ wpt -> 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.
  }
}
?>

Получение тестовых мест

 <?php
if ( $ response = $ wpt -> getLocations ()) {
  if ( $ response -> statusCode == StatusCode:: OK ) {
    // All locations info is available in $response->data.
  }
}
?>

Отмена теста

Вы можете отменить тест, просто запустив:

 <?php
$ wpt -> cancelTest ( $ test_id );
?>