mediawiki/at-ease

This package is abandoned and no longer maintained. The author suggests using the wikimedia/at-ease package instead.

Safe replacement to @ for suppressing warnings.

v3.0.0 2024-10-15 12:55 UTC

Requires

• php: >=7.4

Requires (Dev)

• mediawiki/mediawiki-codesniffer: 44.0.0
• mediawiki/mediawiki-phan-config: 0.14.0
• mediawiki/minus-x: 1.1.3
• ockcyp/covers-validator: 1.6.0
• php-parallel-lint/php-console-highlighter: 1.0.0
• php-parallel-lint/php-parallel-lint: 1.4.0
• phpunit/phpunit: 9.6.16

GPL-2.0-or-later

• Tim Starling
• MediaWiki developers

README

at-ease

at-ease is a PHP library that provides a safe alternative to PHP's @ error control operator.

@ is broken when E_STRICT is enabled and it causes an unlogged, unexplained error if there is a fatal, which is hard to support. The proper method of handling errors is to actually handle the errors. For example, if you are thinking of using an error suppression operator to suppress an invalid array index warning, you should instead perform an isset() check on the array index before trying to access it. When possible, always prevent PHP errors rather than catching and handling them afterward. It makes the code more understandable and avoids dealing with slow error suppression methods.

However, there are some cases where warnings are inevitable, even if you check beforehand, like when accessing files. You can check that the file exists by using file_exists() and is_readable(), but the file could have been deleted by the time you go to read it. In that case, you can use this library to suppress the warnings and prevent PHP from being noisy.

Usage

use Wikimedia\AtEase\AtEase;

// Suppress warnings in a block of code:
AtEase::suppressWarnings();
$content = file_get_contents( 'foobar.txt' );
AtEase::restoreWarnings();


// ..or in a callback function:
AtEase::quietCall( 'file_get_contents', 'foobar.txt' );

Running tests

composer install --prefer-dist
composer test

History

This library was first introduced in MediaWiki 1.3 (r4261). It was split out of the MediaWiki codebase and published as an independent library during the MediaWiki 1.26 development cycle.