mralaminahamed/dokan-stubs

dokan 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

README

This package provides stub declarations for the dokan plugin functions, classes and interfaces. These stubs can help plugin and theme developers leverage IDE completion and static analysis tools like PHPStan.

The stubs are generated directly from the source using php-stubs/generator.

Requirements

• PHP >=7.1

Installation

Require this package as a development dependency with Composer.

composer require --dev mralaminahamed/dokan-stubs

Alternatively you may download dokan-stubs.php directly.

Usage in PHPStan

Include stubs in PHPStan configuration file.

parameters:
    bootstrapFiles:
        - vendor/mralaminahamed/dokan-stubs/dokan-constants-stubs.php
        - vendor/mralaminahamed/dokan-stubs/dokan-stubs.php