Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. GuidBuilder.php

class GuidBuilder

GuidBuilder builds instances of Guid

@psalm-immutable

Hierarchy

  • class \Ramsey\Uuid\Guid\GuidBuilder implements \Ramsey\Uuid\Builder\UuidBuilderInterface

Expanded class hierarchy of GuidBuilder

See also

Guid

2 files declare their use of GuidBuilder
BuilderCollection.php in vendor/ramsey/uuid/src/Builder/BuilderCollection.php
FeatureSet.php in vendor/ramsey/uuid/src/FeatureSet.php

File

vendor/ramsey/uuid/src/Guid/GuidBuilder.php, line 32

Namespace

Ramsey\Uuid\Guid
View source
class GuidBuilder implements UuidBuilderInterface {
    
    /**
     * @param NumberConverterInterface $numberConverter The number converter to
     *     use when constructing the Guid
     * @param TimeConverterInterface $timeConverter The time converter to use
     *     for converting timestamps extracted from a UUID to Unix timestamps
     */
    public function __construct(NumberConverterInterface $numberConverter, TimeConverterInterface $timeConverter) {
    }
    
    /**
     * Builds and returns a Guid
     *
     * @param CodecInterface $codec The codec to use for building this Guid instance
     * @param string $bytes The byte string from which to construct a UUID
     *
     * @return Guid The GuidBuilder returns an instance of Ramsey\Uuid\Guid\Guid
     *
     * @psalm-pure
     */
    public function build(CodecInterface $codec, string $bytes) : UuidInterface {
        try {
            return new Guid($this->buildFields($bytes), $this->numberConverter, $codec, $this->timeConverter);
        } catch (Throwable $e) {
            throw new UnableToBuildUuidException($e->getMessage(), (int) $e->getCode(), $e);
        }
    }
    
    /**
     * Proxy method to allow injecting a mock, for testing
     */
    protected function buildFields(string $bytes) : Fields {
        return new Fields($bytes);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
GuidBuilder::build public function Builds and returns a Guid Overrides UuidBuilderInterface::build
GuidBuilder::buildFields protected function Proxy method to allow injecting a mock, for testing
GuidBuilder::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal