FeatureSet
in package
FeatureSet detects and exposes available features in the current environment
A feature set is used by UuidFactory to determine the available features and capabilities of the environment.
Table of Contents
- $builder : UuidBuilderInterface
- $calculator : CalculatorInterface
- $codec : CodecInterface
- $dceSecurityGenerator : DceSecurityGeneratorInterface
- $disable64Bit : bool
- $disableBigNumber : bool
- $enablePecl : bool
- $ignoreSystemNode : bool
- $nameGenerator : NameGeneratorInterface
- $nodeProvider : NodeProviderInterface
- $numberConverter : NumberConverterInterface
- $randomGenerator : RandomGeneratorInterface
- $timeConverter : TimeConverterInterface
- $timeGenerator : TimeGeneratorInterface
- $timeProvider : TimeProviderInterface
- $validator : ValidatorInterface
- __construct() : mixed
- getBuilder() : UuidBuilderInterface
- Returns the builder configured for this environment
- getCalculator() : CalculatorInterface
- Returns the calculator configured for this environment
- getCodec() : CodecInterface
- Returns the codec configured for this environment
- getDceSecurityGenerator() : DceSecurityGeneratorInterface
- Returns the DCE Security generator configured for this environment
- getNameGenerator() : NameGeneratorInterface
- Returns the name generator configured for this environment
- getNodeProvider() : NodeProviderInterface
- Returns the node provider configured for this environment
- getNumberConverter() : NumberConverterInterface
- Returns the number converter configured for this environment
- getRandomGenerator() : RandomGeneratorInterface
- Returns the random generator configured for this environment
- getTimeConverter() : TimeConverterInterface
- Returns the time converter configured for this environment
- getTimeGenerator() : TimeGeneratorInterface
- Returns the time generator configured for this environment
- getValidator() : ValidatorInterface
- Returns the validator configured for this environment
- setCalculator() : void
- Sets the calculator to use in this environment
- setDceSecurityProvider() : void
- Sets the DCE Security provider to use in this environment
- setNodeProvider() : void
- Sets the node provider to use in this environment
- setTimeProvider() : void
- Sets the time provider to use in this environment
- setValidator() : void
- Set the validator to use in this environment
- buildCodec() : CodecInterface
- Returns a codec configured for this environment
- buildDceSecurityGenerator() : DceSecurityGeneratorInterface
- Returns a DCE Security generator configured for this environment
- buildNameGenerator() : NameGeneratorInterface
- Returns a name generator configured for this environment
- buildNodeProvider() : NodeProviderInterface
- Returns a node provider configured for this environment
- buildNumberConverter() : NumberConverterInterface
- Returns a number converter configured for this environment
- buildRandomGenerator() : RandomGeneratorInterface
- Returns a random generator configured for this environment
- buildTimeConverter() : TimeConverterInterface
- Returns a time converter configured for this environment
- buildTimeGenerator() : TimeGeneratorInterface
- Returns a time generator configured for this environment
- buildUuidBuilder() : UuidBuilderInterface
- Returns a UUID builder configured for this environment
- is64BitSystem() : bool
- Returns true if the PHP build is 64-bit
Properties
$builder
private
UuidBuilderInterface
$builder
$calculator
private
CalculatorInterface
$calculator
$codec
private
CodecInterface
$codec
$dceSecurityGenerator
private
DceSecurityGeneratorInterface
$dceSecurityGenerator
$disable64Bit
private
bool
$disable64Bit
= false
$disableBigNumber
private
bool
$disableBigNumber
= false
$enablePecl
private
bool
$enablePecl
= false
$ignoreSystemNode
private
bool
$ignoreSystemNode
= false
$nameGenerator
private
NameGeneratorInterface
$nameGenerator
$nodeProvider
private
NodeProviderInterface
$nodeProvider
$numberConverter
private
NumberConverterInterface
$numberConverter
$randomGenerator
private
RandomGeneratorInterface
$randomGenerator
$timeConverter
private
TimeConverterInterface
$timeConverter
$timeGenerator
private
TimeGeneratorInterface
$timeGenerator
$timeProvider
private
TimeProviderInterface
$timeProvider
$validator
private
ValidatorInterface
$validator
Methods
__construct()
public
__construct([bool $useGuids = false ][, bool $force32Bit = false ][, bool $forceNoBigNumber = false ][, bool $ignoreSystemNode = false ][, bool $enablePecl = false ]) : mixed
Parameters
- $useGuids : bool = false
-
True build UUIDs using the GuidStringCodec
- $force32Bit : bool = false
-
True to force the use of 32-bit functionality (primarily for testing purposes)
- $forceNoBigNumber : bool = false
-
True to disable the use of moontoast/math (primarily for testing purposes)
- $ignoreSystemNode : bool = false
-
True to disable attempts to check for the system node ID (primarily for testing purposes)
- $enablePecl : bool = false
-
True to enable the use of the PeclUuidTimeGenerator to generate version 1 UUIDs
Return values
mixed —getBuilder()
Returns the builder configured for this environment
public
getBuilder() : UuidBuilderInterface
Return values
UuidBuilderInterface —getCalculator()
Returns the calculator configured for this environment
public
getCalculator() : CalculatorInterface
Return values
CalculatorInterface —getCodec()
Returns the codec configured for this environment
public
getCodec() : CodecInterface
Return values
CodecInterface —getDceSecurityGenerator()
Returns the DCE Security generator configured for this environment
public
getDceSecurityGenerator() : DceSecurityGeneratorInterface
Return values
DceSecurityGeneratorInterface —getNameGenerator()
Returns the name generator configured for this environment
public
getNameGenerator() : NameGeneratorInterface
Return values
NameGeneratorInterface —getNodeProvider()
Returns the node provider configured for this environment
public
getNodeProvider() : NodeProviderInterface
Return values
NodeProviderInterface —getNumberConverter()
Returns the number converter configured for this environment
public
getNumberConverter() : NumberConverterInterface
Return values
NumberConverterInterface —getRandomGenerator()
Returns the random generator configured for this environment
public
getRandomGenerator() : RandomGeneratorInterface
Return values
RandomGeneratorInterface —getTimeConverter()
Returns the time converter configured for this environment
public
getTimeConverter() : TimeConverterInterface
Return values
TimeConverterInterface —getTimeGenerator()
Returns the time generator configured for this environment
public
getTimeGenerator() : TimeGeneratorInterface
Return values
TimeGeneratorInterface —getValidator()
Returns the validator configured for this environment
public
getValidator() : ValidatorInterface
Return values
ValidatorInterface —setCalculator()
Sets the calculator to use in this environment
public
setCalculator(CalculatorInterface $calculator) : void
Parameters
- $calculator : CalculatorInterface
Return values
void —setDceSecurityProvider()
Sets the DCE Security provider to use in this environment
public
setDceSecurityProvider(DceSecurityProviderInterface $dceSecurityProvider) : void
Parameters
- $dceSecurityProvider : DceSecurityProviderInterface
Return values
void —setNodeProvider()
Sets the node provider to use in this environment
public
setNodeProvider(NodeProviderInterface $nodeProvider) : void
Parameters
- $nodeProvider : NodeProviderInterface
Return values
void —setTimeProvider()
Sets the time provider to use in this environment
public
setTimeProvider(TimeProviderInterface $timeProvider) : void
Parameters
- $timeProvider : TimeProviderInterface
Return values
void —setValidator()
Set the validator to use in this environment
public
setValidator(ValidatorInterface $validator) : void
Parameters
- $validator : ValidatorInterface
Return values
void —buildCodec()
Returns a codec configured for this environment
private
buildCodec([bool $useGuids = false ]) : CodecInterface
Parameters
- $useGuids : bool = false
-
Whether to build UUIDs using the GuidStringCodec
Return values
CodecInterface —buildDceSecurityGenerator()
Returns a DCE Security generator configured for this environment
private
buildDceSecurityGenerator(DceSecurityProviderInterface $dceSecurityProvider) : DceSecurityGeneratorInterface
Parameters
- $dceSecurityProvider : DceSecurityProviderInterface
Return values
DceSecurityGeneratorInterface —buildNameGenerator()
Returns a name generator configured for this environment
private
buildNameGenerator() : NameGeneratorInterface
Return values
NameGeneratorInterface —buildNodeProvider()
Returns a node provider configured for this environment
private
buildNodeProvider() : NodeProviderInterface
Return values
NodeProviderInterface —buildNumberConverter()
Returns a number converter configured for this environment
private
buildNumberConverter(CalculatorInterface $calculator) : NumberConverterInterface
Parameters
- $calculator : CalculatorInterface
Return values
NumberConverterInterface —buildRandomGenerator()
Returns a random generator configured for this environment
private
buildRandomGenerator() : RandomGeneratorInterface
Return values
RandomGeneratorInterface —buildTimeConverter()
Returns a time converter configured for this environment
private
buildTimeConverter(CalculatorInterface $calculator) : TimeConverterInterface
Parameters
- $calculator : CalculatorInterface
Return values
TimeConverterInterface —buildTimeGenerator()
Returns a time generator configured for this environment
private
buildTimeGenerator(TimeProviderInterface $timeProvider) : TimeGeneratorInterface
Parameters
- $timeProvider : TimeProviderInterface
-
The time provider to use with the time generator
Return values
TimeGeneratorInterface —buildUuidBuilder()
Returns a UUID builder configured for this environment
private
buildUuidBuilder([bool $useGuids = false ]) : UuidBuilderInterface
Parameters
- $useGuids : bool = false
-
Whether to build UUIDs using the GuidStringCodec
Return values
UuidBuilderInterface —is64BitSystem()
Returns true if the PHP build is 64-bit
private
is64BitSystem() : bool