From fb1cd7a944ded9eee80398d04bfc77f194f6704a Mon Sep 17 00:00:00 2001 From: Emir Beganovic Date: Mon, 5 Oct 2015 10:18:21 +0200 Subject: [PATCH] Cleanup: Update and add missing docblocks, remove unused imports Just a bit of house keeping for the sake of code cleanliness. --- src/Builder/DefaultUuidBuilder.php | 2 +- src/Builder/DegradedUuidBuilder.php | 2 +- src/Codec/GuidStringCodec.php | 1 - src/Codec/StringCodec.php | 2 ++ src/DegradedUuid.php | 2 -- src/FeatureSet.php | 1 + src/Provider/Time/FixedTimeProvider.php | 2 +- src/Uuid.php | 1 - src/UuidFactory.php | 2 -- src/UuidInterface.php | 2 +- 10 files changed, 7 insertions(+), 10 deletions(-) diff --git a/src/Builder/DefaultUuidBuilder.php b/src/Builder/DefaultUuidBuilder.php index 95c99dd..20656ac 100644 --- a/src/Builder/DefaultUuidBuilder.php +++ b/src/Builder/DefaultUuidBuilder.php @@ -32,7 +32,7 @@ class DefaultUuidBuilder implements UuidBuilderInterface /** * Constructs the DefaultUuidBuilder * - * @param NumberConverterInterface The number converter to use when constructing the Uuid + * @param NumberConverterInterface $converter The number converter to use when constructing the Uuid */ public function __construct(NumberConverterInterface $converter) { diff --git a/src/Builder/DegradedUuidBuilder.php b/src/Builder/DegradedUuidBuilder.php index 44183db..7edb6de 100644 --- a/src/Builder/DegradedUuidBuilder.php +++ b/src/Builder/DegradedUuidBuilder.php @@ -31,7 +31,7 @@ class DegradedUuidBuilder implements UuidBuilderInterface /** * Constructs the DegradedUuidBuilder * - * @param NumberConverterInterface The number converter to use when constructing the DegradedUuid + * @param NumberConverterInterface $converter The number converter to use when constructing the DegradedUuid */ public function __construct(NumberConverterInterface $converter) { diff --git a/src/Codec/GuidStringCodec.php b/src/Codec/GuidStringCodec.php index 4e3ddf0..380d94e 100644 --- a/src/Codec/GuidStringCodec.php +++ b/src/Codec/GuidStringCodec.php @@ -14,7 +14,6 @@ namespace Ramsey\Uuid\Codec; -use Ramsey\Uuid\Uuid; use Ramsey\Uuid\UuidInterface; /** diff --git a/src/Codec/StringCodec.php b/src/Codec/StringCodec.php index ae21de5..ea7b264 100644 --- a/src/Codec/StringCodec.php +++ b/src/Codec/StringCodec.php @@ -112,6 +112,7 @@ class StringCodec implements CodecInterface /** * Returns an array of UUID components (the UUID exploded on its dashes) * + * @param string $encodedUuid * @return array */ protected function extractComponents($encodedUuid) @@ -148,6 +149,7 @@ class StringCodec implements CodecInterface * Returns the fields that make up this UUID * * @see \Ramsey\Uuid\UuidInterface::getFieldsHex() + * @param array $components * @return array */ protected function getFields(array $components) diff --git a/src/DegradedUuid.php b/src/DegradedUuid.php index c4aecbe..b596c38 100644 --- a/src/DegradedUuid.php +++ b/src/DegradedUuid.php @@ -14,8 +14,6 @@ namespace Ramsey\Uuid; -use Ramsey\Uuid\Converter\NumberConverterInterface; -use Ramsey\Uuid\Codec\CodecInterface; use Ramsey\Uuid\Exception\UnsatisfiedDependencyException; use Ramsey\Uuid\Exception\UnsupportedOperationException; diff --git a/src/FeatureSet.php b/src/FeatureSet.php index 9f50c43..56a774e 100644 --- a/src/FeatureSet.php +++ b/src/FeatureSet.php @@ -263,6 +263,7 @@ class FeatureSet * Determines which time-based UUID generator to use and returns the configured * time-based UUID generator for this environment * + * @param TimeProviderInterface $timeProvider * @return TimeGeneratorInterface */ protected function buildTimeGenerator(TimeProviderInterface $timeProvider) diff --git a/src/Provider/Time/FixedTimeProvider.php b/src/Provider/Time/FixedTimeProvider.php index 1734de4..a62d39c 100644 --- a/src/Provider/Time/FixedTimeProvider.php +++ b/src/Provider/Time/FixedTimeProvider.php @@ -33,7 +33,7 @@ class FixedTimeProvider implements TimeProviderInterface * Constructs a `FixedTimeProvider` using the provided `$timestamp` * * @param int[] Array containing `sec` and `usec` components of a timestamp - * @throws InvalidArgumentException if the `$timestamp` does not contain `sec` or `usec` components + * @throws \InvalidArgumentException if the `$timestamp` does not contain `sec` or `usec` components */ public function __construct(array $timestamp) { diff --git a/src/Uuid.php b/src/Uuid.php index a79604c..ce981cc 100644 --- a/src/Uuid.php +++ b/src/Uuid.php @@ -14,7 +14,6 @@ namespace Ramsey\Uuid; -use InvalidArgumentException; use Ramsey\Uuid\Converter\NumberConverterInterface; use Ramsey\Uuid\Codec\CodecInterface; use Ramsey\Uuid\Exception\UnsupportedOperationException; diff --git a/src/UuidFactory.php b/src/UuidFactory.php index 859797d..57730c6 100644 --- a/src/UuidFactory.php +++ b/src/UuidFactory.php @@ -14,14 +14,12 @@ namespace Ramsey\Uuid; -use InvalidArgumentException; use Ramsey\Uuid\Converter\NumberConverterInterface; use Ramsey\Uuid\Provider\NodeProviderInterface; use Ramsey\Uuid\Generator\RandomGeneratorInterface; use Ramsey\Uuid\Generator\TimeGeneratorInterface; use Ramsey\Uuid\Codec\CodecInterface; use Ramsey\Uuid\Builder\UuidBuilderInterface; -use Ramsey\Uuid\UuidInterface; class UuidFactory implements UuidFactoryInterface { diff --git a/src/UuidInterface.php b/src/UuidInterface.php index edb0fcd..6d27ff4 100644 --- a/src/UuidInterface.php +++ b/src/UuidInterface.php @@ -15,7 +15,7 @@ namespace Ramsey\Uuid; use Ramsey\Uuid\Converter\NumberConverterInterface; - +use Ramsey\Uuid\Exception\UnsupportedOperationException; /** * UuidInterface defines common functionality for all universally unique * identifiers (UUIDs)