README

PHP stub declarations for the Ninja 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 Ninja Forms plugin versions

📋 Requirements

• PHP >= 7.4
• Composer for dependency management

📦 Installation

Via Composer (Recommended)

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

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

Manual Installation

Download the stub files directly:

• ninja-forms-stubs.stub
• ninja-forms-constants-stubs.stub

🔧 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
$ninja_forms = Ninja_Forms();

// Access forms via the main class
$form = Ninja_Forms()->form($formId)->get();

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

For advanced usage examples, see the Usage Guide.

📁 Package Structure

phpstan-ninja-forms-stubs/
├── configs/                               # Configuration files for stub generation
├── ninja-forms-constants-stubs.stub       # Constants stub file
├── ninja-forms-stubs.stub                 # Main stubs file with classes and functions
├── ninja_forms_versions.txt               # Tracks supported Ninja Forms versions
├── phpstan.neon                           # PHPStan configuration
├── source/                                # Source for generating stubs
└── tests/                                 # Test files
    ├── bootstrap.php                      # Test bootstrap
    ├── ConstantsTest.php                  # Constants tests
    └── NinjaFormsTest.php                 # Ninja 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:

• Usage Guide
• Contributing Guide
• Ninja Forms Documentation
• PHPStan Documentation
• PHP Stubs Generator Documentation

📄 License

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

🙏 Acknowledgments

• Saturday Drive for the Ninja 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.