[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/ramsey/uuid/src/ -> UuidFactory.php (summary)

This file is part of the ramsey/uuid library

Copyright: Copyright (c) Ben Ramsey <[email protected]>
License: http://opensource.org/licenses/MIT MIT
File Size: 315 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

UuidFactory:: (22 methods):
  __construct()
  getCodec()
  setCodec()
  getNodeProvider()
  getRandomGenerator()
  getTimeGenerator()
  setTimeGenerator()
  getNumberConverter()
  setRandomGenerator()
  setNumberConverter()
  getUuidBuilder()
  setUuidBuilder()
  fromBytes()
  fromString()
  fromInteger()
  uuid1()
  uuid3()
  uuid4()
  uuid5()
  uuid()
  uuidFromNsAndName()
  uuidFromHashedName()


Class: UuidFactory  - X-Ref

__construct(FeatureSet $features = null)   X-Ref
Constructs a `UuidFactory` for creating `Ramsey\Uuid\UuidInterface` instances

param: FeatureSet $features A set of features for use when creating UUIDs

getCodec()   X-Ref
Returns the UUID coder-decoder used by this factory

return: CodecInterface

setCodec(CodecInterface $codec)   X-Ref
Sets the UUID coder-decoder used by this factory

param: CodecInterface $codec

getNodeProvider()   X-Ref
Returns the system node ID provider used by this factory

return: NodeProviderInterface

getRandomGenerator()   X-Ref
Returns the random UUID generator used by this factory

return: RandomGeneratorInterface

getTimeGenerator()   X-Ref
Returns the time-based UUID generator used by this factory

return: TimeGeneratorInterface

setTimeGenerator(TimeGeneratorInterface $generator)   X-Ref
Sets the time-based UUID generator this factory will use to generate version 1 UUIDs

param: TimeGeneratorInterface $generator

getNumberConverter()   X-Ref
Returns the number converter used by this factory

return: NumberConverterInterface

setRandomGenerator(RandomGeneratorInterface $generator)   X-Ref
Sets the random UUID generator this factory will use to generate version 4 UUIDs

param: RandomGeneratorInterface $generator

setNumberConverter(NumberConverterInterface $converter)   X-Ref
Sets the number converter this factory will use

param: NumberConverterInterface $converter

getUuidBuilder()   X-Ref
Returns the UUID builder this factory uses when creating `Uuid` instances

return: UuidBuilderInterface $builder

setUuidBuilder(UuidBuilderInterface $builder)   X-Ref
Sets the UUID builder this factory will use when creating `Uuid` instances

param: UuidBuilderInterface $builder

fromBytes($bytes)   X-Ref


fromString($uuid)   X-Ref


fromInteger($integer)   X-Ref


uuid1($node = null, $clockSeq = null)   X-Ref


uuid3($ns, $name)   X-Ref


uuid4()   X-Ref


uuid5($ns, $name)   X-Ref


uuid(array $fields)   X-Ref
Returns a `Uuid`

Uses the configured builder and codec and the provided array of hexadecimal
value UUID fields to construct a `Uuid` object.

param: array $fields An array of fields from which to construct a UUID;
return: UuidInterface

uuidFromNsAndName($ns, $name, $version, $hashFunction)   X-Ref
Returns a version 3 or 5 namespaced `Uuid`

param: string|UuidInterface $ns The UUID namespace to use
param: string $name The string to hash together with the namespace
param: int $version The version of UUID to create (3 or 5)
param: string $hashFunction The hash function to use when hashing together
return: UuidInterface

uuidFromHashedName($hash, $version)   X-Ref
Returns a `Uuid` created from `$hash` with the version field set to `$version`
and the variant field set for RFC 4122

param: string $hash The hash to use when creating the UUID
param: int $version The UUID version to set for this hash (1, 3, 4, or 5)
return: UuidInterface



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer