Documentation

FeatureSet
in package

FeatureSet detects and exposes available features in the current environment (32- or 64-bit, available dependencies, etc.)

Table of Contents

$builder  : UuidBuilderInterface
$codec  : CodecInterface
$disable64Bit  : bool
$disableBigNumber  : bool
$enablePecl  : bool
$ignoreSystemNode  : bool
$nodeProvider  : NodeProviderInterface
$numberConverter  : NumberConverterInterface
$randomGenerator  : RandomGeneratorInterface
$timeGenerator  : TimeGeneratorInterface
__construct()  : mixed
Constructs a `FeatureSet` for use by a `UuidFactory` to determine or set features available to the environment
getBuilder()  : UuidBuilderInterface
Returns the builder configured for this environment
getCodec()  : CodecInterface
Returns the UUID UUID coder-decoder configured for this environment
getNodeProvider()  : NodeProviderInterface
Returns the system node ID provider configured for this environment
getNumberConverter()  : NumberConverterInterface
Returns the number converter configured for this environment
getRandomGenerator()  : RandomGeneratorInterface
Returns the random UUID generator configured for this environment
getTimeGenerator()  : TimeGeneratorInterface
Returns the time-based UUID generator configured for this environment
setTimeProvider()  : mixed
Sets the time provider for use in this environment
buildCodec()  : CodecInterface
Determines which UUID coder-decoder to use and returns the configured codec for this environment
buildNodeProvider()  : NodeProviderInterface
Determines which system node ID provider to use and returns the configured system node ID provider for this environment
buildNumberConverter()  : NumberConverterInterface
Determines which number converter to use and returns the configured number converter for this environment
buildRandomGenerator()  : RandomGeneratorInterface
Determines which random UUID generator to use and returns the configured random UUID generator for this environment
buildTimeConverter()  : TimeConverterInterface
Determines which time converter to use and returns the configured time converter for this environment
buildTimeGenerator()  : TimeGeneratorInterface
Determines which time-based UUID generator to use and returns the configured time-based UUID generator for this environment
buildUuidBuilder()  : UuidBuilderInterface
Determines which UUID builder to use and returns the configured UUID builder for this environment
hasBigNumber()  : bool
Returns true if the system has `Moontoast\Math\BigNumber`
is64BitSystem()  : bool
Returns true if the system is 64-bit, false otherwise

Properties

$disable64Bit

private bool $disable64Bit = false

$disableBigNumber

private bool $disableBigNumber = false

$ignoreSystemNode

private bool $ignoreSystemNode = false

Methods

__construct()

Constructs a `FeatureSet` for use by a `UuidFactory` to determine or set features available to the environment

public __construct([bool $useGuids = false ][, bool $force32Bit = false ][, bool $forceNoBigNumber = false ][, bool $ignoreSystemNode = false ][, bool $enablePecl = false ]) : mixed
Parameters
$useGuids : bool = false

Whether to build UUIDs using the GuidStringCodec

$force32Bit : bool = false

Whether to force the use of 32-bit functionality (primarily for testing purposes)

$forceNoBigNumber : bool = false

Whether to disable the use of moontoast/math BigNumber (primarily for testing purposes)

$ignoreSystemNode : bool = false

Whether to disable attempts to check for the system host ID (primarily for testing purposes)

$enablePecl : bool = false

Whether to enable the use of the PeclUuidTimeGenerator to generate version 1 UUIDs

Return values
mixed —

buildCodec()

Determines which UUID coder-decoder to use and returns the configured codec for this environment

protected buildCodec([bool $useGuids = false ]) : CodecInterface
Parameters
$useGuids : bool = false

Whether to build UUIDs using the GuidStringCodec

Return values
CodecInterface —

hasBigNumber()

Returns true if the system has `Moontoast\Math\BigNumber`

protected hasBigNumber() : bool
Return values
bool —

is64BitSystem()

Returns true if the system is 64-bit, false otherwise

protected is64BitSystem() : bool
Return values
bool —

Search results