wikimedia/scoped-callback

Make a callback run when a dummy object leaves the scope.

v5.0.0 2024-10-29 19:36 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

• Aaron Schulz

README

ScopedCallback

The ScopedCallback class allows for running a function after the instance goes out of scope. It can be useful for making sure teardown or cleanup functions run even if exceptions are thrown. It also makes for a cleaner API for developers, by not requiring the callback to be called manually each time.

Additional documentation about the library can be found on MediaWiki.org.

Usage

use Wikimedia\ScopedCallback;
$sc = new ScopedCallback( [ $this, 'teardown' ] );
// Even if this throws an exception, the callback will run
// or it'll run at the end of the function
$this->fooBar();
// If you want to manually call the callback
ScopedCallback::consume( $sc );
// or
unset( $sc );
// If you want to prevent it from being called
ScopedCallback::cancel( $sc );

Running tests

composer install --prefer-dist
composer test