Download the PHP package martincamen/sonarr-php without Composer
On this page you can find all versions of the php package martincamen/sonarr-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download martincamen/sonarr-php
More information about martincamen/sonarr-php
Files in martincamen/sonarr-php
Package sonarr-php
Short Description PHP SDK for Sonarr REST API v3
License MIT
Homepage https://github.com/martincamen/sonarr-php
Informations about the package sonarr-php
Sonarr PHP SDK
A PHP SDK for the Sonarr REST API v3.
[!IMPORTANT] This project is still being developed and breaking changes might occur even between patch versions.
The aim is to follow semantic versioning as soon as possible.
Ecosystem
| Package | Description |
|---|---|
| radarr-php | PHP SDK for Radarr |
| sonarr-php | PHP SDK for Sonarr |
| jellyseerr-php | PHP SDK for Jellyseerr |
| laravel-radarr | Laravel integration for Radarr |
| laravel-sonarr | Laravel integration for Sonarr |
| laravel-jellyseerr | Laravel integration for Jellyseerr |
Requirements
- PHP 8.3+
Installation
Quick Start
Laravel Integration
For Laravel integration, use the laravel-sonarr package which provides facades, service provider, and configuration management.
Usage
Downloads (Queue)
Get active downloads using the downloads() action:
Series
System
Episodes
Access episode information and management:
Episode Files
Access episode file information:
Calendar
Access upcoming episode releases:
History
Access download history:
Wanted (Missing & Cutoff)
Access missing episodes and quality cutoff:
Commands
Execute Sonarr commands:
Advanced: Raw API Access
For operations not yet exposed through the SDK, use the api() method to access the low-level API client:
Request Options
The SDK provides typed request option classes:
Pagination Options
Sort Options
Error Handling
The SDK throws specific exceptions for different error types:
Testing
The SDK provides testing utilities for easy mocking:
Using Factories
Architecture
The SDK follows a layered architecture:
Sonarr: The public entry point returning action classes- Action Classes: Type-safe methods for each domain (
series()->all(),downloads()->find(1)) - Endpoint Classes: Low-level API calls using Sonarr's native terminology
- Response Types: Typed DTOs from the SDK (
Series,DownloadPage, etc.)
License
The MIT License (MIT). Please see License File for more information.