automattic/jetpack-constants

A wrapper for defining constants in a more testable way.

Maintainers

Details

github.com/Automattic/jetpack-constants

Source

Installs: 622 538

Dependents: 14

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 1

Type:jetpack-library

v1.6.14 2022-01-04 21:11 UTC

Requires (Dev)

GPL-2.0-or-later 93af2a61eceaabd16c432451cc33f7c9074efa81

This package is auto-updated.

Last update: 2022-01-18 20:48:05 UTC

README

A simple constant manager for Jetpack.

Testing constants is hard. Once you define a constant in PHP, it's defined. Constants Manager is an abstraction layer so that unit tests can set constants for tests.

Usage

Retrieve the value of a constant CONSTANT_NAME (returns null if it's not defined):

use Automattic\Jetpack\Constants;

$constant_value = Constants::get_constant( 'CONSTANT_NAME' );

Set the value of a constant CONSTANT_NAME to a particular value:

use Automattic\Jetpack\Constants;

$value = 'some value';
Constants::set_constant( 'CONSTANT_NAME', $value );

Check whether a constant CONSTANT_NAME is defined:

use Automattic\Jetpack\Constants;

$defined = Constants::is_defined( 'CONSTANT_NAME' );

Check whether a constant CONSTANT_NAME is truthy:

use Automattic\Jetpack\Constants;

$is_truthy = Constants::is_true( 'CONSTANT_NAME' );

Delete the CONSTANT_NAME constant:

use Automattic\Jetpack\Constants;

Constants::clear_single_constant( 'CONSTANT_NAME' );

Delete all known constants:

use Automattic\Jetpack\Constants;

Constants::clear_constants();