Download the PHP package tiao2/php-tools without Composer

PHP Tools - Modular Website Building Toolkit

A modular PHP library for building websites with SSO authentication, community features, API gateway and unified exception handling.

Features

• SSO Module: Token + AuthCode dual-factor session management with IP binding, support for MySQL/Redis storage.
• Community Module: User management, ACL permission control, post management, file upload, internal notifications, cache driver, logging, and CAPTCHA generation.
• API Gateway: Lightweight router, global middleware support (auth, rate limiting, versioning), unified JSON response and exception handling.
• Unified Exception Handling: Automatic detection of API/Web requests, returns structured JSON or debug HTML.
• Out of the box: PSR-4 autoloading, centralized configuration, minimal dependencies.

Requirements

• PHP >= 8.0
• Composer
• MySQL 5.7+ (or MariaDB 10.2+)
• Redis (optional, for distributed rate limiting and SSO storage)

Quick Start

1. Create project and install dependencies

Or clone the repository manually and run:

2. Configure environment variables

Copy .env.example to .env and adjust settings according to your environment:

Edit .env to set database connection, SSO expiration times, rate limiting parameters, etc. All modules are enabled by default and can be disabled via *_ENABLED variables.

3. Create database tables

Execute the following SQL to create the required tables (SSO sessions, users, posts, etc.):

4. Implement user authentication interface

The SSO module requires you to provide real user verification logic. Create a class that implements PhpTools\SSO\AuthenticatorInterface, for example:

Then pass an instance of it to SSO::fromEnv() in your entry file index.php.

5. Configure web server

Point your website root to public/ (if you use public/index.php) or directly to the project root's index.php. It is recommended to use public/ as the public directory for better security.

6. Access the application

Visit your domain. If everything is configured correctly, you will see the default API response (or routes you defined).

Directory Structure

Module Overview

SSO (Single Sign-On)

• Login: $sso->login($username, $password) returns token and authcode.
• Verification: $sso->verify($token, $authcode, $ip) returns user ID.
• Storage: Default MySQL, can be switched to Redis via .env.
• IP Binding: IPv4 exact match, IPv6 prefix match (default /64).

Community

All sub-modules extend CommunityBase and use SSO for authentication. Sub-module switches are controlled by COMMUNITY_*_ENABLED.

API Gateway

• Router: Supports GET/POST/PUT/DELETE, path parameters {id}.
• Middleware:
  • AuthMiddleware: Reads X-API-Token and X-API-AuthCode from headers for authentication.
  • RateLimitMiddleware: Supports in-memory or Redis rate limiting, returns 429 status with Retry-After header.
  • VersionMiddleware: Sets controller namespace prefix based on X-API-Version header.
• Exception Handling: Unified capture; API requests return JSON errors, HTML requests show a debug page (in development mode).

Configuration Reference (.env)

See .env.example for more configuration items

Usage Examples

1. Enable SSO Login

2. Create a Post (Community Content)

3. Register API Routes

Extending

• New storage driver: Implement StorageInterface, instantiate in SSO::fromEnv as needed.
• New rate limiter: Implement RateLimiterInterface, inject into RateLimitMiddleware.
• New middleware: Implement MiddlewareInterface, register via $router->addGlobalMiddleware().
• New Community sub-module: Extend CommunityBase, add dependencies in ModuleManager.

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.

Contact

For questions or suggestions, please open an issue or pull request.