Weave Code
Liberator Laravel Package
eloquent/liberator
Auto-generate RESTful CRUD controllers, routes, and API resources for Laravel apps from Eloquent models. Liberator helps you scaffold consistent endpoints quickly, reducing boilerplate while keeping generated code editable and aligned with your existing models and conventions.
A proxy for circumventing PHP access modifier restrictions.
Frequently asked questions about Liberator
- What is Laravel Liberator and how does it differ from Laravel’s built-in API resources?
- Liberator is a proxy-based package that auto-generates RESTful controllers and API resources from Eloquent models, bypassing PHP’s access modifiers. Unlike Laravel’s built-in API resources (which require explicit accessors/mutators), it dynamically exposes private/protected properties at runtime, reducing boilerplate but introducing runtime overhead and encapsulation risks.
- Can I use Liberator with Laravel 10 or PHP 8.2+?
- No, Liberator’s last release predates Laravel 9 and PHP 8.2, so it lacks support for modern features like enums, attributes, or model macros. Testing in Laravel 10+ is untested and likely to fail. Use accessors or spatie/laravel-model-generator instead for newer Laravel versions.
- How do I install and set up Liberator in a Laravel project?
- Install via Composer: `composer require eloquent/liberator`. Then wrap your Eloquent models with the proxy (e.g., `new Liberator($model)`) and generate controllers/routes via Liberator’s CLI or service provider. No Laravel service registration is required—it works as a standalone proxy layer.
- Does Liberator work with Laravel’s built-in API resources or traits?
- Liberator bypasses Laravel’s encapsulation layer, so it may conflict with traits or API resources that rely on explicit accessors. Use one or the other: Liberator for dynamic proxy access or Laravel’s native tools for controlled API exposure. Mixing them risks unpredictable behavior.
- What are the security risks of using Liberator in production?
- Liberator exposes internal model state at runtime, increasing risks like data injection or unintended side effects. Avoid it in high-security contexts (e.g., financial systems) or where private/protected members contain sensitive logic. Prefer accessors or API resources for explicit control.
- How does Liberator handle model events (e.g., `saving`, `deleting`)?
- Liberator proxies delegate events to the underlying model, so events like `saving` or `deleting` fire normally. However, proxy-generated methods may trigger unexpected event chains if they modify model state dynamically. Test thoroughly in staging before production.
- Is Liberator maintained, and what’s the upgrade path if Laravel/Eloquent changes?
- Liberator is abandoned with no Laravel 9+ or PHP 8.2+ support. If Eloquent introduces breaking changes (e.g., new model features), the proxy logic may fail. Plan to migrate to accessors or Laravel’s native tools if compatibility issues arise. No official upgrade path exists.
- Can I use Liberator for testing (e.g., mocking private methods)?
- Yes, Liberator’s proxy can dynamically expose private/protected methods for testing, replacing Reflection-based hacks. However, this is an anti-pattern in production—use it only for test doubles or legacy systems where modifying access modifiers is impractical.
- What alternatives should I consider instead of Liberator?
- For Laravel 9/10: Use Eloquent accessors (`$casts`, `$appends`), API resources, or packages like `spatie/laravel-model-generator`. For dynamic proxies: Evaluate `league/glide` or custom Reflection-based solutions. Liberator’s niche use case (bypassing access modifiers) is rarely needed in modern Laravel.
- How do I test Liberator-generated controllers in my CI pipeline?
- Test Liberator’s proxy logic with PHPUnit by mocking the underlying model and verifying generated methods. Check for side effects (e.g., event triggers, caching) and performance regressions in microbenchmarks. Since Liberator is unmaintained, prioritize unit tests to catch future breaking changes.
Weaver
How can I help you explore Laravel packages today?