Download the PHP package scanlyser/php-sdk without Composer
On this page you can find all versions of the php package scanlyser/php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download scanlyser/php-sdk
More information about scanlyser/php-sdk
Files in scanlyser/php-sdk
Package php-sdk
Short Description PHP SDK for the ScanLyser API — accessibility, SEO, and security scanning.
License MIT
Homepage https://scanlyser.app
Informations about the package php-sdk
ScanLyser PHP SDK
Official PHP SDK for the ScanLyser API. Run accessibility, SEO, performance, UX, and security scans programmatically.
Requirements
- PHP 8.2+
- Guzzle 7.0+
Installation
Quick Start
API Reference
Client
Teams
Sites
Scans
Polling stops for completed, failed, and cancelled scans. A completed lifecycle does not by itself guarantee a score:
inspect assessmentOutcome, coverage, or use hasUsableScore() before presenting score data.
When a scan fails, failure contains only the stable code, customer-safe message, and support correlationId.
The optional categories argument is last in the trigger signature, preserving existing positional calls. Omitting it
requests all public categories. Category score members (wcag, seo, performance, ux, sitewide, and other)
are nullable: null means that bucket was not scored, never zero. Use requestedCategories, categoryCoverage,
scoredCategoryScope, and hasUsableCategoryScore() to distinguish assessed, partial, inconclusive, and not-scanned
categories. IssueCategory remains the separate six-value finding/report vocabulary and must not be used to select a
scan scope.
Pages
Detailed pages keep issues and diagnostics as separate collections. failure uses the same safe lifecycle-failure
object as scans; it never exposes raw exception text or a query-bearing page URL.
Issues
Every issue response is a readonly Finding (which extends the backwards-compatible Issue class) and carries a
required FindingResultEnvelope in $issue->result. Issue hydration rejects diagnostic envelopes instead of presenting
them as findings. Its nested data objects retain versioned check identity, explicitly nullable qualification, safe
reasoning and limitations, structured evidence, reproduction context, remediation parameters, and references.
Hydration rejects unsupported schema versions and invalid kind/outcome combinations. A null qualification property means the scanner explicitly declined to claim it; do not infer a value from the issue source.
Diagnostics
Diagnostic is a separate readonly resource with kind === ResultKind::Diagnostic, an inconclusive or error outcome,
string index, check and scope identity, non-null scope link, safe detail, optional recovery action, and support
correlation ID. The page argument selects the API page. Diagnostics never contribute to issue counts.
Reports
Webhook Verification
Verify webhook signatures from scan completion callbacks:
Error Handling
The SDK throws typed exceptions for API errors:
Rate-limited requests (429) are automatically retried up to 3 times with the Retry-After delay.
Laravel Integration
The SDK includes an optional service provider with auto-discovery.
Publish the config:
Configure .env:
Usage:
License
MIT