mralaminahamed/dokan-stubs

Dokan Multivendor Marketplace function and class declaration stubs for static analysis.

v3.11.0 2024-05-14 08:47 UTC

Requires

• php-stubs/woocommerce-stubs: dev-master
• php-stubs/wordpress-stubs: ^5.3 || ^6.0

Requires (Dev)

• php: ~7.1 || ~8.0
• php-stubs/generator: ^0.8.0
• phpstan/phpstan: ^1.10

Suggests

• symfony/polyfill-php73: Symfony polyfill backporting some PHP 7.3+ features to lower PHP versions
• szepeviktor/phpstan-wordpress: WordPress extensions for PHPStan

MIT

• wordpress
• static analysis
• woocommerce
• PHPStan
• dokan

Published on Packagist.org on 2024-05-14 09:08 UTC

README

PHP stub declarations for the Dokan Multivendor Marketplace 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 Dokan plugin versions

📋 Requirements

• PHP >= 7.4
• Composer for dependency management

📦 Installation

Via Composer (Recommended)

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

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

Manual Installation

Download the stub files directly:

• dokan-stubs.php
• dokan-constants-stubs.php

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

// Access the main template class
$template = new Dokan_Template_Main();

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

For advanced usage examples, see the Usage Guide.

📁 Package Structure

phpstan-dokan-stubs/
├── configs/                           # Configuration files for stub generation
├── dokan-constants-stubs.php          # Constants stub file
├── dokan-stubs.php                    # Main stubs file with classes and functions
├── phpstan.neon                       # PHPStan configuration
├── source/                            # Source for generating stubs
└── tests/                             # Test files
    ├── bootstrap.php                  # Test bootstrap
    ├── ConstantsTest.php              # Constants tests
    └── DokanTest.php                  # Dokan 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
• Dokan Plugin Documentation
• PHPStan Documentation
• PHP Stubs Generator Documentation

📄 License

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

🙏 Acknowledgments

• Dokan Team for the Multivendor Marketplace 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.