README

PHP stub declarations for the Fluent Forms plugin to enhance IDE completion and static analysis capabilities. Generated using php-stubs/generator directly from the source code.

🚀 Features

Complete function, class, and interface declarations
Constant definitions for proper static analysis
IDE autocompletion support
PHPStan integration
Regular updates with latest Fluent Forms plugin versions

📋 Requirements

PHP >= 7.4
Composer for dependency management

📦 Installation

Via Composer (Recommended)

# Install as a development dependency
composer require --dev mralaminahamed/fluent-forms-stubs

# Or specify a version
composer require --dev mralaminahamed/fluent-forms-stubs:^2.0

Manual Installation

Download the stub files directly:

🔧 Basic Configuration

To use these stubs with PHPStan or your IDE, see our Usage Guide for detailed instructions.

🔍 Quick Usage Example

<?php
// Your code will now have full IDE support
$parser = new \FluentForm\App\Services\Form\FormDataParser();

// Parse submitted form data
$parsedData = $parser->parseFormData($formData, $form);

// Constants are properly defined
if (FLUENTFORM_VERSION) {
    // Your implementation
}

For advanced usage examples, see the Usage Guide.

📁 Package Structure

phpstan-fluent-forms-stubs/
├── bin/                                    # Scripts for generating and releasing stubs
├── configs/                                # Configuration files for stub generation
├── docs/                                   # Detailed documentation
│   ├── usage.md                            # Usage guide
│   └── contributing.md                     # Contribution guidelines
├── fluent-forms-constants-stubs.stub       # Constants stub file
├── fluent-forms-stubs.stub                 # Main stubs file with classes and functions
├── fluentform_versions.txt                 # Tracks supported Fluent Forms versions
├── phpstan.neon                            # PHPStan configuration
├── source/                                 # Source for generating stubs
└── tests/                                  # Test files
    ├── bootstrap.php                       # Test bootstrap
    ├── ConstantsTest.php                   # Constants tests
    └── FluentFormsTest.php                 # Fluent Forms tests

🛠 Development

For information on building stubs, running tests, and contributing to the project, please see our Contributing Guide.

📚 Documentation

For more detailed information, check out our documentation:

📄 License

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

🙏 Acknowledgments

WPManageNinja for the Fluent Forms plugin
php-stubs/generator for the stub generation tools
All contributors to this project

💬 Support

For bug reports and feature requests, please use the GitHub Issues.

For questions and discussions, please use the GitHub Discussions.

mralaminahamed / fluent-forms-stubs

Package info

Security

Statistics