ffi / env
PHP FFI Environment
Installs: 47 241
Dependents: 7
Suggesters: 0
Security: 0
Stars: 4
Watchers: 1
Forks: 1
Open Issues: 0
Requires
- php: ^7.4|^8.0
Requires (Dev)
- jetbrains/phpstorm-attributes: ^1.0
- phpunit/phpunit: ^9.5
- squizlabs/php_codesniffer: ^3.7
- vimeo/psalm: ^5.4
This package is auto-updated.
Last update: 2024-11-14 16:43:18 UTC
README
A set of API methods for working with the FFI environment.
Requirements
- PHP >= 7.4
Installation
Library is available as composer repository and can be installed using the following command in a root of your project.
$ composer require ffi/env
Usage
Retrieve FFI Status
use FFI\Env\Runtime; $status = Runtime::getStatus();
Status can be be one of:
\FFI\Env\Status::NOT_AVAILABLE
- Extension not available.\FFI\Env\Status::DISABLED
- Extension disabled.\FFI\Env\Status::ENABLED
- Extension enabled and available in any environment.\FFI\Env\Status::CLI_ENABLED
- Extension available only in CLI SAPI or using a preload.
Checking Availability
use FFI\Env\Runtime; $isAvailable = Runtime::isAvailable();
In the case that the environment needs to be checked unambiguously, then you
can use assertAvailable()
method:
use FFI\Env\Runtime; Runtime::assertAvailable(); // Throws an \FFI\Env\Exception\EnvironmentException in case FFI is not available.
Optimization
To check the environment, it is recommended to use the assert
functionality.
use FFI\Env\Runtime; use FFI\Env\Exception\EnvironmentException; assert(Runtime::assertAvailable()); // Or using your own assertion error message: assert(Runtime::isAvailable(), EnvironmentException::getErrorMessageFromStatus());