README

PHPUnit Attributes

👁 Coverage
👁 CGL
👁 Tests
👁 Supported PHP Versions

A Composer library with additional attributes to enhance testing with PHPUnit.

🔥 Installation

👁 Packagist
👁 Packagist Downloads

composer require --dev eliashaeussler/phpunit-attributes

⚡ Usage

The library ships with a ready-to-use PHPUnit extension. It must be registered in your PHPUnit configuration file:

 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
 bootstrap="vendor/autoload.php"
 >
+ <extensions>
+ <bootstrap class="EliasHaeussler\PHPUnitAttributes\PHPUnitAttributesExtension" />
+ </extensions>
 <testsuites>
 <testsuite name="unit">
 <directory>tests</directory>
 </testsuite>
 </testsuites>
 <source>
 <include>
 <directory>src</directory>
 </include>
 </source>
 </phpunit>

Some attributes can be configured with custom extension parameters. These must be added to the extension registration section like follows:

 <extensions>
- <bootstrap class="EliasHaeussler\PHPUnitAttributes\PHPUnitAttributesExtension" />
+ <bootstrap class="EliasHaeussler\PHPUnitAttributes\PHPUnitAttributesExtension">
+ <parameter name="fancyParameterName" value="fancyParameterValue" />
+ </bootstrap>
 </extensions>

🎢 Attributes

The following attributes are shipped with this library:

PHP class

• #[ForbidsClass]
• #[RequiresClass]

PHP constant

• #[ForbidsConstant]
• #[RequiresConstant]

Composer package

• #[ForbidsPackage]
• #[RequiresPackage]

Environment

• #[ForbidsEnv]
• #[RequiresEnv]

🧑‍💻 Contributing

Please have a look at CONTRIBUTING.md.

⭐ License

This project is licensed under GNU General Public License 3.0 (or later).