README

Laravel package for communicating with the accessibility audit API.

Supported functions:

• Running a page audit (scan) – synchronously and asynchronously
• Retrieving the audit result by audit UUID (get)
• Retrieving audit history by address UUID (history)

Setup

composer require dockcodes/a11y-checker-laravel

Publish config:

php artisan vendor:publish --provider="Dock\A11yCheckerLaravel\DockServiceProvider" --tag="config"

Usage

Add to .env file:

A11Y_API_KEY=[CONTACT US FOR API KEY]

Code example:

<?php

// Run scan
$result = \A11yChecker::scan('https://example.com');
echo "Audit uuid: " . $result['uuid'] . "\n";
echo "Address uuid: " . $result['address_uuid'] . "\n";

// Get audit result
$report = \A11yChecker::audit($result['uuid']);
print_r($report);

// Get history
$history = \A11yChecker::history($result['address_uuid']);
print_r($history);

Method parameters

scan(string $url, Language $lang = Language::EN, Device $device = Device::DESKTOP, bool $sync = false, bool $extraData = false)

audit(string $uuid, Language $lang = Language::EN, bool $extraData = false)

history(string $uuid, int $page = 1, int $perPage = 10, Sort $sort = Sort::CREATED_AT_ASC)

To obtain an API key, please contact us via the contact form.