Download the PHP package tusharkhan/chatbot without Composer

TusharKhan Chatbot Package

A framework-agnostic PHP chatbot package that works seamlessly with plain PHP, Laravel, or any custom PHP application. Build powerful chatbots with multi-platform support including Web, Telegram, and Slack.

Package details

• PHP: >=8.0
• License: MIT

Note: The downloads badge above is provided by Packagist/Shields.io and will display live download counts after the package is published on Packagist. If you prefer to show a static number, replace the badge with the value from Packagist.

🚀 Features

• Framework Agnostic: Works with any PHP framework or plain PHP
• Multi-Platform Support: Web, Telegram, and Slack drivers included
• Pattern Matching: Flexible message routing with parameters, wildcards, and regex
• Multi-turn Conversations: Stateful conversations with context management
• Storage Options: File-based or in-memory storage (easily extensible)
• Middleware Support: Add custom processing logic
• Fallback Handling: Graceful handling of unmatched messages
• Easy Setup: No complex configuration required
• Rich Messaging: Support for buttons, keyboards, attachments, and interactive components
• Modern Platform Features: Events API, slash commands, and interactive components
• Fully Tested: Comprehensive unit test coverage (79 tests, 202 assertions)

📦 Installation

Install via Composer:

🎯 Quick Start

Basic Web Chatbot

Telegram Bot

Slack Bot

🔧 Pattern Matching

The bot supports various pattern matching types:

Exact Match

Wildcards

Parameters

Multiple Patterns

Regular Expressions

Custom Functions

💬 Conversation Management

Handle multi-turn conversations with ease:

🔌 Middleware

Add custom processing logic:

🗄️ Storage Options

File Storage (Persistent)

Array Storage (In-Memory)

Custom Storage

Implement the StorageInterface for custom storage solutions:

🌐 Framework Integration

Laravel Integration

Plain PHP Integration

🧪 Testing

Run the test suite:

📖 Examples & Documentation

Working Examples

• examples/web_driver.php - Complete web chatbot with ordering system
• examples/telegram.php - Full Telegram bot with commands and conversations
• examples/slack.php - Slack bot with interactive components

Comprehensive Guides

• doc/web-driver-bot.md - WebDriver guide (plain PHP and Laravel)
• doc/telegram.md - Complete Telegram bot implementation guide
• doc/slack-bot-example.md - Slack bot setup and real-world examples

🔧 Advanced Usage

Custom Drivers

Create custom drivers by implementing DriverInterface:

Error Handling

📚 API Reference

Bot Class

• hears($pattern, $handler) - Add message handler
• fallback($handler) - Set fallback handler
• middleware($middleware) - Add middleware
• listen() - Process incoming messages
• say($message, $senderId) - Send message
• conversation() - Get current conversation
• driver() - Get driver instance
• storage() - Get storage instance

Context Class

• getMessage() - Get incoming message
• getSenderId() - Get sender ID
• getConversation() - Get conversation instance
• getDriver() - Get driver instance
• getParams() - Get extracted parameters
• getParam($key, $default) - Get specific parameter
• getData() - Get raw platform data

Conversation Class

• setState($state) - Set conversation state
• getState() - Get current state
• isInState($state) - Check if in specific state
• set($key, $value) - Set variable
• get($key, $default) - Get variable
• has($key) - Check if variable exists
• remove($key) - Remove variable
• clear() - Clear all data

🌐 Supported Platforms

Web Driver

• HTTP/AJAX requests
• Form submissions
• Session-based conversations
• JSON/HTML responses
• Laravel and plain PHP integration

Telegram API

• Bot Commands: /start, /help, custom commands
• Message Types: Text, photos, documents, stickers
• Keyboards: Inline and reply keyboards
• Webhook Support: Real-time message processing
• Rich Formatting: Markdown and HTML support

Slack API

• Events API: Real-time message events
• Slash Commands: Custom bot commands
• Interactive Components: Buttons, menus, and forms
• Rich Messaging: Block Kit for rich layouts
• Mentions & DMs: App mentions and direct messages
• Webhook Verification: Signature verification for security

🔒 Security Features

• Input Validation: Built-in message sanitization
• Webhook Verification: Signature verification for Slack
• Rate Limiting: Middleware support for rate limiting
• Error Handling: Comprehensive error logging
• Storage Security: Secure file-based storage

📊 Package Statistics

• Total Tests: 79 tests with 193 assertions
• Code Coverage: Comprehensive coverage of all core features
• PHP Version: Requires PHP 8.0+
• Dependencies: Modern, actively maintained packages
• Package Size: Lightweight with minimal dependencies

🤝 Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

📝 License

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

🙋‍♂️ Support

• Create an Issue for bug reports
• Email: [email protected]
• Documentation: See /doc folder for comprehensive guides

🌟 Acknowledgments

• Built with modern PHP 8.0+ features
• Uses established libraries for platform integrations
• Framework-agnostic design for maximum compatibility
• Community-driven development

Made with ❤️ by Tushar Khan Portfolio: tusharkhan.me