Download the PHP package alirezax5/threex-ui-php without Composer
On this page you can find all versions of the php package alirezax5/threex-ui-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Please rate this library. Is it a good library?
Informations about the package threex-ui-php
3X-UI PHP Client
Language: فارسی
A modern, modular, and optimized PHP 8.1+ client for the 3X-UI Panel REST API — programmatically manage Xray/V2Ray inbounds, clients, nodes, server settings, and subscriptions.
Features
- Full API Coverage — ~96 endpoints across 9 functional groups
- Dual Authentication — API token (Bearer) or session-based login
- Modular Architecture — Each API group is a separate, testable class
- Type-Safe — PHP 8.1+ with strict types, readonly properties, and full type-hinting
- PSR-4 — Composer autoloading with clean namespace structure
- Zero Dependencies — Uses native
ext-curlandext-jsononly - Helper Functions — Global convenience functions for common tasks
- Comprehensive Error Handling — Custom exceptions for auth, API, connection, and validation errors
- Validator — Built-in input validation for emails, UUIDs, ports, protocols
- Formatter — Bytes/Gigabytes conversion, timestamps, and sanitization
Requirements
| Dependency | Version |
|---|---|
| PHP | >= 8.1 |
| ext-curl | * (required) |
| ext-json | * (required) |
| ext-mbstring | * (required) |
Installation
Or clone directly:
Quick Start
Authentication via API Token (Recommended)
Authentication via Session Login
Usage Overview
| API Group | Access Method | Description |
|---|---|---|
| Inbounds | $panel->inbounds() |
CRUD inbound connections |
| Clients | $panel->clients() |
User/client management + bulk ops |
| Client Groups | $panel->clientGroups() |
Group clients together |
| Server | $panel->server() |
System status, Xray control, logs |
| Nodes | $panel->nodes() |
Multi-node cluster management |
| Settings | $panel->settings() |
Panel settings + API token mgmt |
| Xray Config | $panel->xrayConfig() |
Xray core configuration |
| Custom Geo | $panel->customGeo() |
Custom geoip/geosite sources |
| Subscriptions | $panel->subscriptions() |
Subscription links + Telegram backup |
Examples
Helper Functions
Project Structure
Error Handling
License
MIT License. See LICENSE for details.
Related
- 3X-UI Panel — The Xray panel this client connects to
- API Documentation — Official Postman docs
All versions of threex-ui-php with dependencies
PHP Build Version
Package Version
Requires
php Version
>=8.1
ext-curl Version *
ext-json Version *
ext-mbstring Version *
ext-curl Version *
ext-json Version *
ext-mbstring Version *
The package alirezax5/threex-ui-php contains the following files
Loading the files please wait ...