 |
VOOZH | about |
|
VOOZH | about |
This document covers the Tinker and Web Tinker components, which provide interactive REPL (Read-Eval-Print-Loop) interfaces for debugging and experimenting with Hyperf applications. Tinker offers a command-line shell powered by PsySH, while Web Tinker extends this functionality to a browser-based interface for remote debugging.
For information about other development tools, see IDE Helper and Code Generation. For testing infrastructure, see Testing Infrastructure.
The Tinker component integrates PsySH (PHP REPL) into Hyperf, providing an interactive shell for executing PHP code, inspecting objects, exploring the application state, and testing code snippets without creating temporary scripts. Web Tinker wraps this functionality in a web interface, enabling browser-based access to the same REPL capabilities.
Diagram: Tinker and Web Tinker Architecture
The REPL provides full access to the application's DI container, models, services, and helper functions, enabling interactive exploration and debugging of the running application.
Sources: composer.json1-331 src/tinker/composer.json1-56
The Tinker component registers a console command that launches an interactive PsySH shell within the Hyperf application context. This shell provides tab completion, history, syntax highlighting, and extensive introspection capabilities.
Diagram: Tinker Command-Line Architecture
Sources: src/tinker/composer.json26-35 composer.json295
The Tinker component relies on several key dependencies:
| Dependency | Version | Purpose |
|---|---|---|
psy/psysh | ^0.10.0 || ^0.11.0 || ^0.12.0 | Core REPL engine |
hyperf/command | ~3.1.0 | Command registration |
hyperf/di | ~3.1.0 | Dependency injection access |
hyperf/collection | ~3.1.0 | Collection helpers in REPL |
hyperf/stringable | ~3.1.0 | String manipulation |
hyperf/support | ~3.1.0 | Foundation utilities |
hyperf/tappable | ~3.1.0 | Fluent interface support |
Sources: src/tinker/composer.json26-35
The component uses Hyperf's ConfigProvider pattern for automatic registration:
Diagram: Tinker ConfigProvider Registration Flow
The ConfigProvider class exports a commands array that Hyperf automatically discovers and registers during application bootstrap. This enables the php bin/hyperf.php tinker command without manual configuration.
Sources: src/tinker/composer.json52-54 composer.json295
Tinker supports custom casters for displaying Hyperf-specific objects in a readable format within the REPL. These casters transform complex objects into formatted output.
Diagram: Custom Caster System
Casters are registered with PsySH during shell initialization, enabling intelligent display of Hyperf objects. For example, Eloquent models show their attributes and relations, while collections display their items in a structured format.
Sources: src/tinker/composer.json37-38
Common Tinker usage patterns include:
Interactive Model Queries:
Testing Helper Functions:
Exploring Collections:
Accessing Context:
Sources: src/tinker/composer.json26-35
Web Tinker provides an HTTP-based interface to the Tinker REPL, allowing developers to execute PHP code through a web browser. This is particularly useful for remote debugging or environments where console access is restricted.
Diagram: Web Tinker HTTP Request Flow
Sources: composer.json167 composer.json298
Web Tinker builds on top of the Tinker component and adds HTTP-specific functionality:
Diagram: Web Tinker Dependency Graph
The Web Tinker component reuses the core Tinker shell execution logic but wraps it in an HTTP controller, providing route registration and browser UI.
Sources: composer.json164 composer.json167 composer.json298
Web Tinker provides arbitrary code execution capabilities and should be protected in production environments:
Diagram: Web Tinker Security Flow
Best Practices:
| Security Control | Implementation | Purpose |
|---|---|---|
| Environment Check | Disable in production via config | Prevent exposure in prod |
| Authentication | Require login credentials | User verification |
| IP Whitelist | Restrict to specific IPs | Network-level access control |
| Rate Limiting | Throttle execution requests | Prevent abuse |
| CSRF Protection | Token validation | Prevent cross-site attacks |
| Input Sanitization | Validate code input | Basic injection prevention |
Sources: composer.json298
Web Tinker provides a browser-based code editor with syntax highlighting and output display:
Diagram: Web Tinker UI Components
The interface typically includes:
Sources: composer.json167 composer.json298
Install Tinker for command-line REPL:
Install Web Tinker for browser-based REPL:
Both components auto-register via their ConfigProvider classes.
Sources: composer.json164 composer.json167 composer.json295 composer.json298
Configuration options are managed through Hyperf's config system:
Diagram: Configuration Structure
Configuration files can be published using:
Sources: composer.json295 composer.json298
The components respect Hyperf's environment settings:
| Environment | Tinker CLI | Web Tinker |
|---|---|---|
dev | Enabled | Enabled |
testing | Enabled | Disabled (default) |
production | Enabled | Disabled (default) |
Web Tinker should be explicitly disabled in production environments or protected behind strong authentication.
Sources: composer.json298
Tinker integrates into the standard Hyperf development workflow:
Diagram: Tinker in Debug Workflow
Common debugging scenarios:
Sources: src/tinker/composer.json1-56
Tinker complements other development tools in the friendsofhyperf ecosystem:
Diagram: Tinker in Development Toolchain
For automated testing, see Testing Infrastructure. For IDE support, see IDE Helper and Code Generation. For request monitoring, see Telescope Debug Assistant.
Sources: composer.json295 composer.json298 README.md69-73
Custom casters enable readable display of complex Hyperf objects:
Diagram: Custom Casters for Hyperf Types
Casters transform internal object representations into developer-friendly output, making it easier to understand object state during interactive debugging.
Sources: src/tinker/composer.json37-38
The Tinker component integrates with hyperf/view-engine to support HtmlString objects:
Diagram: HtmlString Caster Integration
When hyperf/view-engine is installed, Tinker automatically registers casters for HtmlString objects, displaying them appropriately in the REPL.
Sources: src/tinker/composer.json37-38
| Feature | Tinker (CLI) | Web Tinker |
|---|---|---|
| Access Method | Command line | Web browser |
| Authentication | OS-level (terminal access) | HTTP auth required |
| Performance | Native PHP execution | HTTP overhead |
| History | Readline/PsySH history | Browser-based history |
| Syntax Highlighting | Terminal-based | JavaScript-based |
| Tab Completion | Full PsySH completion | Limited/none |
| Multi-line Input | Native support | JavaScript editor |
| Security Risk | Terminal access only | HTTP exposure |
| Remote Access | SSH required | Direct HTTP access |
| Production Use | Safe (if terminal secured) | Not recommended |
Comparison Table: Tinker CLI vs Web Tinker
Recommendations:
Sources: src/tinker/composer.json1-56 composer.json167
Issue: Tinker command not found
composer show friendsofhyperf/tinkerhyperf/command is installedIssue: Web Tinker returns 404
Issue: Code execution fails in Tinker
Issue: Web Tinker access denied
Sources: src/tinker/composer.json26-35
Tinker and Web Tinker integrate with other friendsofhyperf development tools:
Refresh this wiki