Skip to content

usage.md

Latest commit

 

History

History
60 lines (43 loc) · 1.57 KB

usage.md

File metadata and controls

60 lines (43 loc) · 1.57 KB

⬅️ to README.md

Usage

Description

function wcwidth(string $wc, ?string $version = null): int;
  • $wc - single character, if a string is passed, only first character will be used.
  • $version - Unicode version, see details below.
function wcswidth(string $wcs, ?string $version = null): int;
  • $wcs - string of characters
  • $version - Unicode version, see details below.

Unicode version

Note: When using ffi extension version value is ignored completely.

Unicode version can be set globally for all functions using UnicodeVersion::set() method or through UNICODE_VERSION environment variable automatically.

use AlecRabbit\WcWidth\UnicodeVersion;

UnicodeVersion::set('12.1.0');
UNICODE_VERSION=latest # or 15.0.0

Or you can pass $version argument to wcwidth() and wcswidth() functions.

Note: $version parameter is ignored if version is already set globally.

use function AlecRabbit\WcWidth\wcwidth;

echo wcwidth('a', '14.0.0'); // 1

To get current version use UnicodeVersion::get() method.

use AlecRabbit\WcWidth\UnicodeVersion;

echo UnicodeVersion::get(); // 14.0.0

In case you need to reset the current version to null for any specific reason, you can achieve this by utilizing the UnicodeVersion::reset() method.

use AlecRabbit\WcWidth\UnicodeVersion;

UnicodeVersion::reset();

The package recommends installing ext-mbstring, although it assumes that this extension is either already installed or that a suitable polyfill is being used.