Download the PHP package formpanel/formpanel-laravel without Composer

FormPanel Laravel

Laravel integration for the FormPanel PHP client library. This package provides a seamless way to submit forms to FormPanel API from your Laravel applications with configuration, facades, and artisan commands.

Requirements

• PHP 8.2 or higher
• Laravel 11.x or 12.x
• Composer

Installation

Install the package via Composer:

The service provider will be automatically registered via Laravel's package auto-discovery.

Configuration

Publish Configuration

Publish the configuration file:

This will create a config/formpanel.php file in your application.

Environment Variables

Add the following to your .env file:

Required:

• FORMPANEL_API_KEY - Your FormPanel API key

Optional:

• FORMPANEL_FORM_SLUG - Default form slug
• FORMPANEL_BASE_URL - Base URL (default: https://api.formpanel.io/api/v1)
• FORMPANEL_TIMEOUT - Request timeout in seconds (default: 30)
• FORMPANEL_MAX_RETRIES - Maximum retry attempts (default: 3)
• FORMPANEL_LOGGING - Enable debug logging (default: false)

Usage

Using the Facade

The package provides a convenient facade for accessing the FormPanel client:

Using a Specific Form

Create a client for a specific form using the form() method:

Using Dependency Injection

Inject the client into your controllers, jobs, or services:

Using the Factory for Multiple Forms

Use the factory to create clients for different forms:

Getting Form Information

Retrieve form details including field definitions:

Controller Example

Complete controller example with error handling:

Queue Integration

Submit forms asynchronously using Laravel queues:

Dispatch the job:

Artisan Commands

Test API Connection

Test your FormPanel API integration:

Output:

Error Handling

The package uses the same exception classes as the base PHP library:

Response Objects

SubmissionResult

Returned by submit():

Form

Returned by get():

FormField

Advanced Configuration

Custom Retry Configuration

Configure retry behavior in your .env:

Or in config/formpanel.php:

Logging

Enable request/response logging for debugging:

When enabled, the package will use Laravel's logging system with PSR-3 compatibility.

Testing

Mock in Tests

Use Laravel's service container to mock the client in tests:

Using Custom HTTP Client

For integration testing, you can inject a custom HTTP client:

Run Package Tests

Security

• Store API keys in .env file, never in code
• Use Laravel's validation before submitting to FormPanel
• Enable HTTPS in production
• The client includes automatic retry with exponential backoff for transient errors

Support

• GitHub: github.com/formpanel/formpanel-laravel
• Base Library: github.com/formpanel/formpanel-php
• Documentation: formpanel.com/docs
• Email: [email protected]

License

MIT License. See LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.